> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Obtenir de l'aide

### 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.

<Info>
  Les utilisateurs d'Overleaf Pro peuvent [ouvrir une issue sur GitHub](https://github.com/ayaka-notes/overleaf/issues).

  Il est conseillé d'inclure la sortie du script `bin/doctor` dans votre message.
</Info>

### Consulter le Doctor

Exécutez le script doctor :

```bash title="Run doctor" theme={null}
bin/doctor
```

Vous verrez une sortie semblable à l'exemple ci-dessous.

<Accordion title="Exemple de sortie complète">
  ```text theme={null}
  ====== 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 28.0.4, build b8034c0
      - docker compose
          - status: present
          - version info: Docker Compose version v2.34.0
      - realpath
          - status: present
          - version info: realpath (GNU coreutils) 8.32
      - perl
          - status: present
          - version info: 5.034000
      - awk
          - status: present
          - version info: mawk 1.3.4 20200120
  - Docker Daemon
      - status: up
  ====== Configuration ======
  - config/version
      - status: present
      - version: 5.4.0
  - config/overleaf.rc
      - status: present
      - values
          - OVERLEAF_DATA_PATH: data/overleaf
          - OVERLEAF_LOG_PATH: data/overleaf/logs
          - SERVER_PRO: true
          - SIBLING_CONTAINERS_ENABLED: true
              - logged in to quay.io: true
          - MONGO_ENABLED: true
          - REDIS_ENABLED: true
  - config/variables.env
      - status: present
      - values
          - OVERLEAF_FILESTORE_BACKEND: fs
          - OVERLEAF_HISTORY_BACKEND: fs

  ====== Warnings ======
  - None, all good
  ====== End ======
  ```
</Accordion>

### 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).

<Accordion title="Exemple de sortie Host Information">
  ```text theme={null}
  - 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
  ```
</Accordion>

### 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`.

<Accordion title="Exemple de sortie Dependency (présente)">
  ```text theme={null}
  - docker
      - status: present
      - version info: Docker version 28.0.4, build b8034c0
  ```
</Accordion>

<Accordion title="Exemple de sortie Dependency (manquante)">
  ```text theme={null}
  - docker
      - status: MISSING!
  ```
</Accordion>

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`.

<Accordion title="Exemple de sortie Configuration">
  ```text theme={null}
  ====== Configuration ======
  - config/version
      - status: present
      - version: 5.4.0
  - config/overleaf.rc
      - status: present
      - values
          - OVERLEAF_DATA_PATH: /tmp/overleaf
          - SERVER_PRO: false
          - MONGO_ENABLED: false
          - REDIS_ENABLED: true
  - config/variables.env
      - status: MISSING!
  ```
</Accordion>

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.

<Accordion title="Exemple de sortie Warnings">
  ```text theme={null}
  ====== Warnings ======
  - configuration file variables.env not found
  - rc file, OVERLEAF_DATA_PATH not set
  ====== End =======
  ```
</Accordion>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.