> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取帮助

### Doctor 脚本

Overleaf Toolkit 附带一个便捷的 `doctor` 脚本，用于辅助调试。运行 `bin/doctor`，该脚本会打印有关你的宿主机环境、配置以及 Toolkit 所需依赖项的信息。这些输出也可以帮助我们诊断你的 Ayakaleaf Pro 安装中的问题。

<Info>
  Overleaf Pro 用户可以[在 GitHub 上提交 issue](https://github.com/ayaka-notes/overleaf/issues)。

  建议在你的消息中附上 `bin/doctor` 脚本的输出。
</Info>

### 使用 Doctor 进行诊断

运行 doctor 脚本：

```bash title="Run doctor" theme={null}
bin/doctor
```

你将看到类似下面示例的输出。

<Accordion title="完整输出示例">
  ```text theme={null}
  ====== Overleaf Doctor ======
  - Host Information
      - Linux
      - Output of 'lsb_release -a':
              No LSB modules are available.
              Distributor ID:	Ubuntu
              Description:	Ubuntu 22.04.5 LTS
              Release:	22.04
              Codename:	jammy
  - Dependencies
      - bash
          - status: present
          - version info: 5.1.16(1)-release
      - docker
          - status: present
          - version info: Docker version 28.0.4, build b8034c0
      - docker compose
          - status: present
          - version info: Docker Compose version v2.34.0
      - realpath
          - status: present
          - version info: realpath (GNU coreutils) 8.32
      - perl
          - status: present
          - version info: 5.034000
      - awk
          - status: present
          - version info: mawk 1.3.4 20200120
  - Docker Daemon
      - status: up
  ====== Configuration ======
  - config/version
      - status: present
      - version: 5.4.0
  - config/overleaf.rc
      - status: present
      - values
          - OVERLEAF_DATA_PATH: data/overleaf
          - OVERLEAF_LOG_PATH: data/overleaf/logs
          - SERVER_PRO: true
          - SIBLING_CONTAINERS_ENABLED: true
              - logged in to quay.io: true
          - MONGO_ENABLED: true
          - REDIS_ENABLED: true
  - config/variables.env
      - status: present
      - values
          - OVERLEAF_FILESTORE_BACKEND: fs
          - OVERLEAF_HISTORY_BACKEND: fs

  ====== Warnings ======
  - None, all good
  ====== End ======
  ```
</Accordion>

### 主机信息

`Host Information` 部分包含运行 Toolkit 的机器的信息（例如 Linux 发行版及其版本）。

<Accordion title="主机信息输出示例">
  ```text theme={null}
  - Host Information
      - Linux
      - Output of 'lsb_release -a':
              No LSB modules are available.
              Distributor ID:	Ubuntu
              Description:	Ubuntu 22.04.5 LTS
              Release:	22.04
              Codename:	jammy
  ```
</Accordion>

### 依赖项

`Dependencies` 部分列出了 Toolkit 运行所需的工具。如果某个工具存在，会显示为 `status: present` 并附带版本信息；如果缺失，则会显示为 `status: MISSING!`，并在 `doctor` 输出的末尾添加一条警告。

<Accordion title="依赖项输出示例（存在）">
  ```text theme={null}
  - docker
      - status: present
      - version info: Docker version 28.0.4, build b8034c0
  ```
</Accordion>

<Accordion title="依赖项输出示例（缺失）">
  ```text theme={null}
  - docker
      - status: MISSING!
  ```
</Accordion>

如果缺少任何依赖项，Toolkit 几乎肯定无法正常工作。

### 配置

`Configuration` 部分包含有关 `config/` 目录中文件的信息。对于 `config/overleaf.rc`，doctor 会打印一些关键值。缺失的文件会显示为 `status: MISSING!`，并在 `doctor` 输出的末尾添加一条警告。

<Accordion title="配置输出示例">
  ```text theme={null}
  ====== Configuration ======
  - config/version
      - status: present
      - version: 5.4.0
  - config/overleaf.rc
      - status: present
      - values
          - OVERLEAF_DATA_PATH: /tmp/overleaf
          - SERVER_PRO: false
          - MONGO_ENABLED: false
          - REDIS_ENABLED: true
  - config/variables.env
      - status: MISSING!
  ```
</Accordion>

关于上述示例的说明：

* 将 `OVERLEAF_DATA_PATH` 设置为 `/tmp/overleaf` 可能不是存放重要数据的安全位置。
* `MONGO_ENABLED: false` 表示 Toolkit 不会创建自己的 MongoDB；如有需要，请确保 `MONGO_URL` 指向外部管理的 MongoDB。
* 示例中缺少 `config/variables.env`。

### 警告

`Warnings` 部分汇总了 doctor 脚本发现的问题。如果没有问题，该部分也会注明。

<Accordion title="警告输出示例">
  ```text theme={null}
  ====== Warnings ======
  - configuration file variables.env not found
  - rc file, OVERLEAF_DATA_PATH not set
  ====== End =======
  ```
</Accordion>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.