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

# 2. Familiarisez-vous avec le Toolkit

### Faire le tour

Maintenant que vous disposez d'une copie locale du Toolkit, examinons la structure du dépôt à l'aide de la commande `ls`.

```bash title="Run this" theme={null}
ls -l
```

> [!NOTE]
>
> La commande `ls -l` affiche une liste détaillée du contenu d'un répertoire, avec des informations supplémentaires sur les fichiers telles que les permissions, le propriétaire et la taille.

Si tout a été cloné correctement, vous devriez voir quelque chose comme ceci :

```text theme={null}
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 bin
-rw-r--r-- 1 fry fry  6465 Aug 30 14:16 CHANGELOG.md
drwxr-xr-x 2 fry fry  4096 Sep  6 12:43 config
drwxr-xr-x 5 fry fry  4096 Aug 30 14:22 data
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 doc
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 lib
-rw-r--r-- 1 fry fry 34520 Aug 30 14:16 LICENSE
-rw-r--r-- 1 fry fry  1178 Aug 30 14:16 README.md
```

> [!NOTE]
>
> Tous les fichiers de configuration appartenant à l'utilisateur se trouvent dans le répertoire `config/`. Ce répertoire est **exclu** du système de gestion de versions git ; il ne sera donc pas modifié lors de la mise à jour du Toolkit.

## Organisation du dépôt

| Nom | Description |
| - | - |
| `bin` | Ce dossier contient un ensemble de scripts qui vous aident à gérer votre instance de serveur Overleaf. Vous pouvez en savoir plus sur ces scripts dans la section Commandes ci-dessous. |
| `config` | Ce dossier contient vos propres fichiers de configuration locaux. |
| `lib` | Ce dossier contient les fichiers de configuration de base utilisés par le Toolkit. |
| `data` | Par défaut, ce dossier contient l'emplacement de stockage de MongoDb, Redis et Overleaf. Pour plus d'informations, consultez la section [Données persistantes](https://ayakaleaf-pro.mintlify.site/fr/on-premises/configuration/overleaf-toolkit/files-and-locations.md#persistent-data) ci-dessous. |

> [!WARNING]
>
> Nous recommandons de **ne pas** modifier directement les fichiers situés en dehors du dossier `/config`. Si vous devez apporter des modifications, faites-le plutôt via des variables d'environnement définies dans **config/variables.env** ou **config/overleaf.rc**.\
> Par exemple, pour définir l'image du service `mongo`, au lieu de modifier directement `lib/docker-compose.mongo.yml`, définissez l'image à l'aide de la variable d'environnement `MONGO_IMAGE` dans `config/overleaf.rc`. Pour plus d'informations, consultez la page [Paramètres du Toolkit](https://ayakaleaf-pro.mintlify.site/fr/on-premises/configuration/overleaf-toolkit/toolkit-settings.md).

> [!NOTE]
>
> Le Toolkit ne modifiera **aucune** donnée du répertoire `config/` sans votre autorisation.

## Commandes

Exécutez ces scripts depuis le répertoire du Toolkit. Chacun affiche ses options avec `--help`.

| Commande | Rôle |
| - | - |
| `bin/init` | Crée les fichiers de configuration dans `config/` lors de la première utilisation. `bin/init --tls` ajoute la configuration du proxy TLS NGINX. |
| `bin/up` | Crée et démarre les conteneurs (`bin/docker-compose up`). Ajoutez `-d` pour l'exécuter en arrière-plan au lieu de suivre les journaux. Exécutez-le après chaque modification dans `config/` : il recrée les conteneurs dont la configuration a changé. |
| `bin/start` | Redémarre les conteneurs existants (`bin/docker-compose start`). N'applique pas les modifications de configuration. |
| `bin/stop` | Arrête les conteneurs et les conserve (`bin/docker-compose stop`). |
| `bin/docker-compose` | Exécute `docker compose` avec les fichiers du Toolkit, par exemple `bin/docker-compose ps` ou `bin/docker-compose restart sharelatex`. |
| `bin/logs` | Affiche ou suit les journaux d'un ou plusieurs services, par exemple `bin/logs -f web`. |
| `bin/error-logs` | Comme `bin/logs`, mais n'affiche que les erreurs. |
| `bin/shell` | Ouvre un shell dans le conteneur `sharelatex`. |
| `bin/mongo` | Ouvre un shell MongoDB sur la base de données `sharelatex`. |
| `bin/run-script` | Exécute un script fourni dans le conteneur `sharelatex`. |
| `bin/doctor` | Vérifie l'hôte et la configuration, et affiche un rapport à partager lorsque vous demandez de l'aide. |
| `bin/images` | Liste les images Docker d'Overleaf présentes sur l'hôte. |
| `bin/backup-config` | Copie le répertoire `config/` vers un emplacement de sauvegarde (copie, zip ou tar). |
| `bin/upgrade` | Met à jour le Toolkit et l'image Overleaf étape par étape, voir [Mettre à niveau votre déploiement](https://ayakaleaf-pro.mintlify.site/fr/on-premises/maintenance/upgrading-your-deployment.md). |
| `bin/rename-env-vars-5-0`, `bin/rename-rc-vars` | Migrations ponctuelles des anciens noms de variables `SHARELATEX_*` vers `OVERLEAF_*`. |

> [!WARNING]
>
> Lorsque `bin/up` recrée un conteneur, tout ce qui a été modifié à l'intérieur est perdu, par exemple les paquets installés ou les fichiers modifiés via `bin/shell`. Seuls les répertoires de données (`data/` par défaut) et `config/` sont conservés. Effectuez plutôt les modifications durables via `config/variables.env`, `config/overleaf.rc` ou `config/docker-compose.override.yml`.

> [!NOTE]
>
> Si chaque `bin/up` déconnecte tous les utilisateurs, définissez `OVERLEAF_SESSION_SECRET`. Sans elle, les cookies de session sont signés avec un secret régénéré à chaque recréation du conteneur, voir les questions/réponses dans [Variables d'environnement](https://ayakaleaf-pro.mintlify.site/fr/on-premises/configuration/overleaf-toolkit/environment-variables.md).


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