Le Doctor
Le Toolkit Overleaf est fourni avec un scriptdoctor 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
Exemple de sortie complète
Exemple de sortie complète
Informations sur l’hôte
La sectionHost Information contient des informations sur la machine qui exécute le Toolkit (par exemple, la distribution Linux et sa version).
Exemple de sortie Host Information
Exemple de sortie Host Information
Dépendances
La sectionDependencies 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.
Exemple de sortie Dependency (présente)
Exemple de sortie Dependency (présente)
Exemple de sortie Dependency (manquante)
Exemple de sortie Dependency (manquante)
Configuration
La sectionConfiguration 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.
Exemple de sortie Configuration
Exemple de sortie Configuration
OVERLEAF_DATA_PATHdéfini sur/tmp/overleafn’est peut-être pas un emplacement sûr pour des données importantes.MONGO_ENABLED: falsesignifie que le Toolkit ne provisionnera pas sa propre instance MongoDB ; si nécessaire, assurez-vous queMONGO_URLpointe vers une instance MongoDB gérée en externe.config/variables.envest absent dans cet exemple.
Avertissements
La sectionWarnings résume les problèmes détectés par le script doctor. S’il n’y a aucun problème, cette section l’indique.
Exemple de sortie Warnings
Exemple de sortie Warnings
Q&A
Les messages concernant quay.io, la configuration Docker et la locale Perl affichés par bin/doctor doivent-ils être corrigés ?
Les messages concernant quay.io, la configuration Docker et la locale Perl affichés par bin/doctor doivent-ils être corrigés ?
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: falseet l’avertissementServer 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é. AvecSERVER_PRO=true, le Toolkit récupèreghcr.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 recherchequay.iodans ce fichier. Docker ne l’écrit que lorsqu’il a des paramètres à enregistrer, par exemple aprèsdocker login; il est donc absent sur de nombreux serveurs. Il n’est pas nécessaire.perl: warning: Setting locale failed: le Toolkit n’utiliseperlqu’ici, dansbin/doctor, pour afficher sa version, et Perl émet un avertissement lorsqueLANGouLC_ALLdé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 parlocale -a, par exempleC.UTF-8.
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.
