Skip to main content

The Doctor

The Overleaf Toolkit comes with a handy doctor script to help with debugging. Run bin/doctor and the script will print information about your host environment, your configuration, and the dependencies the Toolkit needs. This output can also help the us diagnose issues for your Ayakaleaf Pro installations.
Users of the Overleaf Pro can open an issue on GitHub.it is a good idea to include the output of the bin/doctor script in your message.

Consulting with the Doctor

Run the doctor script:
Run doctor
You will see output similar to the example below.

Host Information

The Host Information section contains information about the machine running the Toolkit (for example, Linux distribution and release).

Dependencies

The Dependencies section lists tools required for the Toolkit to work. If a tool is present it will be listed as status: present with version info. If missing it will be listed as status: MISSING! and a warning will be added to the bottom of the doctor output.
If any dependencies are missing, the Toolkit will almost certainly not work.

Configuration

The Configuration section contains information about files in the config/ directory. For config/overleaf.rc, the doctor prints some key values. Missing files will be listed as status: MISSING! and a warning will be added to the bottom of the doctor output.
Notes from the example above:
  • OVERLEAF_DATA_PATH set to /tmp/overleaf may not be a safe location for important data.
  • MONGO_ENABLED: false means the Toolkit will not provision its own MongoDB; ensure MONGO_URL points to an externally managed MongoDB if needed.
  • config/variables.env is missing in the example.

Warnings

The Warnings section summarizes problems discovered by the doctor script. If there are no problems, this section will indicate that.

Q&A

Answer: No, all three are informational. bin/doctor only prints a report, it does not stop bin/up.
  • logged in to quay.io: false and the warning Server Pro enabled, but not logged in to quay.io repository: this check comes from the official Toolkit, where the Server Pro image is on a private quay.io registry. With SERVER_PRO=true, the Toolkit pulls ghcr.io/ayaka-notes/overleaf-pro, which is public, so no login is needed. Ignore this warning.
  • grep: /root/.docker/config.json: No such file or directory (or another home directory): the quay.io check looks for quay.io in that file. Docker writes it only when it has settings to save, for example after docker login, so it is missing on many servers. It is not needed.
  • perl: warning: Setting locale failed: the Toolkit uses perl only here, in bin/doctor, to print its version, and Perl warns when LANG or LC_ALL names a locale that is not installed on the host. The version is still printed. To silence it, set these variables to a locale listed by locale -a, for example C.UTF-8.
Warnings such as Docker daemon is not running, docker not found, Docker Compose not found or a missing file in config/ do need fixing: the Toolkit cannot start without them.
Last modified on October 30, 2026