Données persistantes
Le Toolkit Overleaf doit stocker des données persistantes, comme les fichiers nécessaires à la compilation des projets LaTeX et le contenu de la base de données MongoDB. Pour cela, quelques répertoires de la machine hôte sont montés dans les conteneurs Docker, et les données sont écrites dans ces répertoires.Répertoires de données
Le conteneursharelatex a besoin d’un répertoire dans lequel stocker les données relatives aux compilations LaTeX. Ce répertoire est défini avec la variable OVERLEAF_DATA_PATH dans config/overleaf.rc.
Le conteneur mongo, s’il est activé, a besoin d’un répertoire pour stocker ses fichiers de base de données, et il en va de même pour le conteneur redis. Ces répertoires peuvent également être configurés dans config/overleaf.rc.
Permissions des fichiers
Comme Docker s’exécute en tant queroot, les répertoires de données appartiendront à l’utilisateur root, même si le Toolkit est utilisé par un utilisateur non root. Ce n’est pas un problème, mais il est bon de le savoir si vous comptez modifier les données persistantes depuis l’extérieur des conteneurs.
Emplacement des fichiers de configuration
Tous les fichiers de configuration appartenant à l’utilisateur se trouvent dans le répertoireconfig/.
Ce répertoire est exclu du système de gestion de versions git ; il ne sera donc pas modifié par la mise à jour du code du Toolkit. Le Toolkit ne modifiera aucune donnée du répertoire config/ sans votre autorisation.
Les modifications apportées aux fichiers de configuration ne sont pas appliquées automatiquement aux conteneurs existants, même si le conteneur est arrêté puis redémarré (avec
bin/stop et bin/start). Pour appliquer les modifications, exécutez bin/up : en coulisses, docker compose appliquera automatiquement les changements de configuration à un nouveau conteneur. (Ou exécutez bin/up -d si vous préférez ne pas vous attacher aux journaux Docker.)Le fichier config/overleaf.rc
Le fichier config/overleaf.rc contient les paramètres de configuration de premier niveau les plus importants utilisés par le Toolkit. Il contient des instructions qui définissent des variables, au format : VARIABLE_NAME=value
Pour obtenir le détail de toutes les options de configuration disponibles, consultez notre section sur les paramètres.
Le fichier variables.env
Le fichier config/variables.env contient les variables d’environnement chargées dans le conteneur sharelatex et utilisées pour configurer les microservices d’Overleaf. Elles comprennent le nom de l’application, tel qu’affiché dans l’en-tête de l’interface web, les paramètres d’envoi d’e-mails et d’autres paramètres comme le SSO.
Pour obtenir le détail de toutes les variables d’environnement disponibles, consultez la section Variables d’environnement.
Le fichier config/version
Le fichier config/version contient le numéro de version de l’image Docker qui sera utilisée pour créer l’instance en cours d’exécution de votre serveur Overleaf.
Les modifications apportées à ces fichiers de configuration ne sont pas appliquées automatiquement aux conteneurs existants, même si le conteneur est arrêté puis redémarré (avec
bin/stop et bin/start). Pour appliquer vos modifications, exécutez bin/up : le Toolkit créera automatiquement un nouveau conteneur avec les changements de configuration appliqués.Le fichier docker-compose.override.yml
S’il est présent, le fichier config/docker-compose.override.yml sera inclus dans l’appel à docker compose. C’est utile pour surcharger la configuration propre à Docker Compose.
config/variables.env n’est pas chargé dans les conteneurs mongo et redis. Pour y définir une variable d’environnement, ajoutez-la ici et exécutez bin/up -d, par exemple :
Questions/réponses
Quel système de fichiers les répertoires de données doivent-ils utiliser ? Puis-je utiliser btrfs, la copie sur écriture ou la compression zstd ?
Quel système de fichiers les répertoires de données doivent-ils utiliser ? Puis-je utiliser btrfs, la copie sur écriture ou la compression zstd ?
Réponse : Le Toolkit ne vérifie pas le système de fichiers. C’est MongoDB qui a des exigences : le choix compte donc surtout pour
data/mongo (MONGO_DATA_PATH). Les notes de production de MongoDB indiquent d’utiliser XFS ou ext4 sous Linux, et recommandent vivement XFS avec WiredTiger, le moteur de stockage qu’il utilise. Elles ne traitent pas de btrfs ni des autres systèmes de fichiers à copie sur écriture. Si votre système de fichiers racine est btrfs, vous pouvez monter un volume XFS et y faire pointer MONGO_DATA_PATH. Le système de fichiers doit également prendre en charge fsync() sur les répertoires, ce que ne font pas HGFS ni les dossiers partagés de VirtualBox.La compression au niveau du système de fichiers fait peu gagner pour data/mongo : WiredTiger compresse déjà les collections avec snappy et les index avec la compression par préfixe. Pour NFS, consultez Dépannage.
