> 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/assistance/getting-help.md).

# Obtenir de l’aide

### Le doctor

L’Overleaf Toolkit est fourni avec un pratique `script doctor` pour aider au débogage. Exécutez `bin/doctor` et le script affichera des informations sur votre environnement hôte, votre configuration et les dépendances requises par le Toolkit. Cette sortie peut également aider l’équipe de support Overleaf à diagnostiquer les problèmes des installations Server Pro.

{% hint style="info" %}
Les utilisateurs d’Overleaf Pro peuvent [ouvrir une issue sur GitHub](https://github.com/ayaka-notes/overleaf/issues).

il est judicieux d’inclure la sortie du `bin/doctor` script dans votre message.
{% endhint %}

### Consulter le doctor <a href="#consulting-with-the-doctor" id="consulting-with-the-doctor"></a>

Exécutez le script doctor :

{% code title="Exécuter doctor" %}

```bash
bin/doctor
```

{% endcode %}

Vous verrez une sortie similaire à l’exemple ci-dessous.

<details>

<summary>Exemple de sortie complète</summary>

```
====== 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 28.0.4, build b8034c0
    - docker compose
        - état : présent
        - informations de version : Docker Compose version v2.34.0
    - 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 : mawk 1.3.4 20200120
- démon Docker
    - état : en cours d'exécution
====== Configuration ======
- config/version
    - état : présent
    - version : 5.4.0
- config/overleaf.rc
    - état : présent
    - valeurs
        - OVERLEAF_DATA_PATH : data/overleaf
        - OVERLEAF_LOG_PATH : data/overleaf/logs
        - SERVER_PRO : true
        - SIBLING_CONTAINERS_ENABLED : true
            - connecté à quay.io : true
        - MONGO_ENABLED : true
        - REDIS_ENABLED : true
- config/variables.env
    - état : présent
    - valeurs
        - OVERLEAF_FILESTORE_BACKEND : fs
        - OVERLEAF_HISTORY_BACKEND : fs

====== Avertissements ======
- Aucun, tout va bien
====== Fin ======
```

</details>

### Informations sur l’hôte

Le `Informations sur l’hôte` cette section contient des informations sur la machine exécutant le Toolkit (par exemple, la distribution Linux et sa version).

<details>

<summary>Exemple de sortie des informations sur l’hôte</summary>

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

</details>

### Dépendances

Le `Dépendances` cette section liste les outils requis pour que le Toolkit fonctionne. Si un outil est présent, il sera répertorié comme `état : présent` avec les informations de version. S’il est absent, il sera répertorié comme `état : MANQUANT !` et un avertissement sera ajouté au bas de la `script doctor` sortie.

<details>

<summary>Exemple de sortie des dépendances (présent)</summary>

```
- docker
    - état : présent
    - informations de version : Docker version 28.0.4, build b8034c0
```

</details>

<details>

<summary>Exemple de sortie des dépendances (manquant)</summary>

```
- docker
    - état : MANQUANT !
```

</details>

Si des dépendances manquent, le Toolkit ne fonctionnera presque certainement pas.

### Configuration

Le `Configuration` cette section contient des informations sur les fichiers dans le `répertoire config/` répertoire. Pour `config/overleaf.rc`, le doctor affiche certaines valeurs clés. Les fichiers manquants seront répertoriés comme `état : MANQUANT !` et un avertissement sera ajouté au bas de la `script doctor` sortie.

<details>

<summary>Exemple de sortie de configuration</summary>

```
====== Configuration ======
- config/version
    - état : présent
    - version : 5.4.0
- config/overleaf.rc
    - état : présent
    - valeurs
        - OVERLEAF_DATA_PATH : /tmp/overleaf
        - SERVER_PRO : false
        - MONGO_ENABLED : false
        - REDIS_ENABLED : true
- config/variables.env
    - état : MANQUANT !
```

</details>

Remarques à partir de l’exemple ci-dessus :

* `variable d’environnement OVERLEAF_DATA_PATH` défini sur `/tmp/overleaf` peut ne pas être un emplacement sûr pour des données importantes.
* `MONGO_ENABLED : false` signifie que le Toolkit ne provisionnera pas son propre MongoDB ; assurez-vous que `MONGO_URL` pointe vers un MongoDB géré de manière externe si nécessaire.
* `config/variables.env` est absent dans l’exemple.

### Avertissements

Le `Avertissements` cette section résume les problèmes détectés par le script doctor. S’il n’y a aucun problème, cette section l’indiquera.

<details>

<summary>Exemple de sortie des avertissements</summary>

```
====== Avertissements ======
- fichier de configuration variables.env introuvable
- fichier rc, OVERLEAF_DATA_PATH non défini
====== Fin =======
```

</details>


---

# 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/assistance/getting-help.md?ask=<question>&goal=<endgoal>
```

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