Files
LiveFlow/README.md
T

90 lines
3.2 KiB
Markdown

# 🎙️ LiveFlow
Transcription de réunions **en direct**, **100 % locale**, dans Docker.
Capture du micro depuis un navigateur (PC ou téléphone), transcription par
**Qwen3-ASR** sur GPU NVIDIA, affichage du texte au fil de l'eau, historique
et export (TXT, Markdown, SRT, JSON).
Architecture détaillée : voir [ARCHITECTURE.md](ARCHITECTURE.md) (proposition 2 retenue).
```
Navigateur (micro, HTTPS/WebSocket)
→ Caddy (TLS local)
→ app FastAPI (VAD + segments + SQLite + interface web)
→ conteneur ASR Qwen3-ASR via vLLM (API compatible OpenAI)
```
## Prérequis
- Docker + Docker Compose
- GPU NVIDIA avec pilotes récents et le
[NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html)
(`nvidia-ctk runtime configure --runtime=docker`)
- ~6 Go de VRAM libres pour Qwen3-ASR-1.7B (ajuster `--gpu-memory-utilization`)
## Démarrage
```bash
docker compose up -d --build
```
Au premier lancement, le conteneur `asr` télécharge le modèle depuis
Hugging Face (quelques Go, mis en cache dans un volume). Suivre avec :
```bash
docker compose logs -f asr
```
Puis ouvrir **https://\<ip-du-serveur\>** depuis un PC ou un téléphone du
réseau local, accepter le certificat auto-signé, autoriser le micro, et
cliquer sur **Démarrer**.
> ⚠️ Le HTTPS est obligatoire : les navigateurs n'autorisent l'accès au micro
> (`getUserMedia`) qu'en HTTPS (ou sur `localhost`). Caddy génère
> automatiquement un certificat local auto-signé. Pour supprimer
> l'avertissement du navigateur, vous pouvez installer la CA racine de Caddy
> sur vos appareils : `docker compose cp caddy:/data/caddy/pki/authorities/local/root.crt .`
## Unraid
Un compose dédié est fourni : [`docker-compose.unraid.yml`](docker-compose.unraid.yml)
(chemins `appdata`, GPU via `runtime: nvidia`, ports 8088/8443 car 80/443 sont
pris par l'interface Unraid). Prérequis : plugins **Nvidia Driver** et
**Docker Compose Manager**. Cloner le dépôt dans `/mnt/user/appdata/liveflow`,
créer une stack pointant sur ce fichier, puis ouvrir `https://<ip-unraid>:8443`.
## Configuration
Variables d'environnement (fichier `.env` à la racine, voir `.env.example`) :
| Variable | Défaut | Rôle |
|---|---|---|
| `ASR_LANGUAGE` | *(vide)* | Code langue forcé (`fr`, `en`…) ; vide = détection auto |
| `ASR_API_KEY` | `sk-local` | Clé envoyée au moteur ASR (inutile en local) |
| `HF_TOKEN` | *(vide)* | Jeton Hugging Face si nécessaire au téléchargement |
## Changer de moteur de transcription
L'app ne parle au moteur que via l'API OpenAI (`/v1/audio/transcriptions`).
Pour changer de moteur, remplacer le service `asr` dans `docker-compose.yml`
et ajuster `ASR_MODEL`. Exemples :
```yaml
# CPU uniquement — Parakeet-TDT-0.6B-v3 (rapide, 25 langues dont FR)
asr:
image: ghcr.io/groxaxo/parakeet-tdt-0.6b-v3-fastapi-openai:latest
# Écosystème Whisper — Speaches (faster-whisper, CPU/GPU)
asr:
image: ghcr.io/speaches-ai/speaches:latest-cuda
```
## Récupérer une transcription
Depuis l'interface (boutons TXT / MD / SRT / JSON / Copier) ou en direct via l'API :
```bash
curl -k https://<ip>/api/meetings # liste des réunions
curl -k https://<ip>/api/meetings/1/export?format=txt # export texte
```