Doctor 診斷工具
Overleaf Toolkit 附帶一個方便的doctor 腳本,可協助偵錯。執行 bin/doctor 後,該腳本會列印出你的主機環境、設定,以及 Toolkit 所需相依項目的相關資訊。這些輸出也能協助我們診斷你的 Ayakaleaf Pro 安裝所遇到的問題。
Overleaf Pro 的使用者可以在 GitHub 上提出 issue。建議在你的訊息中附上
bin/doctor 腳本的輸出內容。執行 Doctor 診斷
執行 doctor 腳本:Run doctor
完整輸出範例
完整輸出範例
主機資訊
Host Information 區段包含執行 Toolkit 之機器的相關資訊(例如 Linux 發行版與版本)。
主機資訊輸出範例
主機資訊輸出範例
相依項目
Dependencies 區段列出 Toolkit 運作所需的工具。若工具存在,會標示為 status: present 並附上版本資訊;若缺少,則會標示為 status: MISSING!,並在 doctor 輸出的最下方加入一則警告。
相依項目輸出範例(存在)
相依項目輸出範例(存在)
相依項目輸出範例(缺少)
相依項目輸出範例(缺少)
設定
Configuration 區段包含 config/ 目錄中檔案的相關資訊。對於 config/overleaf.rc,doctor 會列印出一些關鍵值。缺少的檔案會標示為 status: MISSING!,並在 doctor 輸出的最下方加入一則警告。
設定輸出範例
設定輸出範例
OVERLEAF_DATA_PATH設為/tmp/overleaf,可能不是存放重要資料的安全位置。MONGO_ENABLED: false表示 Toolkit 不會自行佈建 MongoDB;如有需要,請確保MONGO_URL指向外部管理的 MongoDB。- 範例中缺少
config/variables.env。
警告
Warnings 區段彙整了 doctor 腳本發現的問題。若沒有任何問題,此區段也會加以說明。
警告輸出範例
警告輸出範例
問與答
bin/doctor 輸出的 quay.io、Docker 設定與 Perl 語系訊息需要修正嗎?
bin/doctor 輸出的 quay.io、Docker 設定與 Perl 語系訊息需要修正嗎?
答:不需要,這三項都只是資訊性訊息。
bin/doctor 只會列印報告,並不會阻止 bin/up。logged in to quay.io: false以及警告Server Pro enabled, but not logged in to quay.io repository:此檢查來自官方 Toolkit,在官方 Toolkit 中,Server Pro 映像檔位於私有的 quay.io registry。設定SERVER_PRO=true時,Toolkit 會拉取公開的ghcr.io/ayaka-notes/overleaf-pro,因此不需要登入。請忽略此警告。grep: /root/.docker/config.json: No such file or directory(或其他家目錄):quay.io 檢查會在該檔案中尋找quay.io。Docker 只有在需要儲存設定時(例如執行docker login之後)才會寫入此檔案,因此許多伺服器上都沒有它。此檔案並非必要。perl: warning: Setting locale failed:Toolkit 只在bin/doctor這裡使用perl來列印其版本,而當LANG或LC_ALL指定的語系未安裝在主機上時,Perl 就會發出警告。版本仍會正常列印。若要消除此警告,請將這些變數設為locale -a所列出的語系,例如C.UTF-8。
Docker daemon is not running、docker not found、Docker Compose not found 或 config/ 中缺少檔案等警告則確實需要修正:缺少這些項目,Toolkit 將無法啟動。
