bf2c0901f4
- Création du répertoire scripts/ avec tous les scripts d'installation et de test - Scripts d'installation automatique (install.sh, quick-start.sh) - Scripts de maintenance complète (maintenance.sh) - Scripts de test (test-installation.sh, test-api.sh, test-services.sh, test-integration.sh) - Amélioration du Dockerfile avec healthchecks et sécurité - Mise à jour du docker-compose.yml avec healthchecks et dépendances - Makefile étendu avec nouvelles commandes - Documentation complète mise à jour - Fichier de configuration d'exemple (env.example) - app.py corrigé et fonctionnel
210 lines
4.0 KiB
Markdown
210 lines
4.0 KiB
Markdown
# Scripts 4NK IA Backend
|
|
|
|
Ce répertoire contient tous les scripts d'installation, de maintenance et de test pour le système 4NK IA Backend.
|
|
|
|
## 📋 Scripts d'installation
|
|
|
|
### `install.sh`
|
|
Script d'installation complète du système.
|
|
|
|
**Usage:**
|
|
```bash
|
|
./scripts/install.sh [dev|prod]
|
|
```
|
|
|
|
**Fonctionnalités:**
|
|
- Vérification des prérequis
|
|
- Installation des dépendances système
|
|
- Configuration de l'environnement Python
|
|
- Création du fichier .env
|
|
- Construction des images Docker
|
|
- Démarrage des services
|
|
- Vérification de la santé
|
|
|
|
### `quick-start.sh`
|
|
Script de démarrage rapide des services essentiels.
|
|
|
|
**Usage:**
|
|
```bash
|
|
./scripts/quick-start.sh
|
|
```
|
|
|
|
**Fonctionnalités:**
|
|
- Vérification rapide des prérequis
|
|
- Création du .env minimal
|
|
- Démarrage des services essentiels
|
|
- Vérification de la santé
|
|
|
|
## 🔧 Scripts de maintenance
|
|
|
|
### `maintenance.sh`
|
|
Script de maintenance complet du système.
|
|
|
|
**Usage:**
|
|
```bash
|
|
./scripts/maintenance.sh [command]
|
|
```
|
|
|
|
**Commandes disponibles:**
|
|
- `status` - Afficher le statut des services
|
|
- `logs` - Afficher les logs des services
|
|
- `restart` - Redémarrer tous les services
|
|
- `stop` - Arrêter tous les services
|
|
- `start` - Démarrer tous les services
|
|
- `clean` - Nettoyer les volumes et images Docker
|
|
- `backup` - Créer une sauvegarde des données
|
|
- `restore` - Restaurer une sauvegarde
|
|
- `update` - Mettre à jour les images Docker
|
|
- `health` - Vérifier la santé des services
|
|
- `shell` - Ouvrir un shell dans le container API
|
|
|
|
## 🧪 Scripts de test
|
|
|
|
### `test-installation.sh`
|
|
Tests d'installation et de configuration.
|
|
|
|
**Usage:**
|
|
```bash
|
|
./scripts/test-installation.sh
|
|
```
|
|
|
|
**Tests effectués:**
|
|
- Vérification des prérequis
|
|
- Vérification des fichiers
|
|
- Vérification des permissions
|
|
- Vérification de la configuration
|
|
- Vérification de Docker
|
|
- Vérification des services
|
|
|
|
### `test-services.sh`
|
|
Tests des services Docker.
|
|
|
|
**Usage:**
|
|
```bash
|
|
./scripts/test-services.sh
|
|
```
|
|
|
|
**Tests effectués:**
|
|
- Connectivité des services
|
|
- Services Docker
|
|
- Volumes Docker
|
|
- Réseaux Docker
|
|
- Ressources système
|
|
- Logs des services
|
|
- Configuration
|
|
|
|
### `test-api.sh`
|
|
Tests de l'API backend.
|
|
|
|
**Usage:**
|
|
```bash
|
|
./scripts/test-api.sh
|
|
```
|
|
|
|
**Tests effectués:**
|
|
- Santé de l'API
|
|
- Upload de document
|
|
- Extraction de données
|
|
- Liste des documents
|
|
- Performance
|
|
- Sécurité
|
|
|
|
### `test-integration.sh`
|
|
Tests d'intégration complets.
|
|
|
|
**Usage:**
|
|
```bash
|
|
./scripts/test-integration.sh
|
|
```
|
|
|
|
**Tests effectués:**
|
|
- Workflow complet
|
|
- Persistance des données
|
|
- Performance
|
|
- Robustesse
|
|
|
|
### `run-all-tests.sh`
|
|
Script pour exécuter tous les tests.
|
|
|
|
**Usage:**
|
|
```bash
|
|
./scripts/run-all-tests.sh [options]
|
|
```
|
|
|
|
**Options:**
|
|
- `--install-only` - Exécuter seulement les tests d'installation
|
|
- `--api-only` - Exécuter seulement les tests d'API
|
|
- `--services-only` - Exécuter seulement les tests de services
|
|
- `--integration-only` - Exécuter seulement les tests d'intégration
|
|
- `--skip-install` - Ignorer les tests d'installation
|
|
|
|
## 🚀 Utilisation rapide
|
|
|
|
### Installation complète
|
|
```bash
|
|
# Installation complète
|
|
./scripts/install.sh
|
|
|
|
# Ou via Makefile
|
|
make install
|
|
```
|
|
|
|
### Démarrage rapide
|
|
```bash
|
|
# Démarrage rapide
|
|
./scripts/quick-start.sh
|
|
|
|
# Ou via Makefile
|
|
make quick-start
|
|
```
|
|
|
|
### Tests
|
|
```bash
|
|
# Tous les tests
|
|
./scripts/run-all-tests.sh
|
|
|
|
# Ou via Makefile
|
|
make test
|
|
```
|
|
|
|
### Maintenance
|
|
```bash
|
|
# Statut des services
|
|
./scripts/maintenance.sh status
|
|
|
|
# Logs
|
|
./scripts/maintenance.sh logs
|
|
|
|
# Santé
|
|
./scripts/maintenance.sh health
|
|
|
|
# Ou via Makefile
|
|
make status
|
|
make logs
|
|
make health-check
|
|
```
|
|
|
|
## 📚 Documentation
|
|
|
|
- [README principal](../README.md)
|
|
- [Documentation API](http://localhost:8000/api-docs)
|
|
- [Changelog](../CHANGELOG.md)
|
|
- [Contributing](../CONTRIBUTING.md)
|
|
|
|
## 🆘 Support
|
|
|
|
Pour obtenir de l'aide :
|
|
|
|
1. Consultez la documentation
|
|
2. Vérifiez les logs avec `./scripts/maintenance.sh logs`
|
|
3. Exécutez les tests avec `./scripts/run-all-tests.sh`
|
|
4. Créez une issue si nécessaire
|
|
|
|
## 🔄 Mise à jour
|
|
|
|
Les scripts sont automatiquement mis à jour avec le projet. Pour mettre à jour les services :
|
|
|
|
```bash
|
|
./scripts/maintenance.sh update
|
|
```
|