> 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/zhi-yuan/getting-help.md).
# 取得協助
### Doctor 工具
Overleaf Toolkit 附帶一個方便的 `doctor` 腳本，可協助除錯。執行 `bin/doctor` 後，腳本會列印關於您的主機環境、設定，以及 Toolkit 所需相依性的資訊。這些輸出也可協助 Overleaf 支援團隊為 Server Pro 安裝診斷問題。
{% hint style="info" %}
Overleaf Pro 的使用者可以 [在 GitHub 上開啟一個 issue](https://github.com/ayaka-notes/overleaf/issues).
建議在您的訊息中附上 `bin/doctor` 腳本的輸出。
{% endhint %}
### 使用 Doctor 進行診斷
執行 doctor 腳本：
{% code title="執行 doctor" %}
```bash
bin/doctor
```
{% endcode %}
您將會看到類似下方範例的輸出。
完整輸出範例
```
====== Overleaf Doctor ======
- 主機資訊
- Linux
- 「lsb_release -a」的輸出：
沒有可用的 LSB 模組。
發行版 ID: Ubuntu
描述: Ubuntu 22.04.5 LTS
版本: 22.04
代號: jammy
- 相依項
- bash
- 狀態：已存在
- 版本資訊：5.1.16(1)-release
- docker
- 狀態：已存在
- 版本資訊：Docker 版本 28.0.4，建置 b8034c0
- docker compose
- 狀態：已存在
- 版本資訊：Docker Compose 版本 v2.34.0
- realpath
- 狀態：已存在
- 版本資訊：realpath (GNU coreutils) 8.32
- perl
- 狀態：已存在
- 版本資訊：5.034000
- awk
- 狀態：已存在
- 版本資訊：mawk 1.3.4 20200120
- Docker Daemon
- 狀態：已啟動
====== 設定 ======
- config/version
- 狀態：已存在
- 版本：5.4.0
- config/overleaf.rc
- 狀態：已存在
- 值
- OVERLEAF_DATA_PATH: data/overleaf
- OVERLEAF_LOG_PATH: data/overleaf/logs
- SERVER_PRO: true
- SIBLING_CONTAINERS_ENABLED: true
- 已登入 quay.io: true
- MONGO_ENABLED: true
- REDIS_ENABLED: true
- config/variables.env
- 狀態：已存在
- 值
- OVERLEAF_FILESTORE_BACKEND: fs
- OVERLEAF_HISTORY_BACKEND: fs
====== 警告 ======
- 無，全部正常
====== 結束 ======
```
### 主機資訊
此 `主機資訊` 區段包含執行 Toolkit 的主機資訊（例如 Linux 發行版與版本）。
主機資訊輸出範例
```
- 主機資訊
- Linux
- 「lsb_release -a」的輸出：
沒有可用的 LSB 模組。
發行版 ID: Ubuntu
描述: Ubuntu 22.04.5 LTS
版本: 22.04
代號: jammy
```
### 相依性
此 `相依性` 區段列出 Toolkit 正常運作所需的工具。若工具已存在，會列為 `狀態：已存在` 並附上版本資訊。若缺少，會列為 `狀態：缺少！` ，並會在 `doctor` 輸出底部新增警告。
相依性輸出範例（已存在）
```
- docker
- 狀態：已存在
- 版本資訊：Docker 版本 28.0.4，建置 b8034c0
```
相依性輸出範例（缺少）
```
- docker
- 狀態：缺少！
```
如果缺少任何相依性，Toolkit 幾乎肯定無法正常運作。
### 設定
此 `設定` 區段包含位於 `config/` 目錄中的檔案資訊。對於 `config/overleaf.rc`，doctor 會列印一些關鍵值。缺少的檔案將列為 `狀態：缺少！` ，並會在 `doctor` 輸出底部新增警告。
設定輸出範例
```
====== 設定 ======
- config/version
- 狀態：已存在
- 版本：5.4.0
- config/overleaf.rc
- 狀態：已存在
- 值
- OVERLEAF_DATA_PATH: /tmp/overleaf
- SERVER_PRO: false
- MONGO_ENABLED: false
- REDIS_ENABLED: true
- config/variables.env
- 狀態：缺少！
```
以上範例中的注意事項：
* `OVERLEAF_DATA_PATH` 設定為 `/tmp/overleaf` 可能不是儲存重要資料的安全位置。
* `MONGO_ENABLED: false` 表示 Toolkit 不會自行配置 MongoDB；請確保 `MONGO_URL` 必要時指向外部管理的 MongoDB。
* `config/variables.env` 在範例中缺少。
### 警告
此 `警告` 區段總結 doctor 腳本發現的問題。若沒有問題，此區段會指出這一點。
警告輸出範例
```
====== 警告 ======
- 找不到設定檔 variables.env
- rc 檔未設定 OVERLEAF_DATA_PATH
====== 結束 =======
```
---
# 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/zhi-yuan/getting-help.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.