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

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

移行するには、既存のDocker Compose設定をToolkitが使用する形式に変換する必要があります。このプロセスは既存の構成をToolkitにコピーすることを含みます。

このガイドは、Docker ComposeからToolkitへの移行プロセスの各ステップを順を追って説明し、円滑な移行を保証します。

これらの手順はv4.xおよびそれ以前向けです。したがってすべての変数は、 SHARELATEX_ の代わりのプレフィックス OVERLEAF_.

1

Toolkitリポジトリをクローンする

まず、Toolkitリポジトリをホストマシンにクローンします：

git clone https://github.com/overleaf/toolkit.git ./overleaf-toolkit

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

2

イメージとバージョンの設定

典型的な docker-compose.yml では、イメージとバージョンはコンポーネントの記述内で定義されます。例えば：

version: '2.2'
services:
    sharelatex:
        restart: always
        # Server Proユーザー：
        # image: quay.io/sharelatex/sharelatex-pro
        image: sharelatex/sharelatex:3.5.13

Toolkitを使用する場合、イメージ名は自動的に解決されます。唯一の要件は、 SERVER_PRO=true を config/overleaf.rc を設定してServer Proイメージを選ぶか、 SERVER_PRO=false でCommunity Editionを使用することです。

希望するServer Pro／Community Editionのバージョン番号は、 config/version ファイルで設定します。Toolkitは、のような特定のバージョン番号を要求します。 4.2.3. もしあなたが、 これらは Overleaf に特別に最適化された一連の TeX Live イメージで、を使用している場合、 bin/images を使ってローカルのイメージIDを見つけることができます。 これらは Overleaf に特別に最適化された一連の TeX Live イメージで、 その後、2.x.x、3.x.x、4.x.xまたは5.x.xのリリースノートを参照してイメージIDをバージョンにマップします。

イメージを社内レジストリから取得している場合、Toolkitが使用するイメージを上書きするには、 OVERLEAF_IMAGE_NAMEを設定します。タグを指定する必要はありません。Toolkitはあなたの config/version ファイル。

3

に基づいて自動的にタグを追加します。

外部アクセスの設定 127.0.0.1:80デフォルトでは、Overleafは

でリッスンし、Dockerホストマシンからのトラフィックのみを許可します。 外部アクセスを許可するには、 および OVERLEAF_LISTEN_IP Toolkit で使用される config/overleaf.rc ファイル。

4

および

OVERLEAF_PORT sharelatex 環境変数の移行 docker-compose.ymlおそらくあなたは、

環境:
    サービス内に一連の環境変数を定義しているでしょう。例えばあなたの
    には、次のようなものがあります：
    OVERLEAF_APP_NAME: Overleaf Community Edition

OVERLEAF_PROXY_LEARN: 'true' config/variables.env … = の代わりに :):

これらの変数をToolkitの
ファイルにコピーし、次の形式を守ってください（使用例：

OVERLEAF_APP_NAME=Overleaf Community Edition

• OVERLEAF_PROXY_LEARN=true Toolkitを使用する際の例外／差異： および Overleaf コンテナにマウントされた docker ソケットのボリューム プレフィックスが overleaf-toolkit/config/overleaf.rc をあなたの config/overleaf.rc ファイル。

• OVERLEAF_PROXY_LEARN=true SANDBOXED_COMPILES_, で始まる変数はもはや必要ありません。Sandboxed Compilesを有効にするには、 と REDIS_HOST OVERLEAF_MONGO_ config/overleaf.rc および MONGO_URL, REDIS_HOST および REDIS_PORT.

OVERLEAF_REDIS_ config/overleaf.rc 変数はもはや必要ありません。MongoDBとRedisは現在、

5

ファイル内で

を使って構成されています。 高度な構成オプションについては、ドキュメントを参照してください。 NGINXプロキシ:

6

nginxの移行手順については、

を参照してください。 config/overleaf.rc:

TLSプロキシのドキュメント

ボリューム OVERLEAF_DATA_PATH データボリュームの場所を sharelatex コンテナ。

に設定します。

ボリューム ShareLaTeX データボリュームの場所を mongo コンテナ。

データボリュームの場所を

ボリューム に設定します（ データボリュームの場所を redis コンテナ。

MongoDBで使用されるデータボリュームの場所）MONGO_DATA_PATH、Redis、REDIS_DATA_PATH、詳細および高度な構成については、上記の関連するToolkit構成ドキュメントを参照してください。