Passer au contenu principal

Le Doctor

Le Toolkit Overleaf est fourni avec un script doctor pratique pour faciliter le débogage. Exécutez bin/doctor : le script affichera des informations sur votre environnement hôte, votre configuration et les dépendances dont le Toolkit a besoin. Cette sortie peut également nous aider à diagnostiquer les problèmes de vos installations Ayakaleaf Pro.
Les utilisateurs d’Overleaf Pro peuvent ouvrir une issue sur GitHub.Il est conseillé d’inclure la sortie du script bin/doctor dans votre message.

Consulter le Doctor

Exécutez le script doctor :
Run doctor
Vous verrez une sortie semblable à l’exemple ci-dessous.

Informations sur l’hôte

La section Host Information contient des informations sur la machine qui exécute le Toolkit (par exemple, la distribution Linux et sa version).

Dépendances

La section Dependencies liste les outils nécessaires au fonctionnement du Toolkit. Si un outil est présent, il est indiqué avec status: present et les informations de version. S’il est absent, il est indiqué avec status: MISSING! et un avertissement est ajouté à la fin de la sortie de doctor.
Si des dépendances sont manquantes, le Toolkit ne fonctionnera très probablement pas.

Configuration

La section Configuration contient des informations sur les fichiers du répertoire config/. Pour config/overleaf.rc, le doctor affiche quelques valeurs clés. Les fichiers manquants sont indiqués avec status: MISSING! et un avertissement est ajouté à la fin de la sortie de doctor.
Remarques sur l’exemple ci-dessus :
  • OVERLEAF_DATA_PATH défini sur /tmp/overleaf n’est peut-être pas un emplacement sûr pour des données importantes.
  • MONGO_ENABLED: false signifie que le Toolkit ne provisionnera pas sa propre instance MongoDB ; si nécessaire, assurez-vous que MONGO_URL pointe vers une instance MongoDB gérée en externe.
  • config/variables.env est absent dans cet exemple.

Avertissements

La section Warnings résume les problèmes détectés par le script doctor. S’il n’y a aucun problème, cette section l’indique.

Q&A

Réponse : Non, ces trois messages sont purement informatifs. bin/doctor ne fait qu’afficher un rapport ; il n’empêche pas bin/up de fonctionner.
  • logged in to quay.io: false et l’avertissement Server Pro enabled, but not logged in to quay.io repository : cette vérification provient du Toolkit officiel, dans lequel l’image Server Pro se trouve sur un registre quay.io privé. Avec SERVER_PRO=true, le Toolkit récupère ghcr.io/ayaka-notes/overleaf-pro, qui est public ; aucune connexion n’est donc nécessaire. Ignorez cet avertissement.
  • grep: /root/.docker/config.json: No such file or directory (ou un autre répertoire personnel) : la vérification quay.io recherche quay.io dans ce fichier. Docker ne l’écrit que lorsqu’il a des paramètres à enregistrer, par exemple après docker login ; il est donc absent sur de nombreux serveurs. Il n’est pas nécessaire.
  • perl: warning: Setting locale failed : le Toolkit n’utilise perl qu’ici, dans bin/doctor, pour afficher sa version, et Perl émet un avertissement lorsque LANG ou LC_ALL désigne une locale qui n’est pas installée sur l’hôte. La version est tout de même affichée. Pour le faire disparaître, définissez ces variables sur une locale listée par locale -a, par exemple C.UTF-8.
Les avertissements tels que Docker daemon is not running, docker not found, Docker Compose not found ou un fichier manquant dans config/ doivent en revanche être corrigés : le Toolkit ne peut pas démarrer sans eux.
Dernière modification le 2 novembre 2026