> 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-cn/zhi-chi/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 脚本：
{% 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 守护进程
- 状态：运行中
====== 配置 ======
- 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
- 状态：缺失！
```
以上示例中的说明：
* `文件中，或者在` 设置为 `/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://ayakaleaf-pro.ayaka.space/on-premises/zh-cn/zhi-chi/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.