> 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/zh-tw/she-ding/overleaf-toolkit/toolkit-settings.md).
# Toolkit 設定
本頁說明在……中支援的環境變數 `config/overleaf.rc` 供 Toolkit 部署使用的檔案。
該 `config/overleaf.rc` 檔案包含格式如下的變數定義 `NAME=value`。以……開頭的行 `#` 開頭的行會被視為註解。
{% hint style="info" %}
在變更任何 `overleaf.rc` 或 `variables.env` 之後，請執行 `bin/up`.
{% endhint %}
## 容器
### `sharelatex`
| 名稱 | 說明 |
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `PROJECT_NAME` | 設定……的值 --project-name 旗標，提供給 docker-compose。這在於同一主機上執行多個 Overleaf 執行個體時很有用，因為每個執行個體都可以有不同的專案名稱。
- 預設: overleaf
|
| `OVERLEAF_IMAGE_NAME` | Server Pro/CE 應用程式容器所使用的 Docker 映像。這只是 Docker 映像名稱；Docker 映像標籤取自 config/version.
- 預設：
- Server Pro: quay.io/sharelatex/sharelatex-pro
- 社群版： 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）。更多資訊請參閱 使用者文件。
- 預設： false
|
| `GIT_BRIDGE_IMAGE` | git-bridge 容器所使用的 Docker 映像（僅限 Server Pro）。這只是 Docker 映像名稱；Docker 映像標籤取自 config/version.
- 預設： quay.io/sharelatex/git-bridge
|
| `GIT_BRIDGE_DATA_PATH` | 設定將會掛載到 `git-bridge` 容器（僅限 Server Pro），並用來儲存 git-repositories。這可以是完整路徑（以 `/`），或是相對於 Toolkit 基礎目錄的相對路徑。 |
| `GIT_BRIDGE_LOG_LEVEL` | 設定 git-bridge 容器的記錄層級。可用等級： TRACE, DEBUG, INFO, WARN, ERROR.
- 預設： INFO
|
| `SIBLING_CONTAINERS_ENABLED` | 當設定為 true，會告訴 Toolkit 使用 Sibling Containers 技術，將專案在彼此獨立的沙箱中編譯，每個專案使用獨立的 Docker 容器。更多資訊請參閱 \ 文件。
- 需要： SERVER\_PRO=true
- 預設： true
|
| `SIBLING_CONTAINERS_PULL` | 當設定為 true，會告訴 Toolkit 自動拉取所有使用 ALL\_TEX\_LIVE\_DOCKER\_IMAGES 在 config/variables.env 在使用 bin/up 命令時的檔案。
- 預設： true
|
| `DOCKER_SOCKET_PATH` | 設定主機機器（執行 Toolkit 的機器）上 Docker socket 的路徑。當 SIBLING\_CONTAINERS\_ENABLED 為 true時，該 socket 將會掛載到容器中，以允許編譯器服務在主機上建立新的 Docker 容器。
- 需要： SIBLING\_CONTAINERS\_ENABLED=true
- 預設： /var/run/docker.sock
|
| `OVERLEAF_DATA_PATH` | 設定將會掛載到主要 sharelatex 容器，並用來儲存編譯資料。這可以是完整路徑（以 /），或是相對於 Toolkit 基礎目錄的相對路徑。
- 預設： data/overleaf
|
| `OVERLEAF_LISTEN_IP` | 設定容器將繫結的主機 IP 位址。例如，如果這設為 0.0.0.0，那麼網頁介面將可透過任何主機 IP 位址存取。若要直接存取容器，……的值必須設為你的公開 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，那麼網頁介面將可透過
- 預設： 80
|
| `OVERLEAF_LOG_PATH` | 設定將會掛載到主要 sharelatex 容器，並用來讓應用程式記錄可在 Docker 主機上存取。這可以是完整路徑（以 /），或是相對於 Toolkit 基礎目錄的相對路徑。移除設定項目即可停用繫結掛載。若未設定，重建容器時記錄檔將會被丟棄。
請參閱有關記錄的資訊。
- 預設： 未設定
|
***
### `mongo`
| 名稱 | 說明 |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `MONGO_ENABLED` | 當設定為 true，會告訴 Toolkit 建立一個 MongoDB 容器來主控資料庫。當設為 false時，不會建立此容器，而系統將改用由……指定的 MongoDB 資料庫 MONGO\_URL 。
- 預設: 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 （見下文）。
- 預設： mongo
|
| `MONGO_VERSION` | MongoDB 容器所使用的 MongoDB 版本。其值必須以 MongoDB 的主要版本號和一個點開頭，例如 6.0 或 6.0-with-suffix.
- 預設： 6.0
|
***
### `redis`
| 名稱 | 說明 |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `REDIS_ENABLED` | 當設定為 true，會告訴 Toolkit 建立一個 Redis 容器來主控 redis 資料庫。當設為 false時，不會建立此容器，而系統將改用由……指定的 Redis 資料庫 REDIS\_HOST 以及 REDIS\_PORT 。
- 預設: 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 持久化設定。更多詳細資訊，請參閱 <../../../maintenance/data-and-backups#aof-append-only-file> 中的 <../../maintenance/data-and-backups> 區段。
- 預設： true
|
***
### `nginx`
| 名稱 | 說明 |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `NGINX_ENABLED` | 當設定為 true，會告訴 Toolkit 建立一個 NGINX 容器作為 TLS Proxy。
- 預設: false
|
| `NGINX_CONFIG_PATH` | 供 TLS Proxy 使用的 NGINX 設定檔路徑。
- 預設: config/nginx/nginx.conf
|
| `NGINX_TLS_LISTEN_IP` | 設定 TLS Proxy 容器將繫結的主機 IP 位址以供 HTTPS 使用。例如，如果這設為 0.0.0.0 那麼 HTTPS 網頁介面將可透過任何主機 IP 位址存取。通常這應設為你主機的外部 IP。
- 預設: 127.0.1.1
|
| `NGINX_HTTP_LISTEN_IP` | 設定 TLS Proxy 容器將繫結的主機 IP 位址以供 HTTP 重新導向。例如，如果這設為 127.0.1.1 那麼對……的 HTTP 連線將會重新導向至 127.0.1.1 HTTPS 網頁介面。通常這應設為你主機的外部 IP。請不要將其設為 0.0.0.0 ，因為這通常會與……發生衝突 OVERLEAF\_LISTEN\_IP.
- 預設: 127.0.1.1
|
| `NGINX_HTTP_PORT` | 設定 TLS Proxy 容器將繫結的主機連接埠以供 HTTP 使用。
- 預設: 80
|
| `TLS_PORT` | 設定 TLS Proxy 容器將繫結的主機連接埠以供 HTTPS 使用。
- 預設: 443
|
| `TLS_PRIVATE_KEY_PATH` | 供 TLS Proxy 使用的私鑰路徑。
- 預設: config/nginx/certs/overleaf\_key.pem
|
| `TLS_CERTIFICATE_PATH` | 供 TLS Proxy 使用的公開憑證路徑。
- 預設: 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/zh-tw/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.