diff --git a/README.md b/README.md index 99c1aec..f1f9121 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,126 @@ # arte-dl -Web GUI pour parcourir et télécharger les concerts Arte Concert \ No newline at end of file +Web GUI pour parcourir et télécharger les concerts Arte Concert. + +- Navigation par catégorie (Metal, Jazz, Classique, Opéra…) +- Téléchargement en WEB-DL avec nommage scène (`-ReMoRa`) +- Enrichissement TMDB (poster, backdrop) +- Auto-téléchargement par catégorie (souscription persistante) + +--- + +## Déploiement + +### Prérequis + +- Docker + Docker Compose +- Une clé API TMDB (gratuite sur [themoviedb.org](https://www.themoviedb.org/settings/api)) + +### Docker Compose (générique) + +```yaml +services: + arte-dl: + image: forge.dilain.com/laurent/arte-dl:latest + container_name: arte-dl + restart: unless-stopped + ports: + - "8085:8080" + volumes: + - /chemin/vers/media/Arte:/data/Arte # fichiers téléchargés + - /chemin/vers/appdata/arte-dl:/app/data # base SQLite + environment: + - TZ=Europe/Paris + - TMDB_API_KEY=your_tmdb_api_key +``` + +```bash +docker compose up -d +``` + +L'interface est accessible sur `http://localhost:8085`. + +--- + +### Déploiement sur Unraid + +#### Via le Community Applications (template manuel) + +1. Dans Unraid, aller dans **Docker** → **Add Container** +2. Remplir les champs : + +| Champ | Valeur | +|-------|--------| +| Name | `arte-dl` | +| Repository | `forge.dilain.com/laurent/arte-dl:latest` | +| Network Type | `bridge` | +| Port (Host→Container) | `8085 → 8080` | + +3. Ajouter les **Path mappings** : + +| Name | Container Path | Host Path | Access | +|------|---------------|-----------|--------| +| Media | `/data/Arte` | `/mnt/user/data/Arte` | Read/Write | +| Config | `/app/data` | `/mnt/user/appdata/arte-dl` | Read/Write | + +4. Ajouter les **variables d'environnement** : + +| Name | Value | +|------|-------| +| `TZ` | `Europe/Paris` | +| `TMDB_API_KEY` | `` | +| `AUTO_DL_INTERVAL` | `3600` *(optionnel, intervalle auto-DL en secondes)* | + +5. Cliquer **Apply** + +#### Via docker-compose sur Unraid + +Copier le fichier `docker-compose.yml` dans `/mnt/user/appdata/arte-dl/` et lancer : + +```bash +cd /mnt/user/appdata/arte-dl +TMDB_API_KEY=xxx docker compose up -d +``` + +#### Volumes Unraid + +``` +/mnt/user/data/Arte → /data/Arte (concerts téléchargés, par sous-dossier de catégorie) +/mnt/user/appdata/arte-dl → /app/data (arte_dl.db — souscriptions, historique, cache TMDB) +``` + +> **Note :** Le dossier `/data/Arte` est créé automatiquement au premier téléchargement. +> Les sous-dossiers de catégorie (`/data/Arte/Metal/`, `/data/Arte/Jazz/`…) sont créés selon la catégorie active lors du téléchargement. + +--- + +## Variables d'environnement + +| Variable | Défaut | Description | +|----------|--------|-------------| +| `TMDB_API_KEY` | — | Clé API TMDB (obligatoire pour posters/backdrops) | +| `TZ` | `UTC` | Fuseau horaire | +| `AUTO_DL_INTERVAL` | `3600` | Intervalle (secondes) entre deux checks auto-DL | + +--- + +## Auto-téléchargement + +Chaque pill de catégorie dispose d'un bouton **⬇** : +- Clic sur **⬇** → souscription activée (icône dorée) +- Les nouveaux concerts de cette catégorie sont téléchargés automatiquement toutes les `AUTO_DL_INTERVAL` secondes +- Les souscriptions sont persistées en base SQLite (survivent aux redémarrages) +- Déclenchement immédiat possible via `POST /api/auto-dl/check` + +--- + +## Build local + +```bash +docker build -t arte-dl . +docker run -p 8085:8080 \ + -v /chemin/Arte:/data/Arte \ + -v /chemin/data:/app/data \ + -e TMDB_API_KEY=xxx \ + arte-dl +```