Paramètres du Toolkit - Ayakaleaf Pro

Cette page décrit les variables d’environnement prises en charge dans le fichier config/overleaf.rc pour les déploiements avec le Toolkit. Le fichier config/overleaf.rc est constitué de définitions de variables de la forme NAME=value. Les lignes commençant par # sont traitées comme des commentaires.

Après toute modification de overleaf.rc ou de variables.env, vous devez recréer les conteneurs Docker en exécutant bin/up.

Conteneurs

`sharelatex`

Nom	Description
`PROJECT_NAME`	Définit la valeur de l’option `--project-name` transmise à `docker-compose`. Utile lorsque plusieurs instances d’Overleaf s’exécutent sur un même hôte, chaque instance pouvant ainsi avoir un nom de projet différent. - Valeur par défaut : `overleaf`
`OVERLEAF_IMAGE_NAME`	Image Docker utilisée par le conteneur de l’application Server Pro/CE. Il s’agit uniquement du nom de l’image Docker ; le tag de l’image Docker provient de `config/version`. - Valeur par défaut : - Server Pro : `ghcr.io/ayaka-notes/overleaf-pro` - Community Edition : `sharelatex/sharelatex`
`SERVER_PRO`	Lorsque cette variable vaut `true`, le Toolkit utilise l’image Server Pro (`ghcr.io/ayaka-notes/overleaf-pro`) au lieu de l’image Server CE par défaut (`sharelatex/sharelatex`). - Valeur par défaut : `false`
`GIT_BRIDGE_ENABLED`	Définissez `true` pour activer la fonctionnalité git-bridge (Server Pro uniquement). Pour plus d’informations, consultez la documentation utilisateur https://www.overleaf.com/learn/how-to/Git_integration. - Valeur par défaut : `false`
`GIT_BRIDGE_IMAGE`	Image Docker utilisée par le conteneur git-bridge (Server Pro uniquement). Il s’agit uniquement du nom de l’image Docker ; le tag de l’image Docker provient de `config/version`. - Valeur par défaut : `ghcr.io/ayaka-notes/overleaf-pro/git-bridge`
`GIT_BRIDGE_DATA_PATH`	Définit le chemin du répertoire monté dans le conteneur `git-bridge` (Server Pro uniquement) et utilisé pour stocker les dépôts git. Il peut s’agir d’un chemin absolu (commençant par `/`) ou d’un chemin relatif au répertoire de base du Toolkit.
`GIT_BRIDGE_LOG_LEVEL`	Configure le niveau de journalisation du conteneur `git-bridge`. Niveaux disponibles : `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`. - Valeur par défaut : `INFO`
`SIBLING_CONTAINERS_ENABLED`	Lorsque cette variable vaut `true`, le Toolkit utilise la technique des Sibling Containers pour compiler les projets dans des bacs à sable séparés, avec un conteneur Docker distinct pour chaque projet. Consultez la documentation <server-pro-only-configuration/sandboxed-compiles> pour plus d’informations. - Nécessite : `SERVER_PRO=true` - Valeur par défaut : `true`
`SIBLING_CONTAINERS_PULL`	Lorsque cette variable vaut `true`, le Toolkit télécharge automatiquement, lors de la commande `bin/up`, toutes les images TeX Live définies par `ALL_TEX_LIVE_DOCKER_IMAGES` dans le fichier config/variables.env. - Valeur par défaut : `true`
`DOCKER_SOCKET_PATH`	Définit le chemin du socket Docker sur la machine hôte (la machine qui exécute le Toolkit). Lorsque `SIBLING_CONTAINERS_ENABLED` vaut `true`, le socket est monté dans le conteneur pour permettre au service de compilation de créer de nouveaux conteneurs Docker sur l’hôte. - Nécessite : `SIBLING_CONTAINERS_ENABLED=true` - Valeur par défaut : `/var/run/docker.sock`
`OVERLEAF_DATA_PATH`	Définit le chemin du répertoire monté dans le conteneur principal `sharelatex` et utilisé pour stocker les données de compilation. Il peut s’agir d’un chemin absolu (commençant par `/`) ou d’un chemin relatif au répertoire de base du Toolkit. - Valeur par défaut : `data/overleaf`
`OVERLEAF_LISTEN_IP`	Définit la ou les adresses IP de l’hôte auxquelles le conteneur se lie. Par exemple, si elle vaut `0.0.0.0`, l’interface web sera accessible sur toutes les adresses IP de l’hôte. Pour un accès direct au conteneur, `OVERLEAF_LISTEN_IP` doit être défini sur votre adresse IP publique. Définir `OVERLEAF_LISTEN_IP` sur `0.0.0.0` ou sur l’adresse IP externe de votre hôte provoque généralement des erreurs lorsqu’il est utilisé conjointement avec le . - Valeur par défaut : `127.0.0.1`
`OVERLEAF_PORT`	Définit le port de l’hôte auquel le conteneur se lie. Par exemple, s’il vaut `8099` et que `OVERLEAF_LISTEN_IP` vaut `127.0.0.1`, l’interface web sera accessible à l’adresse `http://localhost:8099`. - Valeur par défaut : `80`
`OVERLEAF_LOG_PATH`	Définit le chemin du répertoire monté dans le conteneur principal `sharelatex` et utilisé pour rendre les journaux de l’application accessibles sur l’hôte Docker. Il peut s’agir d’un chemin absolu (commençant par `/`) ou d’un chemin relatif au répertoire de base du Toolkit. Supprimez cette entrée de configuration pour désactiver le montage. Si elle n’est pas définie, les journaux sont perdus lors de la recréation du conteneur. Voir pour plus d’informations sur la journalisation. - Valeur par défaut : non définie

`mongo`

Nom	Description
`MONGO_ENABLED`	Lorsque cette variable vaut `true`, le Toolkit crée un conteneur MongoDB pour héberger la base de données. Lorsqu’elle vaut `false`, ce conteneur n’est pas créé et le système utilise à la place la base de données MongoDB indiquée par `MONGO_URL`. - Valeur par défaut : `true`
`MONGO_URL`	Indique l’URL de connexion MongoDB à utiliser lorsque `MONGO_ENABLED` vaut `false`. - Valeur par défaut : non définie
`MONGO_DATA_PATH`	Définit le chemin du répertoire monté dans le conteneur `mongo` et utilisé pour stocker la base de données MongoDB. Il peut s’agir d’un chemin absolu (commençant par `/`) ou d’un chemin relatif au répertoire de base du Toolkit. Cette option ne concerne que le conteneur `mongo` local créé lorsque `MONGO_ENABLED` vaut `true`. - Valeur par défaut : `data/mongo`
`MONGO_IMAGE`	Image Docker utilisée par le conteneur MongoDB. Il s’agit uniquement du nom de l’image Docker ; le tag de l’image Docker doit être indiqué dans `MONGO_VERSION` (voir ci-dessous). - Valeur par défaut : `mongo`
`MONGO_VERSION`	Version de MongoDB utilisée par le conteneur MongoDB. La valeur doit commencer par la version majeure de MongoDB suivie d’un point, par ex. `6.0` ou `6.0-with-suffix`. - Valeur par défaut : `6.0`

`redis`

Nom	Description
`REDIS_ENABLED`	Lorsque cette variable vaut `true`, le Toolkit crée un conteneur Redis pour héberger la base de données Redis. Lorsqu’elle vaut `false`, ce conteneur n’est pas créé et le système utilise à la place la base de données Redis indiquée par `REDIS_HOST` et `REDIS_PORT`. - Valeur par défaut : `true`
`REDIS_HOST`	Indique l’hôte Redis à utiliser lorsque `REDIS_ENABLED` vaut `false`. - Valeur par défaut : non définie
`REDIS_PORT`	Indique le port Redis à utiliser lorsque `REDIS_ENABLED` vaut `false`. - Valeur par défaut : non définie
`REDIS_DATA_PATH`	Définit le chemin du répertoire monté dans le conteneur `redis` et utilisé pour stocker la base de données Redis. Il peut s’agir d’un chemin absolu (commençant par `/`) ou d’un chemin relatif au répertoire de base du Toolkit. Cette option ne concerne que le conteneur `redis` local créé lorsque `REDIS_ENABLED` vaut `true`. - Valeur par défaut : `data/redis`
`REDIS_AOF_PERSISTENCE`	Active la persistance AOF (Append Only File) pour Redis. Il s’agit de la configuration recommandée pour la persistance de Redis. Pour plus de détails, consultez la section <../../../maintenance/data-and-backups#aof-append-only-file> de <../../maintenance/data-and-backups>. - Valeur par défaut : `true`

`nginx`

Nom	Description
`NGINX_ENABLED`	Lorsque cette variable vaut `true`, le Toolkit crée un conteneur NGINX faisant office de proxy TLS. - Valeur par défaut : `false`
`NGINX_CONFIG_PATH`	Chemin du fichier de configuration NGINX à utiliser pour le proxy TLS. - Valeur par défaut : `config/nginx/nginx.conf`
`NGINX_TLS_LISTEN_IP`	Définit la ou les adresses IP de l’hôte auxquelles le conteneur du proxy TLS se lie pour HTTPS. Par exemple, si elle vaut `0.0.0.0`, l’interface web HTTPS sera accessible sur toutes les adresses IP de l’hôte. En général, elle doit être définie sur l’adresse IP externe de votre hôte. - Valeur par défaut : `127.0.1.1`
`NGINX_HTTP_LISTEN_IP`	Définit la ou les adresses IP de l’hôte auxquelles le conteneur du proxy TLS se lie pour la redirection HTTP. Par exemple, si elle vaut `127.0.1.1`, les connexions HTTP vers `127.0.1.1` seront redirigées vers l’interface web HTTPS. En général, elle doit être définie sur l’adresse IP externe de votre hôte. Ne la définissez pas sur `0.0.0.0`, car cela provoque généralement un conflit avec `OVERLEAF_LISTEN_IP`. - Valeur par défaut : `127.0.1.1`
`NGINX_HTTP_PORT`	Définit le port de l’hôte auquel le conteneur du proxy TLS se lie pour HTTP. - Valeur par défaut : `80`
`TLS_PORT`	Définit le port de l’hôte auquel le conteneur du proxy TLS se lie pour HTTPS. - Valeur par défaut : `443`
`TLS_PRIVATE_KEY_PATH`	Chemin de la clé privée à utiliser pour le proxy TLS. - Valeur par défaut : `config/nginx/certs/overleaf_key.pem`
`TLS_CERTIFICATE_PATH`	Chemin du certificat public à utiliser pour le proxy TLS. - Valeur par défaut : `config/nginx/certs/overleaf_certificate.pem`

Dernière modification le 5 octobre 2026