Remove obsolete changelog, guides, specs and TODO files
This commit is contained in:
@@ -33,7 +33,7 @@
|
||||
- [Variables d'environnement](#-variables-denvironnement)
|
||||
- [🔒 Authentification](#-authentification)
|
||||
- [Ajouter une nouvelle vault](#-ajouter-une-nouvelle-vault)
|
||||
- [Build multi-platform](#-build-multi-platform)
|
||||
- [Build & déploiement avec build.sh](#-build--déploiement-avec-buildsh)
|
||||
- [Utilisation](#-utilisation)
|
||||
- [API](#-api)
|
||||
- [Performance](#-performance)
|
||||
@@ -104,14 +104,16 @@ volumes:
|
||||
### 3. Lancer l'application
|
||||
|
||||
```bash
|
||||
# Build local de l'image + démarrage
|
||||
docker compose up -d --build
|
||||
# Rendre le script exécutable (une seule fois)
|
||||
chmod +x build.sh
|
||||
|
||||
# Vérifier les logs
|
||||
docker compose logs -f obsigate
|
||||
# Build + déploiement en une commande
|
||||
./build.sh
|
||||
```
|
||||
|
||||
> **Note** : ObsiGate est construit localement depuis le `Dockerfile` du projet. Sans build local, Docker essaiera de télécharger une image distante `obsigate:latest` qui n'existe pas forcément.
|
||||
> **C'est tout !** `build.sh` vérifie Docker, contrôle vos volumes, construit l'image et démarre le conteneur automatiquement.
|
||||
>
|
||||
> Options utiles : `./build.sh --help` pour l'aide, `./build.sh --cache` pour un rebuild plus rapide, `./build.sh --build-only` pour construire sans démarrer.
|
||||
|
||||
### 4. Accéder à l'interface
|
||||
|
||||
@@ -156,20 +158,22 @@ services:
|
||||
- VAULT_3_PATH=/vaults/Perso
|
||||
```
|
||||
|
||||
### Étape 3 : Construction de l'image
|
||||
### Étape 3 : Build & déploiement
|
||||
|
||||
```bash
|
||||
# Build l'image Docker
|
||||
docker build -t obsigate:latest .
|
||||
|
||||
# Puis démarrer le service
|
||||
docker-compose up -d --build
|
||||
|
||||
# Ou utilisez le script de build multi-platform
|
||||
# Utilisez le script de build automatisé (recommandé)
|
||||
chmod +x build.sh
|
||||
./build.sh
|
||||
```
|
||||
|
||||
Le script `build.sh` gère tout : vérification des prérequis, validation des volumes, construction de l'image et démarrage.
|
||||
|
||||
**Alternative manuelle :**
|
||||
```bash
|
||||
docker compose build --no-cache
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
> **Compatibilité Docker** : l'image utilise la variante minimale de `uvicorn` et une version de `fastapi` compatible (`0.110.3`) afin d'éviter certaines dépendances optionnelles natives (`watchfiles`, `uvloop`, `httptools`, `fastapi-cli`, etc.) qui peuvent échouer au build sur certaines plateformes comme Alpine, ARM ou i386.
|
||||
|
||||
---
|
||||
@@ -308,7 +312,7 @@ volumes:
|
||||
|
||||
4. **Redémarrez** :
|
||||
```bash
|
||||
docker-compose up -d --build
|
||||
./build.sh
|
||||
```
|
||||
|
||||
### Méthode 2 : Hot-reload (recommandé)
|
||||
@@ -316,7 +320,7 @@ volumes:
|
||||
1. **Ajoutez le volume et les variables** comme ci-dessus
|
||||
2. **Appliquez les changements** :
|
||||
```bash
|
||||
docker-compose up -d --build
|
||||
./build.sh
|
||||
```
|
||||
3. **Rechargez l'index** via l'interface ou l'API :
|
||||
```bash
|
||||
@@ -339,27 +343,59 @@ curl -X DELETE http://localhost:2020/api/vaults/NouvelleVault
|
||||
|
||||
---
|
||||
|
||||
## 🔨 Build multi-platform
|
||||
## 🔨 Build & déploiement avec build.sh
|
||||
|
||||
Pour les architectures multiples (Raspberry Pi, NAS, etc.) :
|
||||
Le script `build.sh` est la méthode recommandée pour construire et déployer ObsiGate.
|
||||
|
||||
### Utilisation de base
|
||||
|
||||
```bash
|
||||
# Rendre le script exécutable
|
||||
chmod +x build.sh
|
||||
|
||||
# Lancer le build multi-platform
|
||||
./build.sh
|
||||
chmod +x build.sh # une seule fois
|
||||
./build.sh # build from scratch + démarrage
|
||||
```
|
||||
|
||||
**Architectures supportées :**
|
||||
- `linux/amd64` (PC, serveurs standards)
|
||||
- `linux/arm64` (Raspberry Pi 4, Apple Silicon, NAS modernes)
|
||||
- `linux/arm/v7` (Raspberry Pi 3, anciens NAS)
|
||||
- `linux/386` (Systèmes 32-bit legacy)
|
||||
### Options disponibles
|
||||
|
||||
| Option | Description |
|
||||
|--------|-------------|
|
||||
| `--help`, `-h` | Affiche l'aide complète |
|
||||
| `--build-only` | Construit l'image sans démarrer le conteneur |
|
||||
| `--no-cache` | Rebuild complet sans cache Docker **(défaut)** |
|
||||
| `--cache` | Utilise le cache Docker (plus rapide si peu de changements) |
|
||||
| `--progress=plain` | Sortie verbeuse (recommandé pour le debug) |
|
||||
| `--progress=tty` | Sortie interactive avec barres de progression |
|
||||
|
||||
### Ce que fait le script
|
||||
|
||||
1. **Vérifie** que Docker et Docker Compose sont installés (avec numéros de version)
|
||||
2. **Valide** la présence et la syntaxe du fichier `docker-compose.yml`
|
||||
3. **Vérifie chaque volume** monté : avertit si un répertoire source n'existe pas
|
||||
4. **Construit** l'image Docker via `docker compose build` (multi-stage, ~180MB)
|
||||
5. **Démarre** le conteneur via `docker compose up -d`
|
||||
6. **Affiche** le statut du conteneur puis les logs en temps réel
|
||||
|
||||
### Exemples
|
||||
|
||||
**Pour un build local uniquement :**
|
||||
```bash
|
||||
docker buildx build --platform linux/amd64 --load -t obsigate:latest .
|
||||
# Build propre + démarrage (recommandé après changement de code)
|
||||
./build.sh
|
||||
|
||||
# Rebuild rapide avec cache (changements mineurs frontend uniquement)
|
||||
./build.sh --cache
|
||||
|
||||
# Vérifier le build sans démarrer (pratique pour tester avant mise en prod)
|
||||
./build.sh --build-only
|
||||
|
||||
# Sortie verbeuse pour débugger un échec de build
|
||||
./build.sh --progress=plain
|
||||
```
|
||||
|
||||
### Arrêter / redémarrer
|
||||
|
||||
```bash
|
||||
docker compose down # Arrêter le conteneur
|
||||
docker compose up -d # Redémarrer sans rebuild
|
||||
docker compose logs -f # Voir les logs
|
||||
```
|
||||
|
||||
---
|
||||
@@ -565,20 +601,22 @@ ports:
|
||||
|
||||
**Build échoue :**
|
||||
```bash
|
||||
# Nettoyer et rebuild
|
||||
# Nettoyer le cache Docker et rebuild
|
||||
docker system prune -f
|
||||
docker-compose down
|
||||
docker build --no-cache -t obsigate:latest .
|
||||
docker-compose up -d
|
||||
docker compose down
|
||||
./build.sh --progress=plain
|
||||
|
||||
# Si l'échec persiste, vérifier les logs de build
|
||||
./build.sh --progress=plain 2>&1 | tee build.log
|
||||
```
|
||||
|
||||
**Logs pour debugging :**
|
||||
```bash
|
||||
# Logs en temps réel
|
||||
docker-compose logs -f obsigate
|
||||
docker compose logs -f obsigate
|
||||
|
||||
# Logs détaillés
|
||||
docker-compose logs --tail=100 obsigate
|
||||
docker compose logs --tail=100 obsigate
|
||||
```
|
||||
|
||||
---
|
||||
@@ -710,7 +748,7 @@ ObsiGate/
|
||||
│ └── secret.key # Clé secrète JWT (512 bits)
|
||||
├── Dockerfile # Multi-stage, healthcheck, non-root
|
||||
├── docker-compose.yml # Déploiement avec healthcheck et auth env vars
|
||||
├── build.sh # Build multi-platform (amd64/arm64/arm/v7/i386)
|
||||
├── build.sh # Build & déploiement automatisé (docker compose build + up)
|
||||
└── CONTRIBUTING.md # Guide de contribution
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user