> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Toolkit 設定

本頁說明 Toolkit 部署中 `config/overleaf.rc` 檔案所支援的環境變數。

`config/overleaf.rc` 檔案由 `NAME=value` 形式的變數定義組成。以 `#` 開頭的行會被視為註解。

<Info>
  變更 `overleaf.rc` 或 `variables.env` 中的任何內容後，您必須執行 `bin/up` 來重新建立 Docker 容器。
</Info>

## 容器

### `sharelatex`

| 名稱 | 說明 |
| - | - |
| `PROJECT_NAME` | <p>設定傳遞給 `docker-compose` 的 `--project-name` 旗標值。在同一台主機上執行多個 Overleaf 執行個體時很有用，因為每個執行個體可以使用不同的專案名稱。<br /><br />- <strong>預設值</strong>：`overleaf`</p> |
| `OVERLEAF_IMAGE_NAME` | <p>Server Pro/CE 應用程式容器所使用的 Docker 映像檔。這只是 Docker 映像檔名稱；Docker 映像檔標籤取自 `config/version`。<br /><br />- <strong>預設值：</strong><br />- Server Pro：`ghcr.io/ayaka-notes/overleaf-pro`<br />- Community Edition：`sharelatex/sharelatex`</p> |
| `SERVER_PRO` | <p>設為 `true` 時，Toolkit 會使用 Server Pro 映像檔（`ghcr.io/ayaka-notes/overleaf-pro`），而非預設的 Server CE 映像檔（`sharelatex/sharelatex`）。<br /><br />- <strong>預設值</strong>：`false`</p> |
| `GIT_BRIDGE_ENABLED` | <p>設為 `true` 以啟用 git-bridge 功能（僅限 Server Pro）。詳細資訊請參閱 <a href="https://www.overleaf.com/learn/how-to/Git_integration">[https://www.overleaf.com/learn/how-to/Git\_integration](https://www.overleaf.com/learn/how-to/Git_integration)</a> 使用者文件。<br /><br />- <strong>預設值：</strong> `false`</p> |
| `GIT_BRIDGE_IMAGE` | <p>git-bridge 容器（僅限 Server Pro）所使用的 Docker 映像檔。這只是 Docker 映像檔名稱；Docker 映像檔標籤取自 `config/version`。<br /><br />- <strong>預設值：</strong> `ghcr.io/ayaka-notes/overleaf-pro/git-bridge`</p> |
| `GIT_BRIDGE_DATA_PATH` | 設定將掛載到 `git-bridge` 容器（僅限 Server Pro）並用於儲存 Git 儲存庫的目錄路徑。可以是完整路徑（以 `/` 開頭），或相對於 Toolkit 根目錄的路徑。 |
| `GIT_BRIDGE_LOG_LEVEL` | <p>設定 `git-bridge` 容器的日誌層級。可用層級：`TRACE`、`DEBUG`、`INFO`、`WARN`、`ERROR`。<br /><br />- <strong>預設值：</strong> `INFO`</p> |
| `SIBLING_CONTAINERS_ENABLED` | <p>設為 `true` 時，Toolkit 會使用<strong>同層容器（Sibling Containers）</strong>技術，在獨立的沙箱中編譯專案，每個專案使用一個獨立的 Docker 容器。詳細資訊請參閱 \<server-pro-only-configuration/sandboxed-compiles> 文件。<br /><br />- <strong>需要：</strong> `SERVER_PRO=true`<br />- <strong>預設值：</strong> `true`</p> |
| `SIBLING_CONTAINERS_PULL` | <p>設為 `true` 時，Toolkit 會在使用 `bin/up` 指令時，自動拉取 <strong>config/variables.env</strong> 檔案中透過 `ALL_TEX_LIVE_DOCKER_IMAGES` 設定的所有 TeX Live 映像檔。<br /><br />- <strong>預設值：</strong> `true`</p> |
| `DOCKER_SOCKET_PATH` | <p>設定主機（執行 Toolkit 的機器）上 Docker socket 的路徑。當 `SIBLING_CONTAINERS_ENABLED` 為 `true` 時，socket 會被掛載到容器中，讓編譯服務能在主機上產生新的 Docker 容器。<br /><br />- <strong>需要：</strong> `SIBLING_CONTAINERS_ENABLED=true`<br />- <strong>預設值：</strong> `/var/run/docker.sock`</p> |
| `OVERLEAF_DATA_PATH` | <p>設定將掛載到主要 `sharelatex` 容器並用於儲存編譯資料的目錄路徑。可以是完整路徑（以 `/` 開頭），或相對於 Toolkit 根目錄的路徑。<br /><br />- <strong>預設值：</strong> `data/overleaf`</p> |
| `OVERLEAF_LISTEN_IP` | <p>設定容器要綁定的主機 IP 位址。例如，若設為 `0.0.0.0`，則網頁介面可透過主機的任何 IP 位址存取。若要直接存取容器，`OVERLEAF_LISTEN_IP` 的值必須設為您的公開 IP 位址。將 `OVERLEAF_LISTEN_IP` 設為 `0.0.0.0` 或主機的外部 IP，在搭配 . 使用時通常會造成錯誤。<br /><br />- <strong>預設值：</strong> `127.0.0.1`</p> |
| `OVERLEAF_PORT` | <p>設定容器要綁定的主機連接埠。例如，若設為 `8099` 且 `OVERLEAF_LISTEN_IP` 設為 `127.0.0.1`，則網頁介面可透過 `http://localhost:8099` 存取。<br /><br />- <strong>預設值：</strong> `80`</p> |
| `OVERLEAF_LOG_PATH` | <p>設定將掛載到主要 `sharelatex` 容器的目錄路徑，用於在 Docker 主機上提供應用程式日誌。可以是完整路徑（以 `/` 開頭），或相對於 Toolkit 根目錄的路徑。移除此設定項目即可停用綁定掛載。未設定時，重新建立容器會捨棄日誌。<br /><br />有關日誌的資訊，請參閱。<br /><br />- <strong>預設值：</strong> 未設定</p> |

***

### `mongo`

| 名稱 | 說明 |
| - | - |
| `MONGO_ENABLED` | <p>設為 `true` 時，Toolkit 會建立一個 MongoDB 容器來託管資料庫。設為 `false` 時，不會建立此容器，系統會改用 `MONGO_URL` 所指定的 MongoDB 資料庫。<br /><br />- <strong>預設值</strong>：`true`</p> |
| `MONGO_URL` | <p>指定當 `MONGO_ENABLED` 為 `false` 時要使用的 MongoDB 連線 URL。<br /><br />- <strong>預設值</strong>：未設定</p> |
| `MONGO_DATA_PATH` | <p>設定將掛載到 `mongo` 容器並用於儲存 MongoDB 資料庫的目錄路徑。可以是完整路徑（以 `/` 開頭），或相對於 Toolkit 根目錄的路徑。此選項僅影響在 `MONGO_ENABLED` 為 `true` 時所建立的本機 `mongo` 容器。<br /><br />- <strong>預設值</strong>：`data/mongo`</p> |
| `MONGO_IMAGE` | <p>MongoDB 容器所使用的 Docker 映像檔。這只是 Docker 映像檔名稱；Docker 映像檔標籤應設定於 `MONGO_VERSION`（見下方）。<br /><br />- <strong>預設值：</strong> `mongo`</p> |
| `MONGO_VERSION` | <p>MongoDB 容器所使用的 MongoDB 版本。值必須以 MongoDB 主要版本號加上句點開頭，例如 `6.0` 或 `6.0-with-suffix`。<br /><br />- <strong>預設值：</strong> `6.0`</p> |

***

### `redis`

| 名稱 | 說明 |
| - | - |
| `REDIS_ENABLED` | <p>設為 `true` 時，Toolkit 會建立一個 Redis 容器來託管 Redis 資料庫。設為 `false` 時，不會建立此容器，系統會改用 `REDIS_HOST` 與 `REDIS_PORT` 所指定的 Redis 資料庫。<br /><br />- <strong>預設值</strong>：`true`</p> |
| `REDIS_HOST` | <p>指定當 `REDIS_ENABLED` 為 `false` 時要使用的 Redis 主機。<br /><br />- <strong>預設值</strong>：未設定</p> |
| `REDIS_PORT` | <p>指定當 `REDIS_ENABLED` 為 `false` 時要使用的 Redis 連接埠。<br /><br />- <strong>預設值</strong>：未設定</p> |
| `REDIS_DATA_PATH` | <p>設定將掛載到 `redis` 容器並用於儲存 Redis 資料庫的目錄路徑。可以是完整路徑（以 `/` 開頭），或相對於 Toolkit 根目錄的路徑。此選項僅影響在 `REDIS_ENABLED` 為 `true` 時所建立的本機 `redis` 容器。<br /><br />- <strong>預設值</strong>：`data/redis`</p> |
| `REDIS_AOF_PERSISTENCE` | <p>為 Redis 開啟 AOF（Append Only File）持久化。這是 Redis 持久化的<strong>建議</strong>設定。<br /><br />更多詳細資訊，請參閱 \<../../maintenance/data-and-backups> 中的 \<../../../maintenance/data-and-backups#aof-append-only-file> 一節。<br /><br />- <strong>預設值：</strong> `true`</p> |

***

### `nginx`

| 名稱 | 說明 |
| - | - |
| `NGINX_ENABLED` | <p>設為 `true` 時，Toolkit 會建立一個 NGINX 容器作為 TLS 代理。<br /><br />- <strong>預設值</strong>：`false`</p> |
| `NGINX_CONFIG_PATH` | <p>TLS 代理所使用的 NGINX 設定檔路徑。<br /><br />- <strong>預設值</strong>：`config/nginx/nginx.conf`</p> |
| `NGINX_TLS_LISTEN_IP` | <p>設定 TLS 代理容器為 HTTPS 綁定的主機 IP 位址。例如，若設為 `0.0.0.0`，則 HTTPS 網頁介面可透過主機的任何 IP 位址存取。通常應設為主機的外部 IP。<br /><br />- <strong>預設值</strong>：`127.0.1.1`</p> |
| `NGINX_HTTP_LISTEN_IP` | <p>設定 TLS 代理容器為 HTTP 重新導向綁定的主機 IP 位址。例如，若設為 `127.0.1.1`，則連到 `127.0.1.1` 的 HTTP 連線會被重新導向到 HTTPS 網頁介面。通常應設為主機的外部 IP。請勿設為 `0.0.0.0`，因為這通常會與 `OVERLEAF_LISTEN_IP` 發生衝突。<br /><br />- <strong>預設值</strong>：`127.0.1.1`</p> |
| `NGINX_HTTP_PORT` | <p>設定 TLS 代理容器為 HTTP 綁定的主機連接埠。<br /><br />- <strong>預設值</strong>：`80`</p> |
| `TLS_PORT` | <p>設定 TLS 代理容器為 HTTPS 綁定的主機連接埠。<br /><br />- <strong>預設值</strong>：`443`</p> |
| `TLS_PRIVATE_KEY_PATH` | <p>TLS 代理所使用的私密金鑰路徑。<br /><br />- <strong>預設值</strong>：`config/nginx/certs/overleaf_key.pem`</p> |
| `TLS_CERTIFICATE_PATH` | <p>TLS 代理所使用的公開憑證路徑。<br /><br />- <strong>預設值</strong>：`config/nginx/certs/overleaf_certificate.pem`</p> |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.