docker-compose.yml, migrer vers le Toolkit peut rendre une version sur site d’Overleaf plus facile à déployer, à mettre à niveau et à maintenir.
Pour migrer, vous devrez convertir votre configuration Docker Compose existante au format utilisé par le Toolkit. Ce processus consiste à copier la configuration existante dans le Toolkit.
Ce guide vous accompagne à chaque étape de ce processus, pour une migration en douceur de Docker Compose vers le Toolkit.
1
Cloner le dépôt du Toolkit
Commencez par cloner le dépôt du Toolkit sur la machine hôte :Exécutez ensuite la commande
bin/init pour initialiser le Toolkit avec sa configuration par défaut.2
Définir l'image et la version
Dans un Avec le Toolkit, le nom de l’image est résolu automatiquement ; il suffit de définir
docker-compose.yml typique, l’image et la version sont définies dans la description du composant, par exemple :SERVER_PRO=true dans config/overleaf.rc pour choisir l’image Ayakaleaf Pro, ou SERVER_PRO=false pour utiliser Community Edition.Le numéro de version souhaité d’Ayakaleaf Pro/Community Edition est défini dans le fichier config/version. Le Toolkit exige un numéro de version précis, comme 6.3.2. Si vous utilisez latest, vous pouvez utiliser bin/images pour trouver l’identifiant de l’image de votre version latest locale, puis utiliser les notes de version pour faire correspondre cet identifiant à une version.Si vous récupérez l’image depuis votre propre registre interne, vous pouvez remplacer l’image utilisée par le Toolkit en définissant OVERLEAF_IMAGE_NAME. Inutile de préciser le tag : le Toolkit l’ajoutera automatiquement en fonction de votre fichier config/version.3
Configurer l'accès externe
Par défaut, Overleaf écoute sur
127.0.0.1:80, n’autorisant que le trafic provenant de la machine hôte Docker.Pour autoriser l’accès externe, définissez OVERLEAF_LISTEN_IP et OVERLEAF_PORT dans le fichier config/overleaf.rc.4
Migration des variables d'environnement
Vous avez probablement un ensemble de variables d’environnement définies dans le service Copiez ces variables dans le fichier config/variables.env du Toolkit en respectant la forme suivante (utilisez Exceptions / différences avec le Toolkit :
sharelatex de votre docker-compose.yml, par exemple := au lieu de :) :- Les variables commençant par
SANDBOXED_COMPILES_etDOCKER_RUNNERne sont plus nécessaires. Pour activer les compilations en sandbox, définissezSIBLING_CONTAINERS_ENABLED=truedans votre fichier config/overleaf.rc. - Les variables commençant par
OVERLEAF_MONGO_,OVERLEAF_REDIS_ainsi que la variableREDIS_HOSTne sont plus nécessaires. MongoDB et Redis sont désormais configurés dans le fichier config/overleaf.rc à l’aide deMONGO_URL,REDIS_HOSTetREDIS_PORT.
5
Proxy NGINX
Pour savoir comment migrer
nginx, consultez la documentation du proxy TLS :6
Volumes
Définissez l’emplacement des volumes de données dans config/overleaf.rc :
ShareLaTeX
DéfinissezOVERLEAF_DATA_PATH sur l’emplacement du volume de données utilisé par le conteneur sharelatex.MongoDB
DéfinissezMONGO_DATA_PATH sur l’emplacement du volume de données utilisé par le conteneur mongo.Redis
DéfinissezREDIS_DATA_PATH sur l’emplacement du volume de données utilisé par le conteneur redis.
