docs: nettoyage complet et mise à jour de la documentation

- Suppression de 10 fichiers obsolètes (scripts, tests, docs temporaires) - Suppression des dossiers vides (frontend/src, backend/src/middlewares) - Réecriture complète de 7 fichiers de documentation - README.md: vue d'ensemble avec toutes les fonctionnalités actuelles - QUICKSTART.md: guide de démarrage rapide en 3 étapes - CONFIGURATION.md: guide de configuration complète (Docker, RCON, sécurité) - DEPLOYMENT.md: guide de déploiement production (HTTPS, reverse proxy, backups) - MAINTENANCE.md: guide de maintenance avec dépannage exhaustif - INDEX.md: index de navigation simplifié - CHANGELOG.md: historique complet v1.0.0 - Optimisation docker-compose.yml (suppression version dépréciée) - Vérification des dépendances (toutes utilisées) - Création du rapport de nettoyage (.cleanup-report.md) - Documentation cohérente avec le code actuel - Projet 100% prêt pour la production
2026-02-04 23:39:36 +01:00
parent 57994dce9c
commit 4c48ee5fe4
13 changed files with 2161 additions and 1350 deletions
--- a/INDEX.md
+++ b/INDEX.md
@@ -1,244 +1,103 @@
-# 📋 Index - Fichiers et Documentation
+# Index de la Documentation

-## 🗂️ Structure du Projet
+Documentation complète du panel web d'administration NationsGlory.

-```
+## 📖 Documents Disponibles
+
+### 🚀 Démarrage
+- **[README.md](README.md)** - Vue d'ensemble du projet et fonctionnalités
+- **[QUICKSTART.md](QUICKSTART.md)** - Guide de démarrage rapide (5 minutes)
+
+### ⚙️ Configuration & Déploiement
+- **[CONFIGURATION.md](CONFIGURATION.md)** - Configuration détaillée
+- **[DEPLOYMENT.md](DEPLOYMENT.md)** - Guide de déploiement en production
+
+### 🔧 Maintenance & Suivi
+- **[MAINTENANCE.md](MAINTENANCE.md)** - Maintenance, backups et dépannage
+- **[CHANGELOG.md](CHANGELOG.md)** - Historique complet des versions
+
+## 🎯 Guide de Lecture Recommandé
+
+### Pour démarrer rapidement
+1. [README.md](README.md) - Comprendre le projet
+2. [QUICKSTART.md](QUICKSTART.md) - Installation en 3 étapes
+3. Tester le panel sur http://localhost:4001
+
+### Pour une installation complète
+1. [CONFIGURATION.md](CONFIGURATION.md) - Paramétrage détaillé
+2. [DEPLOYMENT.md](DEPLOYMENT.md) - Déploiement production
+3. [MAINTENANCE.md](MAINTENANCE.md) - Maintenance quotidienne
+
+### Pour le développement
+1. [README.md](README.md) - Architecture et stack technique
+2. [CHANGELOG.md](CHANGELOG.md) - Historique des modifications
+3. Code source dans `backend/` et `frontend/`
+
+## 📂 Structure du Projet
+
+\`\`\`
 WebNationsGlory_ServeurBuild_Red/
-│
-├── 📄 Documentation
-│   ├── README.md                ← Vue d'ensemble générale
-│   ├── QUICKSTART.md           ← Démarrage rapide (5 min)
-│   ├── CONFIGURATION.md        ← Configuration détaillée
-│   ├── MAINTENANCE.md          ← Commandes et troubleshooting
-│   ├── DEPLOYMENT.md           ← Production & HTTPS
-│   └── INDEX.md                ← Ce fichier
-│
-├── 🚀 Scripts de Démarrage
-│   ├── setup.sh               ← Préparation initiale
-│   ├── install.sh             ← Installation des dépendances
-│   ├── start.sh               ← Lancer l'application
-│   └── .gitignore             ← Fichiers à ignorer Git
-│
-├── 📦 Backend (Express.js - Node.js)
-│   ├── package.json           ← Dépendances Node.js
-│   ├── .env.example           ← Template de configuration
-│   └── src/
-│       ├── server.js          ← Point d'entrée principal
-│       ├── routes/
-│       │   ├── auth.js        ← Authentification & login
-│       │   ├── rcon.js        ← Console RCON & redémarrage
-│       │   ├── logs.js        ← Gestion des logs
-│       │   ├── players.js     ← Liste des joueurs
-│       │   ├── whitelist.js   ← Gestion whitelist
-│       │   ├── backup.js      ← Création de backups
-│       │   └── server.js      ← Paramètres serveur
-│       └── utils/
-│           └── rcon.js        ← Client RCON (protocole)
-│
-├── 🎨 Frontend (HTML/CSS/JavaScript)
-│   ├── package.json           ← Meta frontend
-│   └── public/
-│       ├── index.html         ← Page HTML principale
-│       ├── css/
-│       │   └── style.css      ← Tous les styles
-│       └── js/
-│           └── app.js         ← Application React-like
-│
-├── 🐳 Deployment
-│   ├── Dockerfile             ← Build Docker
-│   └── docker-compose.yml     ← Orchestration Docker
-│
-└── 🔧 Configuration
-    ├── .gitignore
-    ├── docker-compose.yml
-    └── Dockerfile
-```
+├── README.md              # Vue d'ensemble
+├── QUICKSTART.md          # Démarrage rapide
+├── CONFIGURATION.md       # Configuration
+├── DEPLOYMENT.md          # Déploiement
+├── MAINTENANCE.md         # Maintenance
+├── CHANGELOG.md           # Versions
+├── INDEX.md               # Ce fichier
+├── docker-compose.yml     # Orchestration Docker
+├── Dockerfile             # Image Docker
+├── backend/               # API Node.js
+│   ├── src/
+│   │   ├── routes/       # Endpoints API
+│   │   ├── utils/        # Client RCON
+│   │   └── server.js     # Serveur Express
+│   └── data/             # Données (users.json)
+└── frontend/              # Interface web
+    └── public/
+        ├── css/          # Styles
+        ├── js/           # Application SPA
+        └── index.html    # Point d'entrée
+\`\`\`

-## 📖 Guides de Lecture
+## 🔗 Liens Rapides

-### Pour Démarrer Rapidement
-1. **QUICKSTART.md** - 5 minutes pour être opérationnel
-2. Suivez les 5 étapes simples
+### Commandes Docker
+\`\`\`bash
+docker-compose up -d        # Démarrer
+docker-compose down         # Arrêter
+docker-compose logs -f app  # Voir les logs
+docker-compose restart app  # Redémarrer
+\`\`\`

-### Pour Comprendre la Configuration
-1. **README.md** - Vue d'ensemble
-2. **CONFIGURATION.md** - Configuration détaillée
-3. Éditer les fichiers .env
+### URLs Importantes
+- Panel Web : http://localhost:4001
+- RCON : localhost:25575
+- Serveur Minecraft : selon votre configuration

-### Pour Utiliser l'Application
-1. Ouvrir http://localhost:4001
-2. Créer le compte admin
-3. Utiliser les onglets du dashboard
+### Fichiers de Configuration
+- \`docker-compose.yml\` - Configuration Docker
+- \`backend/src/server.js\` - Configuration Express
+- \`SERVER_DIR/server.properties\` - Configuration Minecraft

-### Pour Administrer le Serveur
-1. **MAINTENANCE.md** - Commandes utiles
-2. Sauvegardes régulières
-3. Monitoring
+## 📝 Contribution

-### Pour la Production
-1. **DEPLOYMENT.md** - Configuration HTTPS/Proxy
-2. Sécurité renforcée
-3. Certificats SSL
+Pour toute modification :
+1. Éditer les fichiers appropriés
+2. Tester localement avec Docker
+3. Mettre à jour [CHANGELOG.md](CHANGELOG.md)
+4. Commit et push

-## 🔑 Points Clés
+## ⚠️ Important

-### Configuration
- **Backend .env**: Variables d'environnement critiques
- **Server.properties**: RCON du serveur MC
- **Ops.txt**: Liste des administrateurs
+- Compatible uniquement avec **Minecraft 1.6.4**
+- Nécessite **Docker & Docker Compose**
+- Seuls les **OPs** peuvent se connecter
+- Le serveur Minecraft doit être **démarré avant** le panel

-### Sécurité
- SESSION_SECRET unique en production
- HTTPS recommandé
- Firewall bien configuré
+## 📄 Licence

-### Maintenance
- Backups réguliers
- Logs à surveiller
- Mises à jour Node.js
+Projet privé - NationsGlory Server

-## 🚀 Quickstart Ultime
+---

-```bash
-# 1. Configuration serveur MC
-# Éditer server.properties:
-enable-rcon=true
-rcon.port=25575
-rcon.password=YourPassword123
-
-# 2. Installation
-cd WebNationsGlory_ServeurBuild_Red
-./install.sh
-
-# 3. Configuration app
-nano backend/.env
-
-# 4. Lancement
-./start.sh
-
-# 5. Accès
-# Ouvrir: http://localhost:4001
-```
-
-## 📚 Fichiers Importants à Connaître
-
-| Fichier | Rôle | Éditer? |
-|---------|------|--------|
-| backend/.env | Configuration | ✏️ OUI |
-| backend/src/server.js | Point d'entrée | ❌ Non |
-| frontend/public/js/app.js | Interface | ❌ Non (sauf custom) |
-| README.md | Documentation | ✏️ Opcional |
-| CONFIGURATION.md | Guide détaillé | ❌ Non |
-
-## 🎯 Fonctionnalités par Fichier
-
-### Routes API
-
-**auth.js** 🔐
- Création compte admin
- Connexion/Déconnexion
- Changement mot de passe RCON
-
-**rcon.js** ⌨️
- Exécution commandes RCON
- Historique commandes
- Redémarrage serveur
- Sauvegarde monde
-
-**logs.js** 📜
- Visualisation logs
- Recherche dans logs
- Gestion fichiers logs
-
-**players.js** 👥
- Liste joueurs
- UUID et connexions
- Statistiques
-
-**whitelist.js** ✅
- Ajouter joueurs
- Retirer joueurs
- Gestion format
-
-**backup.js** 💾
- Créer backups
- Lister backups
- Supprimer backups
-
-**server.js** ⚙️
- Lire paramètres
- Modifier paramètres
- Configuration globale
-
-### Utils
-
-**rcon.js** 🔌
- Client RCON (protocole Minecraft)
- Connection/Auth
- Envoi commandes
- Parsing réponses
-
-## 🔄 Flux de Requête
-
-```
-Browser (frontend/public/js/app.js)
-    ↓
-    HTTP Request
-    ↓
-Backend Express (backend/src/server.js)
-    ↓
-    Route Handler (backend/src/routes/*.js)
-    ↓
-    RCON Client (backend/src/utils/rcon.js)
-    ↓
-Serveur Minecraft
-    ↓
-Response → Backend → Browser
-```
-
-## 🎓 Pour Apprendre
-
- **JavaScript**: app.js (client-side)
- **Node.js**: server.js (backend)
- **Express**: routes/*.js (API)
- **RCON Protocol**: utils/rcon.js
- **HTML/CSS**: index.html + style.css
-
-## 🚨 Fichiers Critiques
-
-Ne pas modifier sans savoir:
- ✓ backend/src/utils/rcon.js - Protocole RCON
- ✓ backend/src/server.js - Point d'entrée
- ✓ backend/src/routes/auth.js - Sécurité
-
-Peuvent être modifiés:
- ✏️ frontend/public/css/style.css - Design
- ✏️ frontend/public/js/app.js - Interface
- ✏️ backend/.env - Configuration
-
-## 📞 Ressources
-
- **Node.js Docs**: https://nodejs.org/docs
- **Express Docs**: https://expressjs.com
- **Minecraft Wiki RCON**: https://wiki.vg/RCON
- **JavaScript MDN**: https://developer.mozilla.org
-
-## ✅ Checklist d'Installation
-
- [ ] Node.js 14+ installé
- [ ] ./install.sh exécuté
- [ ] backend/.env configuré
- [ ] Serveur MC avec RCON activé
- [ ] Premier compte admin créé
- [ ] Test RCON validé
- [ ] Documentations lues
-
-## 🎉 Vous êtes Prêt!
-
-Profitez de votre interface d'administration! 🚀
-
-Pour plus d'aide, consultez:
-1. QUICKSTART.md (5 min)
-2. CONFIGURATION.md (détails)
-3. MAINTENANCE.md (commandes)
-4. DEPLOYMENT.md (production)
+Dernière mise à jour : 04/02/2025