Overleaf Toolkit

Getting Started

See the Quick Start Guide.

Doctor

Run bin/doctor for debug output

Docker Compose Wrappers

The bin/docker-compose script is a wrapper around docker-compose, and automatically loads the project configuration. bin/up, bin/start, etc, are convenience wrappers around bin/docker-compose.

Config files

• config/overleaf.rc
• config/variables.env
• config/version

If config/docker-compose.override.yml is present, it will also be loaded.

Docker Compose files

• lib/docker-compose.base.yml
• lib/docker-compose.mongo.yml
• lib/docker-compose.redis.yml
• lib/docker-compose.sibling-containers.yml

overleaf.rc

The config/overleaf.rc file controls top-level configuration, such as the docker image to use, data paths, etc. This is used to configure the invocaton to docker-compose.

variables.env

Environment variables loaded in the overleaf container as application settings.

Data directories (default)

• data/mongo
• data/redis
• data/sharelatex

All are persisted outside of the containers.

These can be changed by setting MONGO_DATA_PATH (etc) in overleaf.rc

How To

Update to the latest version

• Run bin/upgrade, and follow the instructions
  • This will fetch any available code updates and offer to upgrade the locally configured docker image version, if a new version is available

Switch to Server Pro

• In overleaf.rc, set SERVER_PRO=true

Change Image

• Change the contents of config/version

Using an external mongo/redis

• Mongo
  • Set MONGO_ENABLED=false, and MONGO_URL=... in overleaf.rc
• Redis
  • Set REDIS_ENABLED=false, and REDIS_HOST=... and/or REDIS_PORT=... in overleaf.rc

Using Sibling-Containers

• In overleaf.rc set SIBLING_CONTAINERS_ENABLED=true
• In overleaf.rc, ensure DOCKER_SOCKET_PATH is set