Skip to main content
このページでは、Overleaf のオンプレミスデプロイメントを設定するために Toolkit が使用する設定ファイルについて説明します。

永続データ

Overleaf Toolkit は、LaTeX プロジェクトのコンパイルに必要なファイルや MongoDB データベースの内容などの永続データを保存する必要があります。これは、ホストマシン上のいくつかのディレクトリを Docker コンテナにマウントし、それらのディレクトリにデータを書き込むことで実現されます。

データディレクトリ

sharelatex コンテナには、LaTeX のコンパイルに関するデータを保存するためのディレクトリが必要です。このディレクトリは config/overleaf.rc の OVERLEAF_DATA_PATH 変数で設定します。 mongo コンテナが有効な場合は、データベースファイルを保存するためのディレクトリが必要です。redis コンテナも同様です。これらのディレクトリも config/overleaf.rc で設定できます。

ファイルのパーミッション

Docker は root として実行されるため、Toolkit を root 以外のユーザーが使用している場合でも、データディレクトリの所有者は root ユーザーになります。これは問題ではありませんが、コンテナの外部から永続データを変更するつもりであれば注意しておく価値があります。

設定ファイルの場所

ユーザーが所有するすべての設定ファイルは config/ ディレクトリにあります。 このディレクトリは git のリビジョン管理から除外されているため、Toolkit のコードを更新しても変更されません。Toolkit は、あなたの許可なく config/ ディレクトリ内のデータを変更することはありません。
設定ファイルへの変更は、コンテナを停止して再起動しても(bin/stop と bin/start で)、既存のコンテナには自動的に適用されません。変更を適用するには bin/up を実行してください。裏側で docker compose が設定の変更を新しいコンテナに自動的に適用します。(Docker のログにアタッチしたくない場合は bin/up -d を実行してください。)

overleaf.rc ファイル

config/overleaf.rc ファイルには、Toolkit が使用する最も重要なトップレベルの設定が含まれています。VARIABLE_NAME=value という形式で変数を設定する文が記述されています。 利用可能なすべての設定オプションの詳細については、設定セクションを参照してください。

variables.env ファイル

config/variables.env ファイルには、sharelatex コンテナに読み込まれ、Overleaf のマイクロサービスの設定に使用される環境変数が含まれています。これには、Web インターフェースのヘッダーに表示されるアプリケーション名、メール送信の設定、Server Pro で使用する SSO などのその他のプレミアム設定が含まれます。 利用可能なすべての環境変数の詳細については、環境変数セクションを参照してください。

version ファイル

config/version ファイルには、Overleaf サーバーの実行インスタンスを作成するために使用される Docker イメージのバージョン番号が含まれています。
これらの設定ファイルへの変更は、コンテナを停止して再起動しても(bin/stop と bin/start で)、既存のコンテナには自動的に適用されません。変更を適用するには bin/up を実行してください。Toolkit が設定の変更を適用した新しいコンテナを自動的に作成します。

docker-compose.override.yml ファイル

config/docker-compose.override.yml ファイルが存在する場合、docker compose の呼び出しに含められます。これは Docker Compose 固有の設定を上書きするのに便利です。 詳細については docker-compose のドキュメントを参照してください。
最終更新日 2026年10月4日