跳转到主要内容

Doctor 脚本

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

使用 Doctor 进行诊断

运行 doctor 脚本:
Run doctor
你将看到类似下面示例的输出。

主机信息

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

依赖项

Dependencies 部分列出了 Toolkit 运行所需的工具。如果某个工具存在,会显示为 status: present 并附带版本信息;如果缺失,则会显示为 status: MISSING!,并在 doctor 输出的末尾添加一条警告。
如果缺少任何依赖项,Toolkit 几乎肯定无法正常工作。

配置

Configuration 部分包含有关 config/ 目录中文件的信息。对于 config/overleaf.rc,doctor 会打印一些关键值。缺失的文件会显示为 status: MISSING!,并在 doctor 输出的末尾添加一条警告。
关于上述示例的说明:
  • 将 OVERLEAF_DATA_PATH 设置为 /tmp/overleaf 可能不是存放重要数据的安全位置。
  • MONGO_ENABLED: false 表示 Toolkit 不会创建自己的 MongoDB;如有需要,请确保 MONGO_URL 指向外部管理的 MongoDB。
  • 示例中缺少 config/variables.env。

警告

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

Q&A

回答:不需要,这三项都只是提示信息。bin/doctor 只会打印一份报告,不会阻止 bin/up。
  • logged in to quay.io: false 以及警告 Server Pro enabled, but not logged in to quay.io repository:此检查来自官方 Toolkit,在官方 Toolkit 中 Server Pro 镜像位于私有的 quay.io 仓库。当 SERVER_PRO=true 时,Toolkit 会拉取公开的 ghcr.io/ayaka-notes/overleaf-pro,因此无需登录。请忽略此警告。
  • grep: /root/.docker/config.json: No such file or directory(或其他主目录):quay.io 检查会在该文件中查找 quay.io。Docker 只有在有设置需要保存时才会写入该文件,例如执行 docker login 之后,因此许多服务器上都没有该文件。它并不是必需的。
  • perl: warning: Setting locale failed:Toolkit 仅在 bin/doctor 中使用 perl 来打印其版本,当 LANG 或 LC_ALL 指定的 locale 未安装在主机上时,Perl 就会发出警告。版本仍会正常打印。如需消除该警告,请将这些变量设置为 locale -a 列出的某个 locale,例如 C.UTF-8。
而 Docker daemon is not running、docker not found、Docker Compose not found 或 config/ 中缺少文件之类的警告则需要修复:缺少它们,Toolkit 就无法启动。
最后修改于 2026年11月2日