Skip to main content
It is important to ensure that you take a consistent backup before every major version upgrade to enable you to roll back should you require it.
The ayakaleaf toolkit↗ is a git repository, so it’s easy to get new Toolkit features. Just run the bin/upgrade command and follow the on-screen prompts. It is worth noting that the Docker image version (at config/version) is managed separately from the Toolkit code updates. Updating the Toolkit code will not automatically change the version of the Docker image that you are running. This means that in most cases, you are able to upgrade your Toolkit version without upgrading your deployment.

The bin/upgrade Script

When you run the bin/upgrade command, the script will check if there is an available update to the Toolkit code, and offer to update your Toolkit. You can always say no to this upgrade, and nothing will change. If you do choose to update the Toolkit code, the script will then check if the default Docker image version has changed, and offer to upgrade your local version file (at config/version) to match the new default. If you do choose to switch versions, the script will then walk you through a process of shutting down the Docker services, taking a backup, and restarting the Docker services. Your old version file will be automatically copied to config/__old-version, just in case you need to roll back to that version of the Docker images.
For air-gapped setups that manually import Docker images, please set PULL_BEFORE_UPGRADE=false in your config/overleaf.rc file.Please check here for more infomration on deploying in an air-gapped/offline environments.

Upgrade path

If you are running an earlier version of Overleaf Community before v6.0.0, refer to the official Overleaf documentation to complete the upgrade. Within Ayakaleaf Pro, upgrade to the latest patch release of your current version line first, then to the next one, for example 6.2.0 → 6.2.2 → 6.3.2. Read the release notes of every version you pass, some of them need extra steps. Only the latest release is supported. To check which image you run, use docker inspect --format '{{.Config.Image}}' sharelatex.

Q&A

Answer: It gives existing users the default features of your instance, such as the compile timeout set by COMPILE_TIMEOUT. It only raises values and never lowers them, so a user with a longer compile timeout keeps it. It is not part of an upgrade and never runs on its own; you only need it after raising a default such as COMPILE_TIMEOUT. By default it is a dry run that lists the users it would change; add --dry-run=false to save the changes:
Last modified on October 30, 2026