Sets the value of the `--project-name` flag supplied to `docker-compose`. This is useful when running multiple instances of Overleaf on one host, as each instance can have a different project name.
- Default: `overleaf`
Docker image as used by the Server Pro/CE application container. This is just the Docker image name; the Docker image tag is sourced from `config/version`.
- Default:
- Server Pro: `ghcr.io/ayaka-notes/overleaf-pro`
- Community Edition: `sharelatex/sharelatex`
When set to `true`, tells the Toolkit to use the Server Pro image (`ghcr.io/ayaka-notes/overleaf-pro`), rather than the default Server CE image (`sharelatex/sharelatex`).
- Default: `false`
Set to `true` to enable the git-bridge feature (Server Pro only). For more information see the [https://www.overleaf.com/learn/how-to/Git\_integration](https://www.overleaf.com/learn/how-to/Git_integration) user documentation.
- Default: `false`
Docker image as used by the git-bridge container (Server Pro only). This is just the Docker image name; the Docker image tag is sourced from `config/version`.
- Default: `ghcr.io/ayaka-notes/overleaf-pro/git-bridge`
Configure the logging level of the `git-bridge` container. Available levels: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`.
- Default: `INFO`
When set to `true`, tells the Toolkit to use the Sibling Containers technique for compiling projects in separate sandboxes, using a separate Docker container for each project. See the \
- Requires: `SERVER_PRO=true`
- Default: `true`
When set to `true`, tells the Toolkit to automatically pull all TeX Live images set using `ALL_TEX_LIVE_DOCKER_IMAGES` in the config/variables.env file when using the `bin/up` command.
- Default: `true`
Sets the path to the Docker socket on the host machine (the machine running the Toolkit). When `SIBLING_CONTAINERS_ENABLED` is `true`, the socket will be mounted into the container to allow the compiler service to spawn new Docker containers on the host.
- Requires: `SIBLING_CONTAINERS_ENABLED=true`
- Default: `/var/run/docker.sock`
Sets the path to the directory that will be mounted into the main `sharelatex` container, and used to store compile data. This can be either a full path (beginning with a `/`), or relative to the base directory of the Toolkit.
- Default: `data/overleaf`
Sets the host IP address(es) that the container will bind to. For example, if this is set to `0.0.0.0`, then the web interface will be available on any host IP address. For direct container access the value of `OVERLEAF_LISTEN_IP` must be set to your public IP address. Setting `OVERLEAF_LISTEN_IP` to either `0.0.0.0` or the external IP of your host will typically cause errors when used in conjunction with the .
- Default: `127.0.0.1`
Sets the host port that the container will bind to. For example, if this is set to `8099` and `OVERLEAF_LISTEN_IP` is set to `127.0.0.1`, then the web interface will be available on `http://localhost:8099`.
- Default: `80`
Sets the path to the directory that will be mounted into the main `sharelatex` container, and used for making application logs available on the Docker host. This can be either a full path (beginning with a `/`), or relative to the base directory of the Toolkit. Remove the config entry to disable the bind-mount. When not set, logs will be discarded when recreating the container.
See for information on logging.
- Default: not set
When set to `true`, tells the Toolkit to create a MongoDB container to host the database. When set to `false`, this container will not be created, and the system will use the MongoDB database specified by `MONGO_URL` instead.
- Default: `true`
Specifies the MongoDB connection URL to use when `MONGO_ENABLED` is `false`.
- Default: not set
Sets the path to the directory that will be mounted into the `mongo` container, and used to store the MongoDB database. This can be either a full path (beginning with a `/`), or relative to the base directory of the toolkit. This option only affects the local `mongo` container that is created when `MONGO_ENABLED` is `true`.
- Default: `data/mongo`
Docker image as used by the MongoDB container. This is just the name of the Docker image; the Docker image tag should go into `MONGO_VERSION` (see below).
- Default: `mongo`
MongoDB version as used by the MongoDB container. The value must start with the major MongoDB version and a dot, e.g. `6.0` or `6.0-with-suffix`.
- Default: `6.0`
When set to `true`, tells the Toolkit to create a Redis container to host the redis database. When set to `false`, this container will not be created, and the system will use the Redis database specified by `REDIS_HOST` and `REDIS_PORT` instead.
- Default: `true`
Specifies the Redis host to use when `REDIS_ENABLED` is `false`.
- Default: not set
Specifies the Redis port to use when `REDIS_ENABLED` is `false`.
- Default: not set
Sets the path to the directory that will be mounted into the `redis` container, and used to store the Redis database. This can be either a full path (beginning with a `/`), or relative to the base directory of the Toolkit. This option only affects the local `redis` container that is created when `REDIS_ENABLED` is `true`.
- Default: `data/redis`
Turn on AOF (Append Only File) persistence for Redis. This is the recommended configuration for Redis persistence.
For additional details, see the \<../../../maintenance/data-and-backups#aof-append-only-file> section in \<../../maintenance/data-and-backups>.
- Default: `true`
When set to `true`, tells the Toolkit to create an NGINX container to act as a TLS Proxy.
- Default: `false`
Path to the NGINX config file to use for the TLS Proxy.
- Default: `config/nginx/nginx.conf`
Sets the host IP address(es) that the TLS Proxy container will bind to for HTTPS. For example, if this is set to `0.0.0.0` then the HTTPS web interface will be available on any host IP address. Typically this should be set to the external IP of your host.
- Default: `127.0.1.1`
Sets the host IP address(es) that the TLS Proxy container will bind to for HTTP redirect. For example, if this is set to `127.0.1.1` then HTTP connections to `127.0.1.1` will be redirected to the HTTPS web interface. Typically this should be set to the external IP of your host. Do not set it to `0.0.0.0` as this will typically cause a conflict with `OVERLEAF_LISTEN_IP`.
- Default: `127.0.1.1`
Sets the host port that the TLS Proxy container will bind to for HTTP.
- Default: `80`
Sets the host port that the TLS Proxy container will bind to for HTTPS.
- Default: `443`
Path to the private key to use for the TLS Proxy.
- Default: `config/nginx/certs/overleaf_key.pem`
Path to the public certificate to use for the TLS Proxy.
- Default: `config/nginx/certs/overleaf_certificate.pem`