> 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/zhi-yuan/getting-help.md).

# 取得協助

### 博士

Overleaf Toolkit 附帶一個方便的 `doctor` 腳本，可協助除錯。執行 `bin/doctor` ，腳本就會印出有關您的主機環境、您的設定，以及 Toolkit 所需相依性的資訊。這些輸出也能協助 Overleaf 支援團隊診斷 Server Pro 安裝的問題。

{% hint style="info" %}
Overleaf Pro 的使用者可以 [在 GitHub 上開啟問題回報](https://github.com/ayaka-notes/overleaf/issues).

在您的訊息中包含 `bin/doctor` 腳本的輸出會是個好主意。
{% endhint %}

### 與 Doctor 諮詢 <a href="#consulting-with-the-doctor" id="consulting-with-the-doctor"></a>

執行 doctor 腳本：

{% code title="執行 doctor" %}

```bash
bin/doctor
```

{% endcode %}

您會看到類似下方範例的輸出。

<details>

<summary>完整輸出範例</summary>

```
====== 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 常駐程式
    - 狀態：啟動中
====== 設定 ======
- 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

====== 警告 ======
- 無，一切正常
====== 結束 ======
```

</details>

### 主機資訊

該 `主機資訊` 區段包含執行 Toolkit 的機器資訊（例如 Linux 發行版與版本）。

<details>

<summary>主機資訊輸出範例</summary>

```
- 主機資訊
    - Linux
    - 'lsb_release -a' 的輸出：
            沒有可用的 LSB 模組。
            發行版 ID：	Ubuntu
            描述：	Ubuntu 22.04.5 LTS
            版本：	22.04
            代號：	jammy
```

</details>

### 相依性

該 `相依性` 區段列出 Toolkit 運作所需的工具。如果某工具已安裝，會列為 `狀態：已存在` 並附上版本資訊。如果缺少，則會列為 `狀態：缺少！` ，並且會在 `doctor` 輸出的底部加上一則警告。

<details>

<summary>相依性輸出範例（已存在）</summary>

```
- docker
    - 狀態：已存在
    - 版本資訊：Docker 版本 28.0.4，建置 b8034c0
```

</details>

<details>

<summary>相依性輸出範例（缺少）</summary>

```
- docker
    - 狀態：缺少！
```

</details>

如果有任何相依性缺少，Toolkit 幾乎肯定無法運作。

### 設定

該 `設定` 區段包含 `config/` 目錄中檔案的資訊。對於 `config/overleaf.rc`，doctor 會印出一些關鍵值。缺少的檔案會列為 `狀態：缺少！` ，並且會在 `doctor` 輸出的底部加上一則警告。

<details>

<summary>設定輸出範例</summary>

```
====== 設定 ======
- 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
    - 狀態：缺少！
```

</details>

上方範例的注意事項：

* `OVERLEAF_DATA_PATH` 設為 `/tmp/overleaf` 可能不是重要資料的安全位置。
* `MONGO_ENABLED: false` 表示 Toolkit 不會自行建立 MongoDB；如有需要，請確保 `MONGO_URL` 指向由外部管理的 MongoDB。
* `config/variables.env` 在範例中缺少。

### 警告

該 `警告` 區段摘要 doctor 腳本發現的問題。如果沒有任何問題，這個區段會指出這一點。

<details>

<summary>警告輸出範例</summary>

```
====== 警告 ======
- 找不到設定檔 variables.env
- rc 檔案未設定 OVERLEAF_DATA_PATH
====== 結束 =======
```

</details>


---

# 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/zhi-yuan/getting-help.md?ask=<question>&goal=<endgoal>
```

`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.
