> For the complete documentation index, see [llms.txt](https://ayakaleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ayakaleaf-pro.ayaka.space/on-premises/ja/she-ding/overleaf-toolkit/toolkit-settings.md). # Toolkit 設定 このページでは、Toolkit デプロイでサポートされる環境変数について説明します。 `config/overleaf.rc` Toolkit デプロイ用のファイル。 次の `config/overleaf.rc` ファイルは、次の形式の変数定義で構成されています `NAME=value`。で始まる行 `#` はコメントとして扱われます。 {% hint style="info" %} の内容を変更した後は、Docker コンテナを再作成する必要があります `overleaf.rc` または `variables.env` を実行して `bin/up`. {% endhint %} ## コンテナ ### `sharelatex` | 名前 | 説明 | | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `PROJECT_NAME` | の値を設定します `--project-name` フラグに指定された `docker-compose`。これは、1つのホスト上でOverleafを複数インスタンス実行する場合に便利です。各インスタンスに異なるプロジェクト名を設定できるためです。\n\n- **既定**: `Overleaf` | | `OVERLEAF_IMAGE_NAME` |

Server Pro/CE アプリケーションコンテナで使用される Docker イメージです。これは Docker イメージ名のみで、Docker イメージタグは config/version.

- デフォルト:
- Server Pro: quay.io/sharelatex/sharelatex-pro
- Community Edition: sharelatex/sharelatex

| | `SERVER_PRO` |

に設定すると trueは、Toolkit に Server Pro イメージ（quay.io/sharelatex/sharelatex-pro）をデフォルトの Server CE イメージ（sharelatex/sharelatex).

- 既定: false

| | `GIT_BRIDGE_ENABLED` | に設定すると `true` を使用して git-bridge 機能を有効にします（Server Pro のみ）。詳細は ユーザードキュメントを参照してください。\n\n- **デフォルト:** `false` | | `GIT_BRIDGE_IMAGE` |

git-bridge コンテナ（Server Pro のみ）で使用される Docker イメージです。これは Docker イメージ名のみで、Docker イメージタグは config/version.

- デフォルト: quay.io/sharelatex/git-bridge

| | `GIT_BRIDGE_DATA_PATH` | がマウントされるディレクトリへのパスを設定します `git-bridge` コンテナ（Server Pro のみ）にマウントされ、gitリポジトリの保存に使用されます。これは完全パス（ `/`で始まる）、または Toolkit のベースディレクトリからの相対パスでも構いません。 | | `GIT_BRIDGE_LOG_LEVEL` |

のログレベルを設定します git-bridge コンテナ。利用可能なレベル: TRACE, DEBUG, INFO, WARN, ERROR.

- デフォルト: INFO

| | `SIBLING_CONTAINERS_ENABLED` |

に設定すると trueを有効にすると、Toolkit は Sibling Containers 方式を使用して、プロジェクトごとに別々の Docker コンテナを使う独立したサンドボックスでプロジェクトをコンパイルします。詳細は \ のドキュメントを参照してください。\n\n- 必要条件: SERVER\_PRO=true
- デフォルト: true

| | `SIBLING_CONTAINERS_PULL` | に設定すると `true`を有効にすると、Toolkit は `ALL_TEX_LIVE_DOCKER_IMAGES` の **config/variables.env** で使用されるすべての TeX Live イメージを自動的に pull します `bin/up` コマンドを使用する場合。\n\n- **デフォルト:** `true` | | `DOCKER_SOCKET_PATH` |

ホストマシン（Toolkit を実行しているマシン）の Docker ソケットへのパスを設定します。 SIBLING\_CONTAINERS\_ENABLED である場合 trueが有効なとき、ソケットはコンテナにマウントされ、コンパイラーサービスがホスト上で新しい Docker コンテナを起動できるようにします。\n\n- 必要条件: SIBLING\_CONTAINERS\_ENABLED=true
- デフォルト: /var/run/docker.sock

| | `OVERLEAF_DATA_PATH` | メインの `sharelatex` コンテナにマウントされ、コンパイルデータの保存に使用されるディレクトリへのパスを設定します。これは完全パス（ `/`で始まる）、または Toolkit のベースディレクトリからの相対パスでも構いません。\n\n- **デフォルト:** `data/overleaf` | | `OVERLEAF_LISTEN_IP` | コンテナがバインドするホスト IP アドレスを設定します。たとえば、これが `0.0.0.0`に設定されている場合、Web インターフェースは任意のホスト IP アドレスで利用可能になります。 `OVERLEAF_LISTEN_IP` を直接コンテナアクセス用に使うには、あなたの公開 IP アドレスに設定する必要があります。設定 `OVERLEAF_LISTEN_IP` を `0.0.0.0` 、またはホストの外部 IP に設定すると、通常、. と組み合わせて使用した場合にエラーが発生します。\n\n- **デフォルト:** `127.0.0.1` | | `OVERLEAF_PORT` |

コンテナがバインドするホストポートを設定します。たとえば、これが 8099 および OVERLEAF\_LISTEN\_IP に設定されている場合、 127.0.0.1Web インターフェースは .

- デフォルト: 80

| | `OVERLEAF_LOG_PATH` | メインの `sharelatex` コンテナにマウントされ、Docker ホスト上でアプリケーションログを利用可能にするために使用されます。これは完全パス（ `/`で始まる）、または Toolkit のベースディレクトリからの相対パスでも構いません。バインドマウントを無効にするには config エントリを削除してください。設定されていない場合、コンテナ再作成時にログは破棄されます。\n\nログ記録に関する詳細は を参照してください。\n\n- **デフォルト:** 未設定 | *** ### `mongo` | 名前 | 説明 | | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `MONGO_ENABLED` | に設定すると `true`を有効にすると、Toolkit はデータベースをホストする MongoDB コンテナを作成します。 `false`に設定すると、このコンテナは作成されず、システムは代わりに `MONGO_URL` で指定された MongoDB データベースを使用します。\n\n- **既定**: `true` | | `MONGO_URL` |

を使用する場合に使う MongoDB 接続 URL を指定します MONGO\_ENABLED である場合 false.

- 既定: 未設定

| | `MONGO_DATA_PATH` |

がマウントされるディレクトリへのパスを設定します mongo コンテナにマウントされ、MongoDB データベースの保存に使用されるディレクトリへのパスを指定します。これは完全パス（ /で始まる）、または Toolkit のベースディレクトリからの相対パスでも構いません。このオプションはローカルの mongo コンテナが作成されるときに MONGO\_ENABLED である場合 true.

- 既定: data/mongo

| | `MONGO_IMAGE` | MongoDB コンテナで使用される Docker イメージです。ここでは Docker イメージ名のみを指定し、Docker イメージタグは `MONGO_VERSION` に指定します（以下参照）。\n\n- **デフォルト:** `mongo` | | `MONGO_VERSION` |

MongoDB コンテナで使用される MongoDB のバージョンです。値は MongoDB のメジャーバージョンとドットで始まる必要があります。たとえば 6.0 または 6.0-with-suffix.

- デフォルト: 6.0

| *** ### `redis` | 名前 | 説明 | | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `REDIS_ENABLED` | に設定すると `true`を有効にすると、Toolkit は redis データベースをホストする Redis コンテナを作成します。 `false`に設定すると、このコンテナは作成されず、システムは代わりに `REDIS_HOST` および `REDIS_PORT` で指定された MongoDB データベースを使用します。\n\n- **既定**: `true` | | `REDIS_HOST` |

を使用する Redis ホストを指定します REDIS\_ENABLED である場合 false.

- 既定: 未設定

| | `REDIS_PORT` |

を使用する Redis ポートを指定します REDIS\_ENABLED である場合 false.

- 既定: 未設定

| | `REDIS_DATA_PATH` |

がマウントされるディレクトリへのパスを設定します redis コンテナにマウントされ、Redis データベースの保存に使用されるディレクトリへのパスを指定します。これは完全パス（ /で始まる）、または Toolkit のベースディレクトリからの相対パスでも構いません。このオプションはローカルの redis コンテナが作成されるときに REDIS\_ENABLED である場合 true.

- 既定: data/redis

| | `REDIS_AOF_PERSISTENCE` | Redis の AOF（Append Only File）永続化を有効にします。これは Redis の永続化に対する **推奨** 構成です。\n\n詳細は <../../maintenance/data-and-backups> の <../../../maintenance/data-and-backups#aof-append-only-file> セクションを参照してください。\n\n- **デフォルト:** `true` | *** ### `nginx` | 名前 | 説明 | | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `NGINX_ENABLED` | に設定すると `true`を有効にすると、Toolkit は TLS プロキシとして機能する NGINX コンテナを作成します。\n\n- **既定**: `false` | | `NGINX_CONFIG_PATH` | TLS プロキシに使用する NGINX 設定ファイルへのパス。\n\n- **既定**: `config/nginx/nginx.conf` | | `NGINX_TLS_LISTEN_IP` | HTTPS 用に TLS プロキシコンテナがバインドするホスト IP アドレスを設定します。たとえば、これが `0.0.0.0` に設定されている場合、HTTPS の Web インターフェースは任意のホスト IP アドレスで利用可能になります。通常はホストの外部 IP に設定してください。\n\n- **既定**: `127.0.1.1` | | `NGINX_HTTP_LISTEN_IP` |

HTTP リダイレクト用に TLS プロキシコンテナがバインドするホスト IP アドレスを設定します。たとえば、これが 127.0.1.1 に設定されている場合、 127.0.1.1 への HTTP 接続は HTTPS の Web インターフェースにリダイレクトされます。通常はホストの外部 IP に設定してください。 0.0.0.0 に設定しないでください。通常、 OVERLEAF\_LISTEN\_IP.

- 既定: 127.0.1.1

| | `NGINX_HTTP_PORT` | HTTP 用に TLS プロキシコンテナがバインドするホストポートを設定します。\n\n- **既定**: `80` | | `TLS_PORT` | HTTPS 用に TLS プロキシコンテナがバインドするホストポートを設定します。\n\n- **既定**: `443` | | `TLS_PRIVATE_KEY_PATH` | TLS プロキシで使用する秘密鍵へのパス。\n\n- **既定**: `config/nginx/certs/overleaf_key.pem` | | `TLS_CERTIFICATE_PATH` | TLS プロキシで使用する公開証明書へのパス。\n\n- **既定**: `config/nginx/certs/overleaf_certificate.pem` | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://ayakaleaf-pro.ayaka.space/on-premises/ja/she-ding/overleaf-toolkit/toolkit-settings.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.