Skip to main content
本頁說明 Toolkit 用來設定你本地部署 Overleaf 的各個設定檔。

持久性資料

Overleaf Toolkit 需要儲存持久性資料,例如編譯 LaTeX 專案所需的檔案,以及 MongoDB 資料庫的內容。這是透過將主機上的幾個目錄掛載到 Docker 容器中,並將資料寫入這些目錄來達成的。

資料目錄

sharelatex 容器需要一個目錄來儲存與 LaTeX 編譯相關的資料。此目錄由 config/overleaf.rc 中的 OVERLEAF_DATA_PATH 變數設定。 若啟用了 mongo 容器,它需要一個目錄來儲存資料庫檔案,redis 容器亦同。這些目錄同樣可以在 config/overleaf.rc 中設定。

檔案權限

由於 Docker 以 root 身分執行,即使 Toolkit 是由非 root 使用者使用,資料目錄最終仍會歸 root 使用者所有。這不會造成問題,但如果你打算從容器外部修改持久性資料,就值得留意這一點。

設定檔位置

所有使用者擁有的設定檔都位於 config/ 目錄中。 此目錄已從 git 版本控制系統中排除,因此更新 Toolkit 程式碼時不會變更它。未經你的許可,Toolkit 不會變更 config/ 目錄中的任何資料。
即使停止並重新啟動容器(使用 bin/stop 與 bin/start),對設定檔所做的變更也不會自動套用到現有容器。若要套用變更,請執行 bin/up,docker compose 會在背後自動將設定變更套用到新的容器。(如果你不想附加到 Docker 日誌,也可以執行 bin/up -d。)

overleaf.rc 檔案

config/overleaf.rc 檔案包含 Toolkit 所使用的最重要的頂層設定。其中包含以 VARIABLE_NAME=value 格式設定變數的陳述式。 若要查看所有可用設定選項的詳細說明,請參閱我們的設定章節。

variables.env 檔案

config/variables.env 檔案包含會載入至 sharelatex 容器的環境變數,用於設定 Overleaf 的各個微服務。這些設定包括顯示在網頁介面頁首的應用程式名稱、寄送電子郵件的設定,以及其他進階設定,例如搭配 Server Pro 使用的 SSO。 若要查看所有可用環境變數的詳細說明,請參閱環境變數章節。

version 檔案

config/version 檔案包含 Docker 映像檔的版本號碼,該映像檔將用於建立你 Overleaf 伺服器的執行個體。
即使停止並重新啟動容器(使用 bin/stop 與 bin/start),對這些設定檔所做的變更也不會自動套用到現有容器。若要套用你的變更,請執行 bin/up,Toolkit 會自動為你建立一個已套用設定變更的新容器。

docker-compose.override.yml 檔案

若 config/docker-compose.override.yml 檔案存在,它會被納入 docker compose 的呼叫中。這對於覆寫 Docker Compose 專屬的設定很有用。 詳細資訊請參閱 docker-compose 文件。
最後修改於 2026年10月5日