feat: Ajout configuration Docker complète pour v2
✨ Fichiers Docker ajoutés: - backend/Dockerfile: Image Python 3.11 avec uv et FastAPI - frontend/Dockerfile: Build multi-stage avec Nginx - docker-compose.yml: Orchestration complète des services - frontend/nginx.conf: Configuration Nginx avec proxy API 📝 Documentation: - DOCKER.md: Guide complet de déploiement Docker (monitoring, backup, prod) - README.md: Section Docker ajoutée - .env.docker: Template mis à jour pour v2 🔧 Configuration: - .dockerignore pour backend et frontend - Volume data/ pour la base de données - Healthchecks pour les deux services - Réseau bridge dédié 🚀 Démarrage simplifié: cp .env.docker .env docker-compose up -d Accès: http://localhost (frontend) + http://localhost:8000 (API)
This commit is contained in:
423
DOCKER.md
Normal file
423
DOCKER.md
Normal file
@@ -0,0 +1,423 @@
|
||||
# 🐳 Déploiement Docker - Notytex v2
|
||||
|
||||
Guide complet pour déployer Notytex avec Docker et Docker Compose.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Démarrage Rapide
|
||||
|
||||
### Prérequis
|
||||
|
||||
- Docker 20.10+
|
||||
- Docker Compose 2.0+
|
||||
|
||||
### Installation en 3 commandes
|
||||
|
||||
```bash
|
||||
# 1. Configurer l'environnement
|
||||
cp .env.docker .env
|
||||
# Éditez .env et changez SECRET_KEY !
|
||||
|
||||
# 2. Créer le répertoire de données
|
||||
mkdir -p data
|
||||
cp school_management.db data/
|
||||
|
||||
# 3. Démarrer les services
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
**Accès :**
|
||||
- Frontend : http://localhost
|
||||
- API : http://localhost:8000
|
||||
- Documentation API : http://localhost:8000/api/v2/docs
|
||||
|
||||
---
|
||||
|
||||
## 📂 Architecture Docker
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────┐
|
||||
│ Nginx:80 │
|
||||
│ (Frontend Vue.js) │
|
||||
└────────────────┬────────────────────────────────┘
|
||||
│
|
||||
│ Proxy /api → backend:8000
|
||||
│
|
||||
┌────────────────▼────────────────────────────────┐
|
||||
│ FastAPI:8000 │
|
||||
│ (Backend Python) │
|
||||
└────────────────┬────────────────────────────────┘
|
||||
│
|
||||
│ SQLite
|
||||
│
|
||||
┌────────────────▼────────────────────────────────┐
|
||||
│ Volume: ./data │
|
||||
│ (Base de données SQLite) │
|
||||
└─────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Configuration
|
||||
|
||||
### Variables d'Environnement
|
||||
|
||||
Éditez le fichier `.env` :
|
||||
|
||||
```bash
|
||||
# Clé secrète (OBLIGATOIRE - générez-en une nouvelle !)
|
||||
SECRET_KEY=votre-cle-secrete-unique-min-32-chars
|
||||
|
||||
# Base de données
|
||||
DATABASE_URL=sqlite+aiosqlite:////data/school_management.db
|
||||
|
||||
# CORS (ajoutez vos domaines)
|
||||
CORS_ORIGINS=["http://localhost","https://votre-domaine.com"]
|
||||
|
||||
# Email (optionnel)
|
||||
SMTP_HOST=smtp.gmail.com
|
||||
SMTP_PORT=587
|
||||
SMTP_USERNAME=votre-email@gmail.com
|
||||
SMTP_PASSWORD=votre-mot-de-passe-app
|
||||
EMAIL_FROM=votre-email@gmail.com
|
||||
```
|
||||
|
||||
### Générer une SECRET_KEY
|
||||
|
||||
```bash
|
||||
python -c "import secrets; print(secrets.token_hex(32))"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Commandes Docker
|
||||
|
||||
### Démarrage
|
||||
|
||||
```bash
|
||||
# Démarrer en arrière-plan
|
||||
docker-compose up -d
|
||||
|
||||
# Voir les logs
|
||||
docker-compose logs -f
|
||||
|
||||
# Logs d'un service spécifique
|
||||
docker-compose logs -f backend
|
||||
docker-compose logs -f frontend
|
||||
```
|
||||
|
||||
### Arrêt
|
||||
|
||||
```bash
|
||||
# Arrêter les services
|
||||
docker-compose stop
|
||||
|
||||
# Arrêter et supprimer les conteneurs
|
||||
docker-compose down
|
||||
|
||||
# Arrêter et supprimer tout (conteneurs + volumes)
|
||||
docker-compose down -v
|
||||
```
|
||||
|
||||
### Rebuild
|
||||
|
||||
```bash
|
||||
# Rebuild après modification du code
|
||||
docker-compose build
|
||||
|
||||
# Rebuild et redémarrage
|
||||
docker-compose up -d --build
|
||||
|
||||
# Rebuild un service spécifique
|
||||
docker-compose build backend
|
||||
docker-compose up -d backend
|
||||
```
|
||||
|
||||
### Inspection
|
||||
|
||||
```bash
|
||||
# Statut des services
|
||||
docker-compose ps
|
||||
|
||||
# Santé des services
|
||||
docker-compose ps -a
|
||||
|
||||
# Entrer dans un conteneur
|
||||
docker-compose exec backend sh
|
||||
docker-compose exec frontend sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🗄️ Gestion de la Base de Données
|
||||
|
||||
### Backup
|
||||
|
||||
```bash
|
||||
# Créer un backup
|
||||
docker-compose exec backend sh -c "cp /data/school_management.db /data/backup_$(date +%Y%m%d_%H%M%S).db"
|
||||
|
||||
# Ou depuis l'hôte
|
||||
cp data/school_management.db data/backup_$(date +%Y%m%d_%H%M%S).db
|
||||
```
|
||||
|
||||
### Restauration
|
||||
|
||||
```bash
|
||||
# Restaurer depuis un backup
|
||||
docker-compose stop backend
|
||||
cp data/backup_YYYYMMDD_HHMMSS.db data/school_management.db
|
||||
docker-compose start backend
|
||||
```
|
||||
|
||||
### Migration depuis v1
|
||||
|
||||
```bash
|
||||
# Si vous avez une base v1 Flask
|
||||
cp instance/school_management.db data/school_management.db
|
||||
docker-compose restart backend
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔍 Healthcheck
|
||||
|
||||
Les services incluent des healthchecks automatiques :
|
||||
|
||||
```bash
|
||||
# Vérifier la santé du backend
|
||||
curl http://localhost:8000/api/v2/health
|
||||
|
||||
# Vérifier la santé du frontend
|
||||
curl http://localhost/
|
||||
|
||||
# Voir le statut Docker
|
||||
docker-compose ps
|
||||
```
|
||||
|
||||
**Réponse attendue du backend :**
|
||||
```json
|
||||
{
|
||||
"status": "healthy",
|
||||
"database": "connected",
|
||||
"tables": 12,
|
||||
"classes": 5,
|
||||
"students": 155
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚨 Dépannage
|
||||
|
||||
### Le backend ne démarre pas
|
||||
|
||||
```bash
|
||||
# Voir les logs
|
||||
docker-compose logs backend
|
||||
|
||||
# Vérifier la configuration
|
||||
docker-compose exec backend env | grep DATABASE_URL
|
||||
|
||||
# Recréer le conteneur
|
||||
docker-compose up -d --force-recreate backend
|
||||
```
|
||||
|
||||
### Le frontend ne charge pas
|
||||
|
||||
```bash
|
||||
# Vérifier Nginx
|
||||
docker-compose logs frontend
|
||||
|
||||
# Tester la connectivité au backend
|
||||
docker-compose exec frontend curl http://backend:8000/api/v2/health
|
||||
|
||||
# Rebuild le frontend
|
||||
docker-compose build frontend
|
||||
docker-compose up -d frontend
|
||||
```
|
||||
|
||||
### Problème de permissions (base de données)
|
||||
|
||||
```bash
|
||||
# Ajuster les permissions
|
||||
chmod 666 data/school_management.db
|
||||
chmod 755 data/
|
||||
```
|
||||
|
||||
### Les changements de code ne sont pas pris en compte
|
||||
|
||||
```bash
|
||||
# Rebuild complet
|
||||
docker-compose down
|
||||
docker-compose build --no-cache
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🌐 Déploiement Production
|
||||
|
||||
### Configuration Nginx (hôte)
|
||||
|
||||
Si vous utilisez Nginx sur l'hôte pour le reverse proxy :
|
||||
|
||||
```nginx
|
||||
server {
|
||||
listen 80;
|
||||
server_name notytex.example.com;
|
||||
|
||||
location / {
|
||||
proxy_pass http://localhost:80;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### HTTPS avec Let's Encrypt
|
||||
|
||||
```bash
|
||||
# Installer certbot
|
||||
sudo apt install certbot python3-certbot-nginx
|
||||
|
||||
# Obtenir un certificat
|
||||
sudo certbot --nginx -d notytex.example.com
|
||||
|
||||
# Renouvellement automatique est configuré
|
||||
```
|
||||
|
||||
### Systemd Service
|
||||
|
||||
Créez `/etc/systemd/system/notytex.service` :
|
||||
|
||||
```ini
|
||||
[Unit]
|
||||
Description=Notytex Docker Compose
|
||||
Requires=docker.service
|
||||
After=docker.service
|
||||
|
||||
[Service]
|
||||
Type=oneshot
|
||||
RemainAfterExit=yes
|
||||
WorkingDirectory=/path/to/notytex
|
||||
ExecStart=/usr/bin/docker-compose up -d
|
||||
ExecStop=/usr/bin/docker-compose down
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
```
|
||||
|
||||
Activer :
|
||||
```bash
|
||||
sudo systemctl enable notytex
|
||||
sudo systemctl start notytex
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📊 Monitoring
|
||||
|
||||
### Logs centralisés
|
||||
|
||||
```bash
|
||||
# Tous les logs en temps réel
|
||||
docker-compose logs -f
|
||||
|
||||
# Logs des dernières 24h
|
||||
docker-compose logs --since 24h
|
||||
|
||||
# Recherche dans les logs
|
||||
docker-compose logs | grep ERROR
|
||||
```
|
||||
|
||||
### Métriques Docker
|
||||
|
||||
```bash
|
||||
# Utilisation ressources
|
||||
docker stats
|
||||
|
||||
# Espace disque
|
||||
docker system df
|
||||
|
||||
# Nettoyage
|
||||
docker system prune -a
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔐 Sécurité
|
||||
|
||||
### Checklist Production
|
||||
|
||||
- [ ] Changer `SECRET_KEY` (unique et aléatoire)
|
||||
- [ ] Configurer CORS avec vos domaines réels
|
||||
- [ ] Utiliser HTTPS en production
|
||||
- [ ] Limiter les ports exposés (firewall)
|
||||
- [ ] Mettre en place des backups automatiques
|
||||
- [ ] Configurer des alertes monitoring
|
||||
- [ ] Restreindre les permissions fichiers
|
||||
- [ ] Mettre à jour régulièrement les images Docker
|
||||
|
||||
### Mise à jour des images de base
|
||||
|
||||
```bash
|
||||
# Pull les dernières images
|
||||
docker-compose pull
|
||||
|
||||
# Rebuild avec nouvelles images
|
||||
docker-compose up -d --build
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📦 Multi-environnements
|
||||
|
||||
### Développement
|
||||
|
||||
```bash
|
||||
# Utiliser docker-compose.dev.yml
|
||||
docker-compose -f docker-compose.yml -f docker-compose.dev.yml up
|
||||
```
|
||||
|
||||
### Production
|
||||
|
||||
```bash
|
||||
# Utiliser docker-compose.prod.yml
|
||||
docker-compose -f docker-compose.yml -f docker-compose.prod.yml up -d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Performances
|
||||
|
||||
### Optimisations
|
||||
|
||||
1. **Build multi-stage** : Réduit la taille des images
|
||||
2. **Cache des dépendances** : Accélère les rebuilds
|
||||
3. **Gzip Nginx** : Compression des assets
|
||||
4. **Cache statique** : Headers cache 1 an pour JS/CSS
|
||||
5. **Healthchecks** : Détection automatique des problèmes
|
||||
|
||||
### Ressources recommandées
|
||||
|
||||
- **Backend** : 512MB RAM, 0.5 CPU
|
||||
- **Frontend** : 256MB RAM, 0.25 CPU
|
||||
- **Total** : ~1GB RAM, 1 CPU pour 50 utilisateurs
|
||||
|
||||
---
|
||||
|
||||
## 📞 Support
|
||||
|
||||
En cas de problème :
|
||||
|
||||
1. Vérifiez les logs : `docker-compose logs`
|
||||
2. Testez les healthchecks
|
||||
3. Consultez la documentation : `README.md`
|
||||
4. Vérifiez les issues GitHub
|
||||
|
||||
---
|
||||
|
||||
**Développé avec ❤️ pour simplifier le déploiement de Notytex**
|
||||
Reference in New Issue
Block a user