> For the complete documentation index, see [llms.txt](https://overleaf-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://overleaf-pro.ayaka.space/on-premises/zh-tw/she-ding/overleaf-toolkit/toolkit-settings.md).

# Toolkit 設定

本頁面說明在 `config/overleaf.rc` Toolkit 部署中的 .file。

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

{% hint style="info" %}
在變更 `之後，必須重新建立 Docker 容器，或者` 或 `variables.env` ，執行 `bin/up`.
{% endhint %}

## 容器

### `sharelatex`

| 名稱                           | 描述                                                                                                                                                                                                                                                                                                     |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `PROJECT_NAME`               | <p>設為 <code>--project-name</code> 旗標傳給 <code>docker-compose</code>。當在同一主機上執行多個 Overleaf 實例時這很有用，因為每個實例都可以有不同的專案名稱。<br><br>- <strong>預設</strong>: <code>Overleaf</code></p>                                                                                                                             |
| `OVERLEAF_IMAGE_NAME`        | <p>伺服器 Pro/CE 應用程式容器所使用的 Docker 映像。這只是 Docker 映像名稱；Docker 映像標籤來自 <code>config/version</code>.<br><br>- <strong>預設：</strong><br>- Server Pro： <code>quay.io/sharelatex/sharelatex-pro</code><br>- Community Edition： <code>sharelatex/sharelatex</code></p>                                             |
| `SERVER_PRO`                 | <p>當設為 <code>true</code>，表示 Toolkit 使用 Server Pro 映像（<code>quay.io/sharelatex/sharelatex-pro</code>），而不是預設的 Server CE 映像（<code>sharelatex/sharelatex</code>).<br><br>- <strong>預設</strong>: <code>false</code></p>                                                                                     |
| `GIT_BRIDGE_ENABLED`         | <p>設為 <code>true</code> 以啟用 git-bridge 功能（僅限 Server Pro）。更多資訊請參閱 <a href="https://www.overleaf.com/learn/how-to/Git_integration"><https://www.overleaf.com/learn/how-to/Git_integration></a> 使用者文件。<br><br>- <strong>預設：</strong> <code>false</code></p>                                               |
| `GIT_BRIDGE_IMAGE`           | <p>git-bridge 容器所使用的 Docker 映像（僅限 Server Pro）。這只是 Docker 映像名稱；Docker 映像標籤來自 <code>config/version</code>.<br><br>- <strong>預設：</strong> <code>quay.io/sharelatex/git-bridge</code></p>                                                                                                                  |
| `GIT_BRIDGE_DATA_PATH`       | 設定將會掛載到 `git-bridge` 容器（僅限 Server Pro）中，並用來儲存 git-repositories 的目錄路徑。這可以是完整路徑（以 `/`開頭），或相對於 Toolkit 基礎目錄的相對路徑。                                                                                                                                                                                         |
| `GIT_BRIDGE_LOG_LEVEL`       | <p>設定 <code>git-bridge</code> 容器的記錄等級。可用等級： <code>TRACE</code>, <code>DEBUG</code>, <code>INFO</code>, <code>WARN</code>, <code>ERROR</code>.<br><br>- <strong>預設：</strong> <code>INFO</code></p>                                                                                                      |
| `SIBLING_CONTAINERS_ENABLED` | <p>當設為 <code>true</code>，表示 Toolkit 使用 <strong>同層容器</strong> 技術，透過為每個專案使用獨立的 Docker 容器，在各自的沙盒中編譯專案。更多資訊請參閱 \<server-pro-only-configuration/sandboxed-compiles> 文件。<br><br>- <strong>需要：</strong> <code>SERVER\_PRO=true</code><br>- <strong>預設：</strong> <code>true</code></p>                         |
| `SIBLING_CONTAINERS_PULL`    | <p>當設為 <code>true</code>，表示 Toolkit 會自動拉取所有使用 <code>ALL\_TEX\_LIVE\_DOCKER\_IMAGES</code> 在 <strong>config/variables.env</strong> 檔案，在使用該 <code>bin/up</code> 指令時。<br><br>- <strong>預設：</strong> <code>true</code></p>                                                                                 |
| `DOCKER_SOCKET_PATH`         | <p>設定主機機器（執行 Toolkit 的機器）上 Docker socket 的路徑。當 <code>SIBLING\_CONTAINERS\_ENABLED</code> 是 <code>true</code>時，socket 會被掛載到容器中，以允許編譯器服務在主機上啟動新的 Docker 容器。<br><br>- <strong>需要：</strong> <code>SIBLING\_CONTAINERS\_ENABLED=true</code><br>- <strong>預設：</strong> <code>/var/run/docker.sock</code></p> |
| `OVERLEAF_DATA_PATH`         | <p>設定將會掛載到主要 <code>sharelatex</code> 容器中，並用來儲存編譯資料的目錄路徑。這可以是完整路徑（以 <code>/</code>開頭），或相對於 Toolkit 基礎目錄的相對路徑。<br><br>- <strong>預設：</strong> <code>data/overleaf</code></p>                                                                                                                              |
| `OVERLEAF_LISTEN_IP`         | <p>設定容器將綁定的主機 IP 位址。例如，如果設為 <code>0.0.0.0</code>，則網頁介面將可透過任何主機 IP 位址使用。若要直接存取容器， <code>OVERLEAF\_LISTEN\_IP</code> 的值必須設為您的公用 IP 位址。將 <code>OVERLEAF\_LISTEN\_IP</code> 設為 <code>0.0.0.0</code> 或主機的外部 IP，通常在與 . 一起使用時會導致錯誤。<br><br>- <strong>預設：</strong> <code>127.0.0.1</code></p>                  |
| `OVERLEAF_PORT`              | <p>設定容器將綁定的主機連接埠。例如，如果設為 <code>8099</code> 以及 <code>OVERLEAF\_LISTEN\_IP</code> 設為 <code>127.0.0.1</code>，則網頁介面將可透過 <code><http://localhost:8099></code>.<br><br>- <strong>預設：</strong> <code>80</code></p>                                                                                            |
| `OVERLEAF_LOG_PATH`          | <p>設定將會掛載到主要 <code>sharelatex</code> 容器中，並用於讓應用程式記錄可在 Docker 主機上使用。這可以是完整路徑（以 <code>/</code>開頭），或相對於 Toolkit 基礎目錄的相對路徑。移除此設定項目即可停用綁定掛載。若未設定，重新建立容器時記錄將會被捨棄。<br><br>請參閱以了解記錄資訊。<br><br>- <strong>預設：</strong> 未設定</p>                                                                                   |

***

### `mongo`

| 名稱                | 描述                                                                                                                                                                                                                                                    |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `MONGO_ENABLED`   | <p>當設為 <code>true</code>，表示 Toolkit 會建立一個 MongoDB 容器來主機化資料庫。當設為 <code>false</code>時，將不會建立此容器，系統將改用由 <code>MONGO\_URL</code> 指定的 MongoDB 資料庫。<br><br>- <strong>預設</strong>: <code>true</code></p>                                                      |
| `MONGO_URL`       | <p>指定在 <code>MONGO\_ENABLED</code> 是 <code>false</code>.<br><br>- <strong>預設</strong>：未設定</p>                                                                                                                                                         |
| `MONGO_DATA_PATH` | <p>設定將會掛載到 <code>mongo</code> 容器中，並用來儲存 MongoDB 資料庫。這可以是完整路徑（以 <code>/</code>開頭），或相對於 toolkit 基礎目錄的相對路徑。此選項只會影響本機 <code>mongo</code> 時所建立的 <code>MONGO\_ENABLED</code> 是 <code>true</code>.<br><br>- <strong>預設</strong>: <code>data/mongo</code></p> |
| `MONGO_IMAGE`     | <p>MongoDB 容器所使用的 Docker 映像。這只是 Docker 映像名稱；Docker 映像標籤應放入 <code>MONGO\_VERSION</code> （見下文）。<br><br>- <strong>預設：</strong> <code>mongo</code></p>                                                                                                    |
| `MONGO_VERSION`   | <p>MongoDB 容器所使用的 MongoDB 版本。值必須以主要 MongoDB 版本加上一個點開頭，例如 <code>6.0</code> 或 <code>6.0-with-suffix</code>.<br><br>- <strong>預設：</strong> <code>6.0</code></p>                                                                                          |

***

### `redis`

| 名稱                      | 描述                                                                                                                                                                                                                                                     |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `REDIS_ENABLED`         | <p>當設為 <code>true</code>，表示 Toolkit 會建立一個 Redis 容器來主機化 redis 資料庫。當設為 <code>false</code>時，將不會建立此容器，系統將改用由 <code>REDIS\_HOST</code> 以及 <code>REDIS\_PORT</code> 指定的 MongoDB 資料庫。<br><br>- <strong>預設</strong>: <code>true</code></p>                     |
| `REDIS_HOST`            | <p>指定 Redis 主機。 <code>REDIS\_ENABLED</code> 是 <code>false</code>.<br><br>- <strong>預設</strong>：未設定</p>                                                                                                                                                 |
| `REDIS_PORT`            | <p>指定 Redis 連接埠。 <code>REDIS\_ENABLED</code> 是 <code>false</code>.<br><br>- <strong>預設</strong>：未設定</p>                                                                                                                                                |
| `REDIS_DATA_PATH`       | <p>設定將會掛載到 <code>redis</code> 容器中，並用來儲存 Redis 資料庫。這可以是完整路徑（以 <code>/</code>開頭），或相對於 Toolkit 基礎目錄的相對路徑。此選項只會影響本機 <code>redis</code> 時所建立的 <code>REDIS\_ENABLED</code> 是 <code>true</code>.<br><br>- <strong>預設</strong>: <code>data/redis</code></p>    |
| `REDIS_AOF_PERSISTENCE` | <p>為 Redis 啟用 AOF（Append Only File）持久化。這是 <strong>建議的</strong> Redis 持久化設定。<br><br>更多細節請參閱 <../../../maintenance/data-and-backups#aof-append-only-file> 區段中的 <../../maintenance/data-and-backups>。<br><br>- <strong>預設：</strong> <code>true</code></p> |

***

### `nginx`

| 名稱                     | 描述                                                                                                                                                                                                                                                                              |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `NGINX_ENABLED`        | <p>當設為 <code>true</code>，表示 Toolkit 會建立一個 NGINX 容器作為 TLS Proxy。<br><br>- <strong>預設</strong>: <code>false</code></p>                                                                                                                                                            |
| `NGINX_CONFIG_PATH`    | <p>要供 TLS Proxy 使用的 NGINX 設定檔路徑。<br><br>- <strong>預設</strong>: <code>config/nginx/nginx.conf</code></p>                                                                                                                                                                         |
| `NGINX_TLS_LISTEN_IP`  | <p>設定 TLS Proxy 容器將綁定於 HTTPS 的主機 IP 位址。例如，如果設為 <code>0.0.0.0</code> ，則 HTTPS 網頁介面將可透過任何主機 IP 位址使用。通常這應設為主機的外部 IP。<br><br>- <strong>預設</strong>: <code>127.0.1.1</code></p>                                                                                                      |
| `NGINX_HTTP_LISTEN_IP` | <p>設定 TLS Proxy 容器將綁定於 HTTP 重新導向的主機 IP 位址。例如，如果設為 <code>127.0.1.1</code> ，則對 <code>127.0.1.1</code> 的 HTTP 連線將會重新導向至 HTTPS 網頁介面。通常這應設為主機的外部 IP。不要將其設為 <code>0.0.0.0</code> ，因為這通常會與 <code>OVERLEAF\_LISTEN\_IP</code>.<br><br>- <strong>預設</strong>: <code>127.0.1.1</code></p> |
| `NGINX_HTTP_PORT`      | <p>設定 TLS Proxy 容器將綁定於 HTTP 的主機連接埠。<br><br>- <strong>預設</strong>: <code>80</code></p>                                                                                                                                                                                           |
| `TLS_PORT`             | <p>設定 TLS Proxy 容器將綁定於 HTTPS 的主機連接埠。<br><br>- <strong>預設</strong>: <code>443</code></p>                                                                                                                                                                                         |
| `TLS_PRIVATE_KEY_PATH` | <p>要供 TLS Proxy 使用的私密金鑰路徑。<br><br>- <strong>預設</strong>: <code>config/nginx/certs/overleaf\_key.pem</code></p>                                                                                                                                                                  |
| `TLS_CERTIFICATE_PATH` | <p>要供 TLS Proxy 使用的公開憑證路徑。<br><br>- <strong>預設</strong>: <code>config/nginx/certs/overleaf\_certificate.pem</code></p>                                                                                                                                                          |


---

# 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://overleaf-pro.ayaka.space/on-premises/zh-tw/she-ding/overleaf-toolkit/toolkit-settings.md?ask=<question>&goal=<endgoal>
```

`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.