> 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/environment-variables.md). # 環境變數 本頁說明在……中支援的環境變數 `config/variables.env` 供 Toolkit 部署使用的檔案。 該 `config/variables.env` 檔案包含格式如下的變數定義 `NAME=value`；以 `#` 開頭的行會被視為註解。 {% hint style="info" %} 在變更任何 `overleaf.rc` 或 `variables.env` 之後，請執行 `bin/up`. {% endhint %} ### 所有版本 這些環境變數與 Server CE 和 Server Pro 相容，並在這兩個內部部署版本之間提供簡便的遷移途徑。它們也可與 Toolkit 和 Docker Compose 部署一起使用。 {% hint style="info" %} 先前，這些環境變數的前綴為 `SHARELATEX_` 而非 `OVERLEAF_`. {% endhint %} | 名稱 | 說明 | | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `OVERLEAF_SITE_URL` | 您的 Overleaf 實例對外公開可存取的位置。這會用於公開連結，以及透過 websockets 連線時，因此必須正確設定！ | | `OVERLEAF_ADMIN_EMAIL` | 使用者可透過此電子郵件地址聯絡網站管理者。 | | `OVERLEAF_APP_NAME` | 在談論執行中的應用程式時顯示的名稱。預設為 'Overleaf (Community Edition)'。 | | `OVERLEAF_MONGO_URL` 以及 `MONGO_URL` | 要使用的 Mongo 資料庫 URL。 | | `OVERLEAF_REDIS_HOST` 以及 `REDIS_HOST` | 要使用的 Redis 執行個體主機名稱。兩者皆為必要（見 [版本資訊](broken://pages/1f6b4ce8aae32f8c94420ec8fa9a8e7993494999#changes-to-the-docker-compose-file-format)). | | `OVERLEAF_REDIS_PORT` 以及 `REDIS_PORT` | 要使用的 Redis 執行個體連接埠。兩者皆為必要（見 [版本資訊](broken://pages/1f6b4ce8aae32f8c94420ec8fa9a8e7993494999#changes-to-the-docker-compose-file-format)). | | `OVERLEAF_REDIS_PASS` 以及 `REDIS_PASSWORD` | 連線至 Redis 時要使用的密碼（如適用）。 **兩者** 環境變數都必須設定。請參閱 [啟用密碼驗證](broken://pages/d26a7033cfd8041bb148e0a82b351eb166a809ce) 以了解更多資訊。 | | `OVERLEAF_REDIS_TLS` |

如果設定為 true，即可連線到需要 TLS 的 Redis 執行個體。

注意： 目前不支援 mTLS。

| | `OVERLEAF_NAV_TITLE` | 設定應用程式的分頁標題。 | | `OVERLEAF_INVITE_TOKEN_SECRET` |

必要。用於保護專案分享權杖的隨機字串（已於 Server Pro 6.2.0 新增）。

最少字元數： 16

| | `OVERLEAF_SESSION_SECRET` | 用於保護權杖的隨機字串；若進行負載平衡，則必須在所有機器上設定相同的權杖。如果只執行 1 個執行個體，使用者不需要設定。 | | `OVERLEAF_COOKIE_SESSION_LENGTH` | 可讓您覆寫預設的 5 天工作階段 cookie 到期時間。覆寫值應以毫秒為單位。例如：若要讓工作階段持續 1 小時，請設定 `COOKIE_SESSION_LENGTH=3600000`。（已於 Server Pro 4.2 新增） | | `OVERLEAF_TRUSTED_PROXY_IPS` |

如果未設定，預設為 loopback。如果手動設定，除了您信任的 IP 之外，還必須包含其中一個 loopback, localhost 或 127.0.0.1，其會信任執行於 sharelatex 容器。

如果您使用來自 172.16.0.0/12 （Docker 網路的預設子網）作為您的一般網路，請設定 OVERLEAF\_TRUSTED\_PROXY\_IPS=loopback,\ 在您的 config/variables.env。其中 \ 是 IPAM -> Config -> Subnet 中的值 docker inspect overleaf\_default，例如 OVERLEAF\_TRUSTED\_PROXY\_IPS=loopback,172.19.0.0/16。這是為了防止偽造 X-Forwarded 標頭。

如果您使用外部 TLS proxy（即不由 Overleaf Toolkit 管理），請確保 OVERLEAF\_TRUSTED\_PROXY\_IPS=loopback,\，例如 OVERLEAF\_TRUSTED\_PROXY\_IPS=loopback,192.168.13.37.

| | `OVERLEAF_RESTRICT_INVITES_TO_EXISTING_ACCOUNTS` | 如果設定為 `true`，將限制專案邀請僅能寄送至與現有使用者帳戶相符的電子郵件地址。 | | `OVERLEAF_ALLOW_PUBLIC_ACCESS` | 如果設定為 `true`，將允許未驗證使用者檢視網站。預設為 `false`，這表示未驗證使用者在嘗試檢視網站任何部分時，將一律重新導向至登入頁面。請注意，設定此選項不會以任何方式停用驗證或安全性。若您的使用者打算將其專案公開，並讓未驗證使用者檢視這些專案，則此選項是必要的。 | | `OVERLEAF_ALLOW_ANONYMOUS_READ_AND_WRITE_SHARING` | 如果設定為 `true`，將允許匿名使用者檢視和編輯透過 [連結分享](https://www.overleaf.com/blog/integration-update-link-sharing-2017-11-27) 功能分享的專案。 | | `OVERLEAF_DISABLE_LINK_SHARING` | 停用 [連結分享](https://www.overleaf.com/blog/integration-update-link-sharing-2017-11-27) 功能分享的專案。 | | `EMAIL_CONFIRMATION_DISABLED` | 當設定為 `true` 時，將不會顯示要求電子郵件確認的橫幅。 | | `ADDITIONAL_TEXT_EXTENSIONS` | 用於設定可編輯檔案之額外副檔名的字串陣列。 | | `DEFAULT_LATEX_COMPILER` |

用於設定……所使用的預設編譯器 新的 專案。（已於 Server Pro 6.2.0 新增）。

選項： pdflatex, latex, xelatex 或 lualatex

| | `OVERLEAF_STATUS_PAGE_URL` | 自訂狀態頁面 URL（已於 Server Pro 3.4.0 新增），例如 `status.example.com`. | | `OVERLEAF_FPH_INITIALIZE_NEW_PROJECTS` | 設定為 `'false'` 以防止新專案以完整專案歷史記錄初始化。（已於 Server Pro 3.5.0 新增）。 | | `OVERLEAF_FPH_DISPLAY_NEW_PROJECTS` | 設定為 `'false'` 以防止新專案顯示完整專案歷史記錄，而不是舊版歷史記錄。（已於 Server Pro 3.5.0 新增）。 | | `ENABLE_CRON_RESOURCE_DELETION` | 將此環境變數設定為 `true` 以啟用在 90 天後自動清理已刪除的專案與使用者。 | | `OVERLEAF_USER_HARD_DELETION_DELAY` |

用於修改已刪除使用者的到期延遲。以毫秒設定。

預設值： 90 天

| | `OVERLEAF_PROJECT_HARD_DELETION_DELAY` |

用於修改已刪除專案的到期延遲。以毫秒設定。

預設值： 90 天

| | `MAX_UPLOAD_SIZE` |

控制單次上傳的最大大小，單位為 MB。預設為 50.

注意：此變數僅為原始數字，不含單位（MB）或包裝。

| | `COMPILE_SIZE_LIMIT` | 控制以位元組為單位的最大請求本文大小。這是專案中所有文件檔案大小總和（`main.tex`, `references.bib` （如果未連結）等），需要在初始編譯請求中傳送至 CLSI 服務。 | | `COMPILE_TIMEOUT` | 可完成編譯的允許時間，以秒為單位。更多資訊請參閱 [更新專案編譯逾時](broken://pages/ea534604b7f9979184625d6c5bd915b54c22125c#updating-project-compile-timeout). | | `MAX_RECONNECT_GRACEFULLY_INTERVAL_MS` | 可在編輯器順利重新連線、資料刷新與容器關閉之間設定延遲，以降低資料遺失風險。 | | `SECCOMP_PROFILE` |

將此環境變數設定為 Docker 主機 上指向 SECCOMP 設定檔的路徑。您可以在 這裡。

目前在使用沙盒化編譯時，Podman 部署需要此設定。

| | `OVERLEAF_DISABLE_CHAT` | 如果設定為 `true`，將停用專案內聊天功能。 | | `OVERLEAF_LOGIN_SUPPORT_TEXT` | 設定後，可用來在登入按鈕下方顯示支援資訊。文字會顯示在登入畫面上，可用來引導使用者至內部支援，或提供與登入、建立帳戶等相關的指引。 | | `ALLOW_MONGO_ADMIN_CHECK_FAILURES` |

如果設定為 true，允許 MongoDB 啟動檢查失敗，且不會阻止部署啟動。如果您使用的 MongoDB 資料庫中，資料庫使用者沒有 clusterParameterReader 角色。

如需建立自訂角色的協助，請參閱 這裡.

| | `V1_HISTORY_URL_FOR_GIT_BRIDGE` | 可將 **history-v1** 內部流量的端點（`web` 服務 → `history-v1` 服務，兩者都在 `sharelatex` 容器）與外部流量（`git-bridge` → `history-v1`，分別在不同容器中執行）。 | | `OVERLEAF_MAINTENANCE_MESSAGE` 以及 `OVERLEAF_MAINTENANCE_MESSAGE_HTML` | 可用來自訂維護頁面的標題與內容。不能與 `OVERLEAF_STATUS_PAGE_URL`. | {% hint style="info" %} 在使用 Overleaf 登入系統（本機帳戶）時，可對使用者強制套用密碼限制，而非像 LDAP 這類 SSO 選項。對於 SSO 帳戶，密碼政策將由您的識別提供者或目錄服務強制執行，並另外支援多因素驗證。 {% endhint %} --- # 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/environment-variables.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.