ファイルと場所

このページでは、Toolkit がオンプレミスの Overleaf 展開を構成するために使用する設定ファイルについて説明します。

永続データ

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

データディレクトリ

その sharelatex コンテナは LaTeX コンパイルに関連するデータを格納するディレクトリを必要とします。このディレクトリは OVERLEAF_DATA_PATH 変数で config/overleaf.rc.

その mongo 有効な場合、コンテナはデータベースファイルを格納するディレクトリを必要とし、同じことが redis コンテナにも当てはまります。これらのディレクトリは config/overleaf.rc.

ファイル許可

Docker が rootとして実行されるため、データディレクトリは root ユーザーによって所有されることになります。Toolkit が非 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 ファイルには、環境変数が含まれており、それらはコンテナにロードされ、Overleaf マイクロサービスの構成に使用されます。 sharelatex これには、ウェブインターフェースのヘッダーに表示されるアプリケーション名、メール送信の設定、Server Pro 用の SSO のようなプレミアム設定などが含まれます。

利用可能なすべての環境変数の内訳を確認するには、 環境変数 セクションを参照してください。

その バージョン ファイル

その 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 のドキュメント を参照してください。