The Toolkit is the same on macOS and Linux. Its layout, the config/ directory and the bin/ commands are described in 2. Familiarize yourself with the Toolkit of the Linux guide.
On macOS, keep three differences in mind:
- Run the scripts from a terminal where GNU sed comes first on the
PATH, see 1. Download the Toolkit.
- Start Docker Desktop before you run a script that talks to Docker, such as
bin/up, bin/start or bin/docker-compose.
bin/doctor includes checks inherited from the official Overleaf Toolkit. Its This system seems to not be Linux warning is expected on macOS, and its warning about not being logged in to quay.io does not apply to the public ghcr.io/ayaka-notes/overleaf-pro image. Other problems in the report still matter.
Next step
Continue with 3. Initialize the configuration. Last modified on November 3, 2026
