Variables d'environnement

Cette page décrit les variables d’environnement prises en charge dans le fichier config/variables.env pour les déploiements avec le Toolkit.

Le fichier config/variables.env 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.

​

Toutes les versions

Ces variables d’environnement sont compatibles avec Server CE et Server Pro, et facilitent la migration entre ces deux versions sur site. Elles peuvent également être utilisées aussi bien avec les déploiements Toolkit qu’avec les déploiements Docker Compose.

Auparavant, ces variables d’environnement étaient préfixées par SHARELATEX_ au lieu de OVERLEAF_.

Nom	Description
OVERLEAF_SITE_URL	L’adresse publique de votre instance Overleaf. Elle est utilisée dans les liens publics et lors des connexions WebSocket ; elle doit donc être configurée correctement !
OVERLEAF_ADMIN_EMAIL	L’adresse e-mail à laquelle les utilisateurs peuvent joindre la personne qui administre le site.
OVERLEAF_APP_NAME	Le nom à afficher pour désigner l’application en cours d’exécution. Valeur par défaut : ‘Overleaf (Community Edition)’.
OVERLEAF_MONGO_URL et MONGO_URL	L’URL de la base de données Mongo à utiliser.
OVERLEAF_REDIS_HOST et REDIS_HOST	Le nom d’hôte de l’instance Redis à utiliser. Les deux sont obligatoires (voir les notes de version).
OVERLEAF_REDIS_PORT et REDIS_PORT	Le port de l’instance Redis à utiliser. Les deux sont obligatoires (voir les notes de version).
OVERLEAF_REDIS_PASS et REDIS_PASSWORD	Le mot de passe à utiliser pour se connecter à Redis (le cas échéant). Les deux variables d’environnement doivent être définies. Pour plus d’informations, consultez activer l’authentification par mot de passe.
OVERLEAF_REDIS_TLS	Si la valeur est true, permet la connexion à une instance Redis exigeant TLS. Remarque : mTLS n’est actuellement pas pris en charge.
OVERLEAF_NAV_TITLE	Définit le titre de l’onglet de l’application.
OVERLEAF_HEADER_IMAGE_URL_LIGHT et OVERLEAF_HEADER_IMAGE_URL_DARK	URL des logos d’en-tête personnalisés pour les thèmes clair et sombre (ajoutées dans la version 6.3.0). Chaque thème se rabat sur OVERLEAF_HEADER_IMAGE_URL lorsque sa variable spécifique n’est pas définie. Voir Branding.
OVERLEAF_LINKED_URL_OUTBOUND_PROXY	URL d’un proxy HTTP(S) permettant de récupérer les fichiers liés externes ainsi que les ressources ZIP ou TeX externes via l’API Open in Overleaf. Disponible à partir de la réédition d’Ayakaleaf Pro 6.3.0 (3 octobre 2026). Laissez cette variable non définie pour une connexion directe. Exemple : OVERLEAF_LINKED_URL_OUTBOUND_PROXY=http://proxy.internal:3128. Consultez Outbound Proxy pour la configuration et les restrictions d’accès réseau.
OVERLEAF_INVITE_TOKEN_SECRET	Obligatoire. Une chaîne aléatoire utilisée pour sécuriser les jetons de partage de projets (ajoutée dans Server Pro 6.2.0). Nombre minimal de caractères : 16
OVERLEAF_SESSION_SECRET	Une chaîne aléatoire utilisée pour sécuriser les jetons ; en cas de répartition de charge, elle doit avoir la même valeur sur toutes les machines. Si une seule instance est exécutée, l’utilisateur n’a pas besoin de la définir.
OVERLEAF_COOKIE_SESSION_LENGTH	Permet de remplacer la durée d’expiration par défaut du cookie de session, fixée à 5 jours. La valeur doit être exprimée en millisecondes. Exemple : pour une session d’une heure, définissez COOKIE_SESSION_LENGTH=3600000. (Ajoutée dans Server Pro 4.2)
OVERLEAF_TRUSTED_PROXY_IPS	Si elle n’est pas définie, la valeur par défaut est loopback. Si vous la définissez manuellement, vous devez inclure, en plus de vos IP de confiance, loopback (ou 127.0.0.1), qui permet de faire confiance à l’instance nginx exécutée dans le conteneur sharelatex. Seules les adresses IP et les plages CIDR sont acceptées : n’ajoutez pas de noms d’hôte tels que localhost, sinon Overleaf ne démarrera pas et renverra 502 Bad Gateway. Si votre réseau habituel utilise un sous-réseau de 172.16.0.0/12 (sous-réseau par défaut des réseaux Docker), définissez OVERLEAF_TRUSTED_PROXY_IPS=loopback,<network> dans votre config/variables.env, où <network> correspond à la valeur IPAM -> Config -> Subnet de docker inspect overleaf_default, par exemple OVERLEAF_TRUSTED_PROXY_IPS=loopback,172.19.0.0/16. Cela permet d’empêcher l’usurpation des en-têtes X-Forwarded. Si vous utilisez un proxy TLS externe (c’est-à-dire non géré par l’Overleaf Toolkit), assurez-vous que OVERLEAF_TRUSTED_PROXY_IPS=loopback,<ip-of-your-tls-proxy>, par exemple OVERLEAF_TRUSTED_PROXY_IPS=loopback,192.168.13.37.
OVERLEAF_RESTRICT_INVITES_TO_EXISTING_ACCOUNTS	Si la valeur est true, limite les invitations aux projets aux adresses e-mail correspondant à des comptes utilisateur existants.
OVERLEAF_ALLOW_PUBLIC_ACCESS	Si la valeur est true, permet aux utilisateurs non authentifiés de consulter le site. La valeur par défaut est false : les utilisateurs non authentifiés sont alors systématiquement redirigés vers la page de connexion lorsqu’ils tentent d’accéder à une partie quelconque du site. Notez que cette option ne désactive en aucun cas l’authentification ni la sécurité. Elle est nécessaire si vos utilisateurs souhaitent rendre leurs projets publics et permettre à des utilisateurs non authentifiés de les consulter.
OVERLEAF_ALLOW_ANONYMOUS_READ_AND_WRITE_SHARING	Si la valeur est true, permet aux utilisateurs anonymes de consulter et de modifier les projets partagés via la fonctionnalité de partage par lien.
OVERLEAF_DISABLE_LINK_SHARING	Désactive la fonctionnalité de partage par lien.
EMAIL_CONFIRMATION_DISABLED	Si la valeur est true, la bannière demandant la confirmation de l’adresse e-mail ne s’affiche pas.
ADDITIONAL_TEXT_EXTENSIONS	Un tableau de chaînes permettant de configurer des extensions supplémentaires pour les fichiers modifiables.
DEFAULT_LATEX_COMPILER	Permet de définir le compilateur utilisé par défaut pour les nouveaux projets. (Ajoutée dans Server Pro 6.2.0). Options : pdflatex, latex, xelatex ou lualatex
OVERLEAF_STATUS_PAGE_URL	URL d’une page d’état personnalisée (ajoutée dans Server Pro 3.4.0), par exemple status.example.com.
OVERLEAF_FPH_INITIALIZE_NEW_PROJECTS	Définissez cette variable sur 'false' pour empêcher l’initialisation des nouveaux projets avec l’historique complet du projet (Full Project History) (ajoutée dans Server Pro 3.5.0).
OVERLEAF_FPH_DISPLAY_NEW_PROJECTS	Définissez cette variable sur 'false' pour empêcher les nouveaux projets d’afficher l’historique complet du projet à la place de l’ancien historique (ajoutée dans Server Pro 3.5.0).
ENABLE_CRON_RESOURCE_DELETION	Définissez cette variable d’environnement sur true pour activer le nettoyage automatique des projets et utilisateurs supprimés au bout de 90 jours.
OVERLEAF_USER_HARD_DELETION_DELAY	Permet de modifier le délai d’expiration des utilisateurs supprimés. Exprimé en millisecondes. Valeur par défaut : 90 jours
OVERLEAF_PROJECT_HARD_DELETION_DELAY	Permet de modifier le délai d’expiration des projets supprimés. Exprimé en millisecondes. Valeur par défaut : 90 jours
MAX_UPLOAD_SIZE	Contrôle la taille maximale d’un envoi individuel, en mégaoctets. Valeur par défaut : 50. Attention : cette variable est un simple nombre, sans unité (MB) ni délimiteur. La taille totale décompressée d’un fichier .zip envoyé est limitée à 6 × cette valeur (300 Mo par défaut).
COMPILE_SIZE_LIMIT	Contrôle la taille maximale du corps de requête, en octets. Il s’agit de la somme des tailles de tous les fichiers doc du projet (main.tex, references.bib (s’il n’est pas lié), etc.) qui doivent être envoyés dans la requête de compilation initiale au service CLSI.
COMPILE_TIMEOUT	Le temps, en secondes, accordé pour qu’une compilation se termine. Pour plus d’informations, consultez Mettre à jour le délai de compilation d’un projet.
MAX_RECONNECT_GRACEFULLY_INTERVAL_MS	Un délai configurable entre la reconnexion en douceur de l’éditeur, l’écriture des données et l’arrêt du conteneur, afin de limiter le risque de perte de données.
SECCOMP_PROFILE	Définissez cette variable d’environnement sur un chemin de la machine hôte Docker pointant vers le profil SECCOMP. Vous pouvez télécharger une copie du profil ici. Actuellement nécessaire pour les déploiements Podman utilisant les compilations isolées.
OVERLEAF_DISABLE_CHAT	Si la valeur est true, désactive le chat intégré aux projets.
OVERLEAF_LOGIN_SUPPORT_TEXT	Lorsqu’elle est définie, permet d’afficher des informations d’assistance sous le bouton de connexion. Le texte s’affiche sur l’écran de connexion et peut servir à orienter les utilisateurs vers le support interne ou à fournir des indications sur la connexion, la création de compte, etc.
ALLOW_MONGO_ADMIN_CHECK_FAILURES	Si la valeur est true, les vérifications de MongoDB au démarrage peuvent échouer sans empêcher le déploiement de démarrer. Cela peut être nécessaire si vous utilisez une base de données MongoDB dans laquelle votre utilisateur ne dispose pas du rôle clusterParameterReader. Pour savoir comment créer un rôle personnalisé, consultez cette page.
V1_HISTORY_URL_FOR_GIT_BRIDGE	Permet de séparer le point de terminaison history-v1 pour le trafic interne (service web → service history-v1, tous deux dans le conteneur sharelatex) et le trafic externe (git-bridge → history-v1, exécutés dans des conteneurs distincts).
OVERLEAF_MAINTENANCE_MESSAGE et OVERLEAF_MAINTENANCE_MESSAGE_HTML	Permettent de personnaliser le titre et le contenu de la page de maintenance. Ne peuvent pas être utilisées avec OVERLEAF_STATUS_PAGE_URL.

Il est possible d’imposer des restrictions de mot de passe aux utilisateurs lorsqu’ils utilisent le système de connexion d’Overleaf (comptes locaux), et non une option SSO telle que LDAP. Pour les comptes SSO, les politiques de mot de passe sont appliquées par votre fournisseur d’identité ou votre service d’annuaire, qui peut en outre prendre en charge l’authentification multifacteur.