# Exemple de documentation : NomDuService

NomDuService est un service dont la fonction principale est de [décrire brièvement le rôle du service, ex. : générer des images, traiter des données, héberger une base, etc.].


## 1. Prérequis
- Docker >= 20.x
- NVIDIA Container Toolkit, si le conteneur exploite le GPU (optionnel)

## 2. Arborescence des répertoires

Les volumes suivants sont utilisés afin de persister les données :

```bash
mkdir -p /home/docker/srv/nomduservice/{entrees,modeles,resultats}
chown -R 1000:1000 /home/docker/srv/nomduservice
```

| Répertoire hôte                           | Répertoire dans le conteneur              | Description                  |
|------------------------------------------|-------------------------------------------|------------------------------|
| `/home/docker/srv/nomduservice/entrees`  | `/app/entrees`                            | Fichiers d’entrée            |
| `/home/docker/srv/nomduservice/modeles`  | `/app/modeles`                            | Modèles utilisés             |
| `/home/docker/srv/nomduservice/resultats`| `/app/resultats`                          | Résultats générés            |

## 3. Exemple de configuration `docker-compose.yml`

```yaml
services:
  nomduservice:
    image: exemple/image:latest
    container_name: nomduservice
    ports:
      - "8080:8080"
    environment:
      TZ: "Europe/Paris"
      PUID: "1000"
      PGID: "1000"
    restart: unless-stopped
    volumes:
      - /home/docker/srv/nomduservice/entrees:/app/entrees
      - /home/docker/srv/nomduservice/modeles:/app/modeles
      - /home/docker/srv/nomduservice/resultats:/app/resultats
```

## 4. Accès

- URL d’accès local : `http://localhost:8080` (à adapter selon l’environnement)

## 5. Documentation complémentaire

- Image Docker : *à renseigner*
- Référentiel Git : *à renseigner*
- Documentation officielle : *à renseigner*