Software requirements
Operating systems
For the best experience when running Overleaf, we highly recommend using a Debian-based operating system, such as Ubuntu. This choice aligns with the software's development environment and is the preferred option among the majority of Overleaf users.
When using Server Pro with Sandboxed Compiles, it's important to note that the application requires root access to the Docker socket.
Dependencies
Both Server CE and Server Pro currently support the following versions of dependencies:
Docker 25.0 and 28.3+
MongoDB 6.0
Redis 6.2
MongoDB and Redis are automatically pulled by docker compose
when running Server CE or Server Pro, unless configured to use a different installation.
The Toolkit depends on the following programs:
bash
Docker
docker compose
is required and is generally installed with Docker.
We recommend that you install the most recent version of Docker that is available for your operating system.
Once Docker is installed correctly, you should be able to run these commands without error:
# Shows the installed Docker version
docker --version
# docker compose plugin (v2)
docker compose version
# List the running Docker containers on your system
docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
b1fadcd1dcb1 quay.io/sharelatex/sharelatex-pro:5.4.0 "/sbin/my_init" 23 hours ago Up About a minute 0.0.0.0:80->80/tcp sharelatex
7900ebb9ebb8 redis:6.2 "docker-entrypoint.s…" 45 hours ago Up About a minute 6379/tcp redis
fbd49d420e59 mongo:6.0 "docker-entrypoint.s…" 45 hours ago Up About a minute (healthy) 27017/tcp mongo
The Toolkit includes a handy bin/doctor
script that produces a report pointing to any unfulfilled dependency.
Last updated
Was this helpful?