環境變數

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

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

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

​

所有版本

這些環境變數相容於 Server CE 與 Server Pro，讓您可以輕鬆在這兩種地端版本之間遷移。它們也同時適用於 Toolkit 與 Docker Compose 部署。

這些環境變數先前使用的前綴是 SHARELATEX_，而非 OVERLEAF_。

名稱	說明
OVERLEAF_SITE_URL	您的 Overleaf 執行個體對外公開的位址。此值會用於公開連結以及 websocket 連線，因此必須正確設定！
OVERLEAF_ADMIN_EMAIL	使用者可用來聯絡網站管理者的電子郵件地址。
OVERLEAF_APP_NAME	提及執行中應用程式時所顯示的名稱。預設為 ‘Overleaf (Community Edition)‘。
OVERLEAF_MONGO_URL 與 MONGO_URL	要使用的 Mongo 資料庫 URL。
OVERLEAF_REDIS_HOST 與 REDIS_HOST	要使用的 Redis 執行個體主機名稱。兩者皆為必填（請參閱版本資訊）。
OVERLEAF_REDIS_PORT 與 REDIS_PORT	要使用的 Redis 執行個體連接埠。兩者皆為必填（請參閱版本資訊）。
OVERLEAF_REDIS_PASS 與 REDIS_PASSWORD	連線至 Redis 時使用的密碼（若適用）。兩個環境變數都必須設定。詳細資訊請參閱啟用密碼驗證。
OVERLEAF_REDIS_TLS	若設為 true，則允許連線至需要 TLS 的 Redis 執行個體。 注意：目前不支援 mTLS。
OVERLEAF_NAV_TITLE	設定應用程式的分頁標題。
OVERLEAF_HEADER_IMAGE_URL_LIGHT 與 OVERLEAF_HEADER_IMAGE_URL_DARK	淺色與深色主題的自訂頁首標誌 URL（於 6.3.0 新增）。當某主題的專屬變數未設定時，會改用 OVERLEAF_HEADER_IMAGE_URL。請參閱 Branding。
OVERLEAF_LINKED_URL_OUTBOUND_PROXY	HTTP(S) proxy 的 URL，用於擷取外部連結檔案，以及透過 Open in Overleaf API 取得外部 ZIP 或 TeX 資源。自重新發布的 Ayakaleaf Pro 6.3.0（2026 年 10 月 3 日）起提供。若不設定則直接連線。範例：OVERLEAF_LINKED_URL_OUTBOUND_PROXY=http://proxy.internal:3128。設定方式與網路存取限制請參閱 Outbound Proxy。
OVERLEAF_INVITE_TOKEN_SECRET	必填。用於保護專案分享 token 的隨機字串（於 Server Pro 6.2.0 新增）。 最少字元數：16
OVERLEAF_SESSION_SECRET	用於保護 token 的隨機字串；若有進行負載平衡，所有主機都必須設定相同的值。若只執行 1 個執行個體，則使用者不需要自行設定。
OVERLEAF_COOKIE_SESSION_LENGTH	可讓您覆寫預設 5 天的工作階段 cookie 有效期限。覆寫值的單位為毫秒。範例：若要讓工作階段持續 1 小時，請設定 COOKIE_SESSION_LENGTH=3600000。（於 Server Pro 4.2 新增）
OVERLEAF_TRUSTED_PROXY_IPS	若未設定，預設為 loopback。若手動設定，除了您信任的 IP 之外，還必須包含 loopback（或 127.0.0.1），以信任在 sharelatex 容器內執行的 nginx 執行個體。僅接受 IP 位址與 CIDR 範圍：請勿加入 localhost 之類的主機名稱，否則 Overleaf 將無法啟動並回傳 502 Bad Gateway。 如果您的一般網路使用 172.16.0.0/12（Docker 網路的預設子網路）中的子網路，請在 config/variables.env 中設定 OVERLEAF_TRUSTED_PROXY_IPS=loopback,<network>。其中 <network> 是 docker inspect overleaf_default 中 IPAM -> Config -> Subnet 的值，例如 OVERLEAF_TRUSTED_PROXY_IPS=loopback,172.19.0.0/16。這是為了防止 X-Forwarded 標頭遭到偽造。 如果您使用外部 TLS proxy（亦即不由 Overleaf Toolkit 管理），請確認已設定 OVERLEAF_TRUSTED_PROXY_IPS=loopback,<ip-of-your-tls-proxy>，例如 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，將允許匿名使用者檢視與編輯透過連結分享功能所分享的專案。
OVERLEAF_DISABLE_LINK_SHARING	停用連結分享功能。
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' 可避免新專案以 Full Project History 初始化（於 Server Pro 3.5.0 新增）。
OVERLEAF_FPH_DISPLAY_NEW_PROJECTS	設為 'false' 可避免新專案顯示 Full Project History 而非舊版歷史記錄（於 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）或任何包裝。 上傳的 .zip 檔案解壓縮後的總大小上限為此值的 6 倍（預設為 300 MB）。
COMPILE_SIZE_LIMIT	控制請求主體的大小上限，單位為位元組。這是專案中所有文件檔案大小的總和（main.tex、references.bib（若非連結檔案）等），這些檔案需要在初始編譯請求中傳送給 CLSI 服務。
COMPILE_TIMEOUT	允許一次編譯完成的時間，單位為秒。詳細資訊請參閱更新專案編譯逾時。
MAX_RECONNECT_GRACEFULLY_INTERVAL_MS	可設定編輯器正常重新連線、資料寫入與容器關閉之間的延遲時間，以降低資料遺失的風險。
SECCOMP_PROFILE	將此環境變數設為 Docker 主機上指向 SECCOMP 設定檔的路徑。您可以在這裡下載設定檔的副本。 目前在 Podman 部署中使用 Sandboxed Compiles 時需要此設定。
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 同時使用。

使用 Overleaf 登入系統（本機帳號）而非 LDAP 等 SSO 選項時，可以對使用者強制執行密碼限制。對於 SSO 帳號，密碼原則將由您的身分提供者或目錄服務強制執行，並可額外支援多重要素驗證。