> For the complete documentation index, see [llms.txt](https://ayakaleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ayakaleaf-pro.ayaka.space/on-premises/fr/demarrage/what-is-the-overleaf-toolkit.md). # Qu’est-ce que l’Ayakaleaf Toolkit ? La boîte à outils Ayakaleaf est la méthode de déploiement recommandée pour les installations sur site de la Community Edition, Ayakaleaf Pro ; elle a été conçue pour fonctionner avec l'environnement le plus courant : un seul serveur physique ou une machine virtuelle. La boîte à outils utilise `docker compose` pour gérer les conteneurs Docker de votre serveur et fournit un ensemble de scripts qui enveloppent `docker` commandes pour aider à gérer plus techniquement une version sur site d'Overleaf. #### Le `bin/docker-compose` enveloppe Le `bin/docker-compose` script est une enveloppe autour de `docker compose`. Il charge la configuration depuis le `config/` répertoire, avant d'invoquer `docker compose` avec les arguments qui ont été passés au script. Vous pouvez considérer `bin/docker-compose` comme une enveloppe transparente pour le `docker compose` programme installé sur votre machine. Exemple : {% code title="Vérifier les conteneurs en cours d'exécution" %} ```bash $ bin/docker-compose ps ``` {% endcode %} #### Aides pratiques En plus de `bin/docker-compose`, la boîte à outils fournit des scripts pratiques pour aider à accomplir 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` : lance un shell à l'intérieur du **sharelatex** conteneur * `bin/doctor` : script utilisé pour recueillir les informations d'installation et de déploiement. Voir la section « Vérifier votre serveur » ci-dessous * `bin/mongo` : lance un shell à l'intérieur du **mongo** conteneur et bascule vers la base de données correcte (**sharelatex**) * `bin/backup-config` : crée une copie (zip ou tar) de votre configuration actuelle et l'enregistre dans le répertoire de destination de votre choix * `bin/logs` : afficher/suivre les journaux du service * `bin/error-logs` : afficher/suivre les journaux d'erreurs du service * `bin/rename-env-vars-5-0` : script de migration pour mettre à jour les variables d'environnement dans **config/variables.env** (changement de marque de ShareLaTeX à Overleaf) * `bin/rename-rc-vars` : script de migration pour mettre à jour les variables d'environnement dans **config/overleaf.rc** (changement de marque de ShareLaTeX à Overleaf) * `bin/run-script` : aide à simplifier l'exécution des scripts stockés dans le **sharelatex** conteneur * `bin/upgrade` : aide aux mises à niveau de l'instance. Le script vérifiera les mises à jour de la boîte à outils (via git) et proposera de récupérer les changements, vérifiera la dernière version de l'image Docker et proposera de la mettre à jour. Il fournit une confirmation étape par étape, la possibilité de sauvegarder la configuration actuelle et gère l'arrêt/le démarrage des services Docker. Voir Mise à niveau de votre déploiement pour plus d'informations : {% hint style="info" %} Si vous préférez exécuter votre instance sans vous attacher aux journaux Docker, vous pouvez exécuter `bin/up -d` pour l'exécuter en mode détaché. {% endhint %} #### Vérifier votre serveur La boîte à outils Overleaf comprend un script pratique appelé `bin/doctor` qui produit un rapport signalant toute dépendance non satisfaite. Avant de continuer, exécutez le `bin/doctor` script et vérifiez que tout fonctionne correctement : {% code title="Exécuter Overleaf Doctor" %} ```bash bin/doctor ``` {% endcode %} Exemple de sortie (tronquée/illustrative) :
Exemple de sortie de bin/doctor ``` ====== Overleaf Doctor ====== - Informations sur l'hôte - Linux - Sortie de 'lsb_release -a' : Aucun module LSB n'est disponible. ID du distributeur : Ubuntu Description : Ubuntu 22.04.5 LTS Version : 22.04 Nom de code : jammy - Dépendances - bash - état : présent - informations de version : 5.1.16(1)-release - docker - état : présent - informations de version : Docker version 27.3.1, build ce12230 - realpath - état : présent - informations de version : realpath (GNU coreutils) 8.32 - perl - état : présent - informations de version : 5.034000 - awk - état : présent - informations de version : GNU Awk 5.1.0, API : 3.0 (GNU MPFR 4.1.0, GNU MP 6.2.1) - openssl - état : présent - informations de version : OpenSSL 3.0.2 15 Mar 2022 (Bibliothèque : OpenSSL 3.0.2 15 Mar 2022) - docker compose - état : présent - informations de version : Docker Compose version v2.29.7 - démon Docker - état : en cours d'exécution ====== Configuration ====== - config/version - état : présent - version : 5.1.1 - config/overleaf.rc - état : présent - valeurs - OVERLEAF_DATA_PATH : data/overleaf - OVERLEAF_LOG_PATH : data/overleaf/logs - SERVER_PRO : true - connecté à 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 - état : présent - valeurs - OVERLEAF_FILESTORE_BACKEND : fs - OVERLEAF_HISTORY_BACKEND : fs ====== Avertissements ====== - Aucun, tout va bien ====== Fin ====== ```
Si certaines dépendances sont manquantes, le doctor affichera des avertissements. Si vous rencontrez des problèmes, exécutez d'abord `bin/doctor` et vérifiez s'il contient des avertissements. {% hint style="info" %} * Les utilisateurs de l'édition Ayakaleaf Pro peuvent ouvrir un ticket sur GitHub : Dans les deux cas, incluez la sortie de `bin/doctor` dans votre message. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://ayakaleaf-pro.ayaka.space/on-premises/fr/demarrage/what-is-the-overleaf-toolkit.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.