story-research-zapwall/docs/DOCUMENTATION.md

134 lines
4.2 KiB
Markdown

# Documentation complète - zapwall.fr
## 📚 Index de la documentation
### 🚀 Déploiement et infrastructure
#### Documentation principale
1. **[Documentation complète du déploiement](docs/deployment.md)**
- Vue d'ensemble de l'architecture
- Configuration initiale
- Mise à jour du site (Git, transfert manuel)
- Configuration HTTPS (auto-signé et Let's Encrypt)
- Scripts disponibles
- Dépannage complet
- Maintenance et commandes utiles
2. **[Référence des scripts](docs/scripts-reference.md)**
- Liste complète de tous les scripts
- Description détaillée de chaque script
- Paramètres et options
- Ordre d'exécution recommandé
3. **[Guide de référence rapide](docs/quick-reference.md)**
- Commandes essentielles en un coup d'œil
- Informations importantes
- Liens rapides vers la documentation
#### Guides pratiques
4. **[README-DEPLOYMENT.md](README-DEPLOYMENT.md)**
- Guide de déploiement et mise à jour
- Méthodes de mise à jour
- Commandes utiles
- Configuration HTTPS
5. **[RESUME-DEPLOIEMENT.md](RESUME-DEPLOIEMENT.md)**
- Résumé du déploiement
- État actuel
- Problèmes identifiés et solutions
- Prochaines étapes
### 📝 Scripts de déploiement
#### Scripts principaux
- **`deploy.sh`** : Déploiement initial complet avec vérifications
- **`update-remote-git.sh`** : Mise à jour via Git (stash + pull + rebuild) ⭐ **Recommandé**
- **`update-from-git.sh`** : Mise à jour depuis dépôt local
- **`finish-deploy.sh`** : Finalisation du déploiement
#### Scripts de vérification
- **`check-deploy.sh`** : Vérification préalable avant déploiement
- **`check-deployment-status.sh`** : État complet du déploiement
- **`check-nginx-config.sh`** : Vérification de la configuration nginx
- **`check-git-repo.sh`** : Vérification du dépôt Git
- **`final-status.sh`** : Résumé de l'état final
#### Scripts de configuration
- **`setup-https-autosigned.sh`** : Configuration HTTPS avec certificats auto-signés
- **`deploy-letsencrypt.sh`** : Déploiement des certificats Let's Encrypt
- **`open-firewall-ports.sh`** : Ouverture des ports 80/443
- **`fix-nginx-config.sh`** : Correction de la configuration
### 🔧 Informations techniques
#### Serveur
- **Adresse** : `92.243.27.35`
- **Utilisateur** : `debian`
- **Domaine** : `zapwall.fr`
- **Répertoire** : `/var/www/zapwall.fr`
- **Port application** : `3001`
- **Service** : `zapwall.service` (systemd)
- **Nginx** : Conteneur Docker `lecoffre_nginx_test`
#### Architecture
```
Internet → Firewall (80/443) → Nginx Docker → Port 3001 → Next.js App
```
### 📖 Documentation utilisateur
- **[Guide utilisateur](docs/user-guide.md)** : Guide d'utilisation de la plateforme
- **[FAQ](docs/faq.md)** : Questions fréquentes
- **[Guide de publication](docs/publishing-guide.md)** : Comment publier un article
- **[Guide de paiement](docs/payment-guide.md)** : Comment effectuer un paiement
### 🔬 Documentation technique
- **[Documentation technique](docs/technical.md)** : Architecture technique
- **[Configuration stricte](docs/STRICT_CONFIG_SUMMARY.md)** : Règles de qualité du code
- **[Configuration Rizful API](docs/rizful-api-setup.md)** : Configuration de l'API Rizful
### 📋 Spécifications
- **[Fonctionnalités](features/features.md)** : Liste des fonctionnalités
- **[Notifications](features/notifications-implementation.md)** : Implémentation des notifications
- **[Séries et médias](features/series-and-media-spec.md)** : Spécification des séries
- **[Refactoring](features/zapwall4science-refactoring.md)** : Notes de refactoring
## 🎯 Démarrage rapide
### Pour déployer ou mettre à jour
```bash
# Déploiement depuis la branche main (par défaut)
./deploy.sh
# Déploiement depuis une autre branche
./deploy.sh develop
```
Le script `deploy.sh` effectue automatiquement :
- Mise à jour depuis Git
- Installation des dépendances
- Construction de l'application
- Redémarrage du service
## 📞 Support
En cas de problème :
1. Consulter [docs/deployment.md - Section Dépannage](docs/deployment.md#dépannage)
2. Vérifier les logs : `ssh debian@92.243.27.35 'sudo journalctl -u zapwall -n 100'`
3. Utiliser les scripts de vérification
---
*Dernière mise à jour : 2025-12-28*