获取帮助

医生

Overleaf 工具包附带一个方便的 doctor（诊断） 脚本以帮助调试。运行 bin/doctor 脚本将打印有关主机环境、配置以及工具包所需依赖项的信息。该输出也可以帮助 Overleaf 支持团队诊断 Server Pro 安装的问题。

Overleaf Pro 的用户可以 在 GitHub 上打开 issue（问题）.

在消息中包含 bin/doctor 脚本的输出是一个好主意。

咨询医生（诊断）

运行 doctor 脚本：

运行 doctor

bin/doctor

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

完整输出示例

====== Overleaf 医生 ======
- 主机信息
    - Linux
    - 'lsb_release -a' 的输出：
            没有可用的 LSB 模块。
            发行商 ID:	Ubuntu
            描述:	Ubuntu 22.04.5 LTS
            发行版本:	22.04
            代号:	jammy
- 依赖项
    - bash
        - 状态: 存在
        - 版本信息: 5.1.16(1)-release
    - docker
        - 状态: 存在
        - 版本信息: Docker version 28.0.4, build b8034c0
    - docker compose
        - 状态: 存在
        - 版本信息: Docker Compose version 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

====== 警告 ======
- 无，全部良好
====== 结束 ======

主机信息

此 主机信息 部分包含有关运行工具包的机器的信息（例如，Linux 发行版和版本）。

主机信息输出示例

- 主机信息
    - Linux
    - 'lsb_release -a' 的输出：
            没有可用的 LSB 模块。
            发行商 ID:	Ubuntu
            描述:	Ubuntu 22.04.5 LTS
            发行版本:	22.04
            代号:	jammy

依赖项

此 依赖项 部分列出工具包正常工作所需的工具。如果某个工具存在，它将被列为 状态: 存在 并带有版本信息。如果缺失，它将被列为 状态: 缺失！ 并且在 doctor（诊断） 输出底部会添加一个警告。

依赖项输出示例（存在）

- docker
    - 状态: 存在
    - 版本信息: Docker version 28.0.4, build b8034c0

依赖项输出示例（缺失）

- docker
    - 状态: 缺失！

如果有任何依赖项缺失，工具包几乎肯定无法工作。

配置

此 配置 部分包含有关 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 意味着工具包不会自行提供 MongoDB；如果需要，请确保 MONGO_URL 指向外部托管的 MongoDB。

• config/variables.env 在示例中缺失。

警告

此 警告 部分总结了 doctor 脚本发现的问题。如果没有问题，该部分会指出这一点。

警告输出示例

====== 警告 ======
- 未找到配置文件 variables.env
- rc 文件，未设置 OVERLEAF_DATA_PATH
====== 结束 =======