Qu'est-ce que l'Ayakaleaf Toolkit ?

L’Ayakaleaf Toolkit est la méthode de déploiement recommandée pour les installations sur site de la Community Edition et d’Ayakaleaf Pro. Il a été conçu pour fonctionner dans l’environnement le plus courant : un seul serveur physique ou une seule machine virtuelle. Le Toolkit utilise docker compose pour gérer les conteneurs Docker de votre serveur et fournit un ensemble de scripts qui encapsulent des commandes docker afin de vous aider dans les aspects les plus techniques de la gestion d’une version sur site d’Overleaf.

Le wrapper bin/docker-compose

Le script bin/docker-compose est un wrapper autour de docker compose. Il charge la configuration depuis le répertoire config/, puis invoque docker compose avec les arguments passés au script.

Vous pouvez considérer bin/docker-compose comme un wrapper transparent du programme docker compose installé sur votre machine.

Exemple :

Check running containers

$ bin/docker-compose ps

Scripts utilitaires

En plus de bin/docker-compose, le Toolkit fournit des scripts pratiques pour faciliter les tâches courantes :

• bin/up : raccourci pour bin/docker-compose up
• bin/start : raccourci pour bin/docker-compose start
• bin/stop : raccourci pour bin/docker-compose stop
• bin/shell : ouvre un shell dans le conteneur sharelatex
• bin/doctor : script permettant de recueillir des informations sur l’installation et le déploiement. Voir la section « Vérifier votre serveur » ci-dessous
• bin/mongo : ouvre un shell dans le conteneur mongo et sélectionne la bonne base de données (sharelatex)
• bin/backup-config : crée une copie (zip ou tar) de votre configuration actuelle et la stocke dans le répertoire de destination de votre choix
• bin/logs : affiche/suit les journaux des services
• bin/error-logs : affiche/suit les journaux d’erreurs des services
• bin/rename-env-vars-5-0 : script de migration qui met à jour les variables d’environnement dans config/variables.env (changement de marque de ShareLaTeX vers Overleaf)
• bin/rename-rc-vars : script de migration qui met à jour les variables d’environnement dans config/overleaf.rc (changement de marque de ShareLaTeX vers Overleaf)
• bin/run-script : utilitaire simplifiant l’exécution des scripts stockés dans le conteneur sharelatex
• bin/upgrade : facilite la mise à niveau de l’instance. Le script vérifie les mises à jour du Toolkit (via git) et propose de récupérer les modifications, puis vérifie la dernière version de l’image Docker et propose de la mettre à jour. Il demande une confirmation à chaque étape, propose de sauvegarder la configuration actuelle et gère l’arrêt et le démarrage des services Docker. Pour plus d’informations, consultez Mettre à niveau votre déploiement : https://docs.overleaf.com/on-premises/maintenance/upgrading-your-deployment

Si vous préférez exécuter votre instance sans vous attacher aux journaux Docker, vous pouvez lancer bin/up -d pour l’exécuter en mode détaché.

Vérifier votre serveur

L’Overleaf Toolkit inclut un script pratique appelé bin/doctor, qui produit un rapport signalant toute dépendance manquante.

Avant de continuer, exécutez le script bin/doctor et vérifiez que tout fonctionne correctement :

Run Overleaf Doctor

bin/doctor

Exemple de sortie (tronquée/à titre d’illustration) :

Exemple de sortie de bin/doctor

====== Overleaf Doctor ======
- Host Information
    - Linux
    - Output of 'lsb_release -a':
            No LSB modules are available.
            Distributor ID:     Ubuntu
            Description:        Ubuntu 22.04.5 LTS
            Release:    22.04
            Codename:   jammy
- Dependencies
    - bash
        - status: present
        - version info: 5.1.16(1)-release
    - docker
        - status: present
        - version info: Docker version 27.3.1, build ce12230
    - realpath
        - status: present
        - version info: realpath (GNU coreutils) 8.32
    - perl
        - status: present
        - version info: 5.034000
    - awk
        - status: present
        - version info: GNU Awk 5.1.0, API: 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1)
    - openssl
        - status: present
        - version info: OpenSSL 3.0.2 15 Mar 2022 (Library: OpenSSL 3.0.2 15 Mar 2022)
    - docker compose
        - status: present
        - version info: Docker Compose version v2.29.7
- Docker Daemon
    - status: up
====== Configuration ======
- config/version
    - status: present
    - version: 5.1.1
- config/overleaf.rc
    - status: present
    - values
        - OVERLEAF_DATA_PATH: data/overleaf
        - OVERLEAF_LOG_PATH: data/overleaf/logs
        - SERVER_PRO: true
            - logged in to quay.io: true
        - SIBLING_CONTAINERS_ENABLED: true
        - OVERLEAF_LISTEN_IP: 0.0.0.0
        - OVERLEAF_PORT: 80
        - MONGO_ENABLED: true
        - MONGO_IMAGE: mongo
        - MONGO_VERSION: 6.0
        - MONGO_DATA_PATH: data/mongo
        - REDIS_ENABLED: true
        - REDIS_IMAGE: redis:6.2
        - REDIS_DATA_PATH: data/redis
- config/variables.env
    - status: present
    - values
        - OVERLEAF_FILESTORE_BACKEND: fs
        - OVERLEAF_HISTORY_BACKEND: fs
====== Warnings ======
- None, all good
====== End ======

Si des dépendances sont manquantes, le doctor affichera des avertissements. En cas de problème, exécutez d’abord bin/doctor et recherchez d’éventuels avertissements dans sa sortie.

• Les utilisateurs de l’édition Ayakaleaf Pro peuvent ouvrir une issue sur GitHub : https://github.com/ayaka-notes/toolkit/issues

Dans tous les cas, joignez la sortie de bin/doctor à votre message.