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