The Doctor
The Overleaf Toolkit comes with a handydoctor 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
Example full output
Example full output
Host Information
TheHost Information section contains information about the machine running the Toolkit (for example, Linux distribution and release).
Example Host Information output
Example Host Information output
Dependencies
TheDependencies 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.
Example Dependency output (present)
Example Dependency output (present)
Example Dependency output (missing)
Example Dependency output (missing)
Configuration
TheConfiguration 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.
Example Configuration output
Example Configuration output
OVERLEAF_DATA_PATHset to/tmp/overleafmay not be a safe location for important data.MONGO_ENABLED: falsemeans the Toolkit will not provision its own MongoDB; ensureMONGO_URLpoints to an externally managed MongoDB if needed.config/variables.envis missing in the example.
Warnings
TheWarnings section summarizes problems discovered by the doctor script. If there are no problems, this section will indicate that.
Example Warnings output
Example Warnings output
Q&A
Do the quay.io, Docker config and Perl locale messages from bin/doctor need fixing?
Do the quay.io, Docker config and Perl locale messages from bin/doctor need fixing?
Answer: No, all three are informational.
bin/doctor only prints a report, it does not stop bin/up.logged in to quay.io: falseand the warningServer 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. WithSERVER_PRO=true, the Toolkit pullsghcr.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 forquay.ioin that file. Docker writes it only when it has settings to save, for example afterdocker login, so it is missing on many servers. It is not needed.perl: warning: Setting locale failed: the Toolkit usesperlonly here, inbin/doctor, to print its version, and Perl warns whenLANGorLC_ALLnames a locale that is not installed on the host. The version is still printed. To silence it, set these variables to a locale listed bylocale -a, for exampleC.UTF-8.
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.
