Getting help
Last updated
Was this helpful?
Last updated
Was this helpful?
The Overleaf Toolkit comes with a handy doctor script, to help with debugging. Just run bin/doctor and the script will print out information about your host environment, your configuration, and the dependencies the Toolkit needs. This output can also help the Overleaf support team to help you figure out what has gone wrong, in the case of a Server Pro installation.
Run the doctor script:
You will see some output like this:
The Host Information section contains information about the machine on which the Toolkit is running. This includes information about the type of Linux system being used.
The Dependencies section shows a list of tools which are required for the Toolkit to work. If the tool is present on the system, it will be listed as status: present, along with the version of the tool. For example:
However, if the tool is missing, it will be listed as status: MISSING!, and a warning will be added to the bottom of the doctor output. For example:
If any of the dependencies are missing, the Toolkit will almost certainly not work.
The Configuration section contains information about the files in the config/ directory. In the case of config/overleaf.rc, the doctor also prints out some of the more important values from the file. If any of the files are not present, they will be listed as status: MISSING!, and a warning will be added to the bottom of the doctor output. For example:
The above example shows a few problems:
The OVERLEAF_DATA_PATH variable is set to /tmp/overleaf, which is probably not a safe place to put important data
The MONGO_ENABLED variable is set to false, so the Toolkit will not provision it's own MongoDB database. In this case, we had better be sure to set MONGO_URL to point to a MongoDB database managed outside of the toolkit
the config/variables.env file is missing
The Warnings section shows a summary of problems discovered by the doctor script. Or, if there are no problems, this section will say so. For example: