Skip to main content
1

Container settings

Edit these existing entries in config/overleaf.rc:
config/overleaf.rc
Keep the default data paths and the bundled MongoDB and Redis services. With OVERLEAF_LISTEN_IP=127.0.0.1, only browsers on this Mac can open the instance.
2

Application settings

In config/variables.env, set these values, replacing any active entries with the same names:
config/variables.env
Generate a session secret:
Add the result as OVERLEAF_SESSION_SECRET in config/variables.env. Without it, every bin/up that recreates the container logs all users out, see Environment Variables.For a local instance without email, leave the SMTP settings and OVERLEAF_EMAIL_FROM_ADDRESS unset. Git Bridge, external authentication and the other integrations can be added later with their own configuration pages.
3

Check the Docker VM's Linux kernel

MongoDB runs on the Linux kernel of Docker Desktop’s virtual machine, not on macOS. Check its version before the first start:
MongoDB documents an incompatibility with Linux kernels 6.19 through 7.0.13, which also affects MongoDB in Docker. The fix is a kernel 7.0.14 or later, which comes with a Docker Desktop update, see MongoDB’s production notes.The tested Docker Desktop used 7.0.12-linuxkit. On that kernel, MongoDB started with the following setting. Add it to config/docker-compose.override.yml, merged with any services you already have there:
config/docker-compose.override.yml
This is a workaround verified on the tested configuration, not a replacement for the kernel update that MongoDB recommends. If your kernel is outside the affected range, do not add it just because you use macOS.
4

Start your instance

From the Toolkit directory, run:
The Toolkit initializes MongoDB’s replica set, pulls the TeX Live image and starts the application. The first download takes a while. To follow the progress:
Press Ctrl+C to stop following the logs. The containers keep running.Check the published port and the first-run page:
The port should be 127.0.0.1:8080.
To open the instance from other computers later, change the listen address and site URL, and set up HTTPS, as described in 5. Personalizing your instance of the Linux guide. The Mac then has to stay awake, see Keep the instance available.

Next step

Continue with 6. Post-installation tasks.
Last modified on November 3, 2026