> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# docker-compose.yml から Toolkit への移行

> Overleaf の Docker Compose デプロイを Toolkit に移行します。

現在 `docker-compose.yml` ファイルを使って Docker Compose を利用している場合、Toolkit に移行すると、オンプレミス版 Overleaf のデプロイ、アップグレード、保守が容易になります。

移行するには、既存の Docker Compose のセットアップを Toolkit で使用される形式に変換する必要があります。このプロセスでは、既存の設定を Toolkit にコピーします。

このガイドでは、Docker Compose から Toolkit へスムーズに移行できるよう、プロセスの各ステップを順を追って説明します。

<Info>
  この手順は v4.x 以前を対象としています。そのため、すべての変数で `OVERLEAF_` ではなく `SHARELATEX_` プレフィックスを使用しています。
</Info>

<Steps>
  <Step title="Toolkit リポジトリをクローンする">
    まず、Toolkit リポジトリをホストマシンにクローンします:

    ```bash theme={null}
    git clone https://github.com/overleaf/toolkit.git ./overleaf-toolkit
    ```

    次に、`bin/init` コマンドを実行して、デフォルトの設定で Toolkit を初期化します。
  </Step>

  <Step title="イメージとバージョンを設定する">
    一般的な `docker-compose.yml` では、イメージとバージョンはコンポーネントの記述内で定義されています。例:

    ```yaml theme={null}
    version: '2.2'
    services:
        sharelatex:
            restart: always
            # Server Pro users:
            # image: quay.io/sharelatex/sharelatex-pro
            image: sharelatex/sharelatex:3.5.13
    ```

    Toolkit を使用する場合、イメージ名は自動的に解決されます。必要なのは、**config/overleaf.rc** で Server Pro のイメージを選ぶなら `SERVER_PRO=true`、Community Edition を使うなら `SERVER_PRO=false` を設定することだけです。

    使用する Server Pro / Community Edition のバージョン番号は **config/version** ファイルで設定します。Toolkit では `4.2.3` のような具体的なバージョン番号が必要です。`latest` を使用している場合は、`bin/images` を使ってローカルの `latest` バージョンのイメージ ID を確認し、2.x.x、3.x.x、4.x.x、5.x.x のリリースノートを使ってイメージ ID とバージョンを対応付けることができます。

    独自の内部レジストリからイメージを取得している場合は、`OVERLEAF_IMAGE_NAME` を設定することで Toolkit が使用するイメージを上書きできます。タグは **config/version** ファイルに基づいて Toolkit が自動的に付加するため、指定する必要はありません。
  </Step>

  <Step title="外部アクセスを設定する">
    デフォルトでは、Overleaf は `127.0.0.1:80` でリッスンし、Docker ホストマシンからのトラフィックのみを許可します。

    外部アクセスを許可するには、[**config/overleaf.rc**](/ja/on-premises/configuration/overleaf-toolkit/environment-variables) ファイルで `OVERLEAF_LISTEN_IP` と `OVERLEAF_PORT` を設定します。
  </Step>

  <Step title="環境変数を移行する">
    `docker-compose.yml` の `sharelatex` サービスには、おそらく次のような一連の環境変数が定義されているはずです:

    ```yaml theme={null}
    environment:
        OVERLEAF_APP_NAME: Overleaf Community Edition
        OVERLEAF_PROXY_LEARN: 'true'
        …
    ```

    これらの変数を Toolkit の [**config/variables.env**](/ja/on-premises/configuration/overleaf-toolkit/environment-variables) ファイルにコピーし、次の形式にしてください（`:` の代わりに `=` を使用します）:

    ```env theme={null}
    OVERLEAF_APP_NAME=Overleaf Community Edition
    OVERLEAF_PROXY_LEARN=true
    ```

    Toolkit を使用する場合の例外 / 相違点:

    * `SANDBOXED_COMPILES_` および `DOCKER_RUNNER` で始まる変数は不要になりました。Sandboxed Compiles を有効にするには、**config/overleaf.rc** ファイルで `SIBLING_CONTAINERS_ENABLED=true` を設定します。
    * `OVERLEAF_MONGO_`、`OVERLEAF_REDIS_` で始まる変数と `REDIS_HOST` 変数は不要になりました。MongoDB と Redis は、**config/overleaf.rc** ファイルで `MONGO_URL`、`REDIS_HOST`、`REDIS_PORT` を使って設定するようになりました。

    高度な設定オプションについては、[config/overleaf.rc](/ja/on-premises/configuration/overleaf-toolkit/environment-variables) のドキュメントを参照してください。
  </Step>

  <Step title="NGINX プロキシ">
    `nginx` の移行方法については、[TLS プロキシのドキュメント](/ja/on-premises/configuration/overleaf-toolkit/tls-proxy)を参照してください:
  </Step>

  <Step title="ボリューム">
    **config/overleaf.rc** でデータボリュームの場所を設定します:

    #### ShareLaTeX

    `OVERLEAF_DATA_PATH` に、`sharelatex` コンテナが使用するデータボリュームの場所を設定します。

    #### MongoDB

    `MONGO_DATA_PATH` に、`mongo` コンテナが使用するデータボリュームの場所を設定します。

    #### Redis

    `REDIS_DATA_PATH` に、`redis` コンテナが使用するデータボリュームの場所を設定します。
  </Step>
</Steps>

詳細や高度な設定については、上記リンク先の関連する Toolkit 設定ドキュメントを参照してください。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.