Toolkit の設定 - Ayakaleaf Pro

このページでは、Toolkit デプロイの config/overleaf.rc ファイルでサポートされている環境変数について説明します。 config/overleaf.rc ファイルは、NAME=value 形式の変数定義で構成されます。# で始まる行はコメントとして扱われます。

overleaf.rc または variables.env の内容を変更した後は、bin/up を実行して Docker コンテナを再作成する必要があります。

コンテナ

`sharelatex`

名前	説明
`PROJECT_NAME`	`docker-compose` に渡される `--project-name` フラグの値を設定します。1 台のホストで複数の Overleaf インスタンスを実行する場合に、インスタンスごとに異なるプロジェクト名を付けられるため便利です。 - デフォルト: `overleaf`
`OVERLEAF_IMAGE_NAME`	Server Pro/CE のアプリケーションコンテナで使用される Docker イメージ。これは Docker イメージ名のみで、Docker イメージのタグは `config/version` から取得されます。 - デフォルト: - Server Pro: `ghcr.io/ayaka-notes/overleaf-pro` - Community Edition: `sharelatex/sharelatex`
`SERVER_PRO`	`true` に設定すると、Toolkit はデフォルトの Server CE イメージ（`sharelatex/sharelatex`）ではなく、Server Pro イメージ（`ghcr.io/ayaka-notes/overleaf-pro`）を使用します。 - デフォルト: `false`
`GIT_BRIDGE_ENABLED`	`true` に設定すると git-bridge 機能が有効になります（Server Pro のみ）。詳細はユーザードキュメント https://www.overleaf.com/learn/how-to/Git_integration を参照してください。 - デフォルト: `false`
`GIT_BRIDGE_IMAGE`	git-bridge コンテナで使用される Docker イメージ（Server Pro のみ）。これは Docker イメージ名のみで、Docker イメージのタグは `config/version` から取得されます。 - デフォルト: `ghcr.io/ayaka-notes/overleaf-pro/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 コンテナを用いて、別々のサンドボックスでプロジェクトをコンパイルします。詳細は <server-pro-only-configuration/sandboxed-compiles> のドキュメントを参照してください。 - 要件: `SERVER_PRO=true` - デフォルト: `true`
`SIBLING_CONTAINERS_PULL`	`true` に設定すると、Toolkit は `bin/up` コマンドの使用時に、config/variables.env ファイルの `ALL_TEX_LIVE_DOCKER_IMAGES` で設定されたすべての TeX Live イメージを自動的にプルします。 - デフォルト: `true`
`DOCKER_SOCKET_PATH`	ホストマシン（Toolkit を実行しているマシン）上の Docker ソケットのパスを設定します。`SIBLING_CONTAINERS_ENABLED` が `true` の場合、このソケットがコンテナにマウントされ、コンパイラーサービスがホスト上に新しい Docker コンテナを起動できるようになります。 - 要件: `SIBLING_CONTAINERS_ENABLED=true` - デフォルト: `/var/run/docker.sock`
`OVERLEAF_DATA_PATH`	メインの `sharelatex` コンテナにマウントされ、コンパイルデータの保存に使用されるディレクトリのパスを設定します。フルパス（`/` で始まる）または Toolkit のベースディレクトリからの相対パスで指定できます。 - デフォルト: `data/overleaf`
`OVERLEAF_LISTEN_IP`	コンテナがバインドするホストの IP アドレスを設定します。たとえば `0.0.0.0` に設定すると、Web インターフェースはホストのすべての IP アドレスで利用可能になります。コンテナに直接アクセスする場合は、`OVERLEAF_LISTEN_IP` の値をパブリック IP アドレスに設定する必要があります。`OVERLEAF_LISTEN_IP` を `0.0.0.0` またはホストの外部 IP に設定すると、と併用した場合に通常エラーが発生します。 - デフォルト: `127.0.0.1`
`OVERLEAF_PORT`	コンテナがバインドするホストのポートを設定します。たとえば `8099` に設定し、`OVERLEAF_LISTEN_IP` を `127.0.0.1` に設定すると、Web インターフェースは `http://localhost:8099` で利用可能になります。 - デフォルト: `80`
`OVERLEAF_LOG_PATH`	メインの `sharelatex` コンテナにマウントされ、アプリケーションログを Docker ホスト上で参照できるようにするためのディレクトリのパスを設定します。フルパス（`/` で始まる）または Toolkit のベースディレクトリからの相対パスで指定できます。バインドマウントを無効にするには、この設定項目を削除してください。未設定の場合、コンテナを再作成するとログは破棄されます。ログの詳細についてはを参照してください。 - デフォルト: 未設定

`mongo`

名前	説明
`MONGO_ENABLED`	`true` に設定すると、Toolkit はデータベースをホストする MongoDB コンテナを作成します。`false` に設定すると、このコンテナは作成されず、代わりに `MONGO_URL` で指定された MongoDB データベースが使用されます。 - デフォルト: `true`
`MONGO_URL`	`MONGO_ENABLED` が `false` の場合に使用する MongoDB の接続 URL を指定します。 - デフォルト: 未設定
`MONGO_DATA_PATH`	`mongo` コンテナにマウントされ、MongoDB データベースの保存に使用されるディレクトリのパスを設定します。フルパス（`/` で始まる）または Toolkit のベースディレクトリからの相対パスで指定できます。このオプションは、`MONGO_ENABLED` が `true` の場合に作成されるローカルの `mongo` コンテナにのみ影響します。 - デフォルト: `data/mongo`
`MONGO_IMAGE`	MongoDB コンテナで使用される Docker イメージ。これは Docker イメージ名のみで、Docker イメージのタグは `MONGO_VERSION`（下記参照）に指定します。 - デフォルト: `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` で指定された Redis データベースが使用されます。 - デフォルト: `true`
`REDIS_HOST`	`REDIS_ENABLED` が `false` の場合に使用する Redis ホストを指定します。 - デフォルト: 未設定
`REDIS_PORT`	`REDIS_ENABLED` が `false` の場合に使用する Redis ポートを指定します。 - デフォルト: 未設定
`REDIS_DATA_PATH`	`redis` コンテナにマウントされ、Redis データベースの保存に使用されるディレクトリのパスを設定します。フルパス（`/` で始まる）または Toolkit のベースディレクトリからの相対パスで指定できます。このオプションは、`REDIS_ENABLED` が `true` の場合に作成されるローカルの `redis` コンテナにのみ影響します。 - デフォルト: `data/redis`
`REDIS_AOF_PERSISTENCE`	Redis の AOF（Append Only File）永続化を有効にします。これは Redis の永続化における推奨設定です。詳細は <../../maintenance/data-and-backups> の <../../../maintenance/data-and-backups#aof-append-only-file> セクションを参照してください。 - デフォルト: `true`

`nginx`

名前	説明
`NGINX_ENABLED`	`true` に設定すると、Toolkit は TLS プロキシとして機能する NGINX コンテナを作成します。 - デフォルト: `false`
`NGINX_CONFIG_PATH`	TLS プロキシに使用する NGINX 設定ファイルのパス。 - デフォルト: `config/nginx/nginx.conf`
`NGINX_TLS_LISTEN_IP`	TLS プロキシコンテナが HTTPS 用にバインドするホストの IP アドレスを設定します。たとえば `0.0.0.0` に設定すると、HTTPS の Web インターフェースはホストのすべての IP アドレスで利用可能になります。通常はホストの外部 IP に設定します。 - デフォルト: `127.0.1.1`
`NGINX_HTTP_LISTEN_IP`	TLS プロキシコンテナが HTTP リダイレクト用にバインドするホストの 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`	TLS プロキシコンテナが HTTP 用にバインドするホストのポートを設定します。 - デフォルト: `80`
`TLS_PORT`	TLS プロキシコンテナが HTTPS 用にバインドするホストのポートを設定します。 - デフォルト: `443`
`TLS_PRIVATE_KEY_PATH`	TLS プロキシに使用する秘密鍵のパス。 - デフォルト: `config/nginx/certs/overleaf_key.pem`
`TLS_CERTIFICATE_PATH`	TLS プロキシに使用する公開証明書のパス。 - デフォルト: `config/nginx/certs/overleaf_certificate.pem`

最終更新日 2026年10月5日