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/QUICKSTART.md
+++ b/QUICKSTART.md
@@ -1,136 +1,144 @@
-# 🎯 Guide Rapide - Démarrage en 5 Minutes
+# Guide de Démarrage Rapide
+
+Ce guide vous permettra de démarrer le panel web en moins de 5 minutes.

 ## Prérequis
- Node.js 14+ installé
- Serveur Minecraft avec RCON activé
- Vous devez être OP sur le serveur

-## ⚡ Installation Express
+✅ Docker et Docker Compose installés  
+✅ Serveur Minecraft 1.6.4 avec RCON activé  
+✅ Ports 4001 et 25575 disponibles

-### 1️⃣ Configuration du serveur MC (10 secondes)
+## Installation en 3 Étapes

-Éditer le fichier `server.properties` du serveur Minecraft:
+### 1. Configuration RCON du Serveur Minecraft

-```properties
+Éditez \`server.properties\` de votre serveur Minecraft :
+
+\`\`\`properties
 enable-rcon=true
 rcon.port=25575
-rcon.password=YourPassword123
-```
+rcon.password=VotreMotDePasse
+\`\`\`

-Redémarrer le serveur MC.
+Redémarrez le serveur Minecraft.

-### 2️⃣ Installation de l'app (2 minutes)
+### 2. Configuration du Panel Web

-```bash
-cd /home/innotex/Documents/Projet/Serveur\ NationsGlory/WebNationsGlory_ServeurBuild_Red
+Éditez \`docker-compose.yml\` et ajustez les variables d'environnement :

-# Installation automatique
-./install.sh
-```
+\`\`\`yaml
+environment:
+  - SERVER_DIR=/chemin/vers/serveur/minecraft
+  - RCON_PASSWORD=VotreMotDePasse  # Le même que dans server.properties
+  - SESSION_SECRET=UnSecretAleatoire
+\`\`\`

-### 3️⃣ Configuration (1 minute)
+### 3. Démarrage

-```bash
-# Éditer le fichier
-nano backend/.env
-```
+\`\`\`bash
+docker-compose up -d
+\`\`\`

-Vérifiez:
-```env
-PORT=4001
-SERVER_DIR=/home/innotex/Documents/Projet/Serveur NationsGlory/NationsGlory_ServeurBuild_Red
-RCON_HOST=localhost
-RCON_PORT=25575
-```
+C'est tout ! Le panel est maintenant accessible sur **http://localhost:4001**

-### 4️⃣ Lancement (30 secondes)
+## Première Connexion

-```bash
-./start.sh
-```
+1. Ouvrez http://localhost:4001 dans votre navigateur
+2. Connectez-vous avec un compte OP du serveur Minecraft
+3. Le système vérifie automatiquement que vous êtes dans \`ops.txt\`

-Vous devriez voir:
-```
-🚀 Backend Admin NationsGlory démarré sur http://localhost:4001
-```
+## Fonctionnalités Principales

-### 5️⃣ Accès (10 secondes)
+### 📊 Dashboard
+- Affiche le nombre de joueurs connectés (X/Y)
+- État du serveur en temps réel

-Ouvrez: **http://localhost:4001**
+### ⌨️ Console RCON
+- Interface style terminal Linux
+- Historique persistant des commandes avec recherche
+- Redémarrage/Arrêt du serveur avec cooldown
+- Boutons de commandes rapides : save-all, list, time, weather...

-## 👤 Premier Compte
+### 👥 Players
+- Liste des joueurs connectés avec support des codes couleur § de Minecraft
+- Informations détaillées (UUID, dernière connexion)

-1. Remplissez le formulaire d'enregistrement:
-   - Nom d'utilisateur: `admin` (ou ce que vous voulez)
-   - Mot de passe: Votre mot de passe
-   - Pseudo Minecraft: **VOTRE NOM DE JOUEUR** (doit être OP!)
+### ✅ Whitelist
+- Ajout/suppression de joueurs autorisés
+- Gestion complète de la whitelist

-2. Cliquez "Créer le compte"
+### 📜 Logs
+- Visualisation des logs du serveur
+- Recherche dans les logs

-3. Connectez-vous avec vos identifiants
+### ⚙️ Settings
+- Modification en temps réel des paramètres serveur
+- Les changements sont appliqués immédiatement à \`server.properties\`
+- Masquage automatique des mots de passe RCON

-## ✅ Test Rapide
+## Commandes Utiles

-1. Allez à l'onglet **Console RCON**
-2. Tapez: `/time query daytime`
-3. Cliquez "Envoyer"
-4. Vous devriez voir l'heure du serveur
+\`\`\`bash
+# Voir les logs du panel
+docker-compose logs -f app

-Si ça marche = ✓ Tout est bon!
+# Redémarrer le panel
+docker-compose restart app

-## 🎮 Commandes Utiles
+# Arrêter le panel
+docker-compose down

-```
-/say Bienvenue!              → Message à tous
-/tp @s 0 100 0              → Se téléporter
-/give @p diamond 64         → Donner des items
-/weather clear              → Météo
-/difficulty 3               → Difficulté
-/time set day               → Midi
-```
+# Reconstruire après modifications du code
+docker-compose up -d --build
+\`\`\`

-## ⚠️ Problèmes Courants
+## Volumes Docker

-| Problème | Solution |
-|----------|----------|
-| "Timeout RCON" | Vérifier que le serveur MC est en ligne |
-| "Mot de passe incorrect" | Vérifier dans server.properties |
-| "Joueur n'est pas OP" | Faire `/op NomDuJoueur` sur le serveur MC |
-| "Impossible de se connecter" | Vérifier que `npm start` est lancé |
+Le projet utilise deux volumes :

-## 📁 Fichiers Importants
+1. **mc-server** : Montage du serveur Minecraft (lecture/écriture)
+2. **web-admin** : Données persistantes du panel (historique RCON, etc.)

-```
-backend/
-├── .env                    ← Configuration (à modifier)
-├── package.json            ← Dépendances
-└── src/
-    ├── server.js           ← Point d'entrée
-    └── routes/             ← API endpoints
+Pour voir les volumes :
+\`\`\`bash
+docker volume ls | grep web
+\`\`\`

-frontend/
-└── public/
-    └── index.html          ← Interface web
-```
+## Dépannage Rapide

-## 🔐 Sécurité Basique
+### Le panel ne démarre pas
+\`\`\`bash
+docker-compose logs app
+\`\`\`

-1. Changez `SESSION_SECRET` dans `.env` (ligne importante)
-2. Utilisez un mot de passe RCON fort
-3. Ne partagez pas vos identifiants
+### Erreur de connexion RCON
+1. Vérifier que le serveur Minecraft est démarré
+2. Vérifier \`enable-rcon=true\` dans \`server.properties\`
+3. Vérifier que le mot de passe RCON correspond

-## 📖 Documentation Complète
+### Les joueurs ne s'affichent pas
+1. Vérifier que \`/world/players/\` existe dans le serveur Minecraft
+2. Vérifier que \`usercache.json\` est présent

- **README.md** - Vue d'ensemble complète
- **CONFIGURATION.md** - Configuration détaillée
- **DEPLOYMENT.md** - Déploiement en production
+### Impossible de se connecter
+1. Vérifier que votre nom d'utilisateur est dans \`ops.txt\`
+2. Vider le cache du navigateur
+3. Vérifier les logs : \`docker-compose logs app\`

-## 🆘 Besoin d'aide?
+## Prochaines Étapes

-1. Vérifiez les logs: `npm start` affiche tout
-2. Testez RCON: `echo "status" | nc localhost 25575`
-3. Lisez CONFIGURATION.md pour plus de détails
+- Consultez [CONFIGURATION.md](CONFIGURATION.md) pour une configuration avancée
+- Consultez [DEPLOYMENT.md](DEPLOYMENT.md) pour un déploiement en production
+- Consultez [MAINTENANCE.md](MAINTENANCE.md) pour la maintenance et les backups
+
+## Support
+
+En cas de problème, vérifiez :
+1. Les logs Docker : \`docker-compose logs app\`
+2. Que le serveur Minecraft est démarré
+3. Que les ports 4001 et 25575 sont disponibles
+4. Que \`SERVER_DIR\` pointe vers le bon dossier

 ---

-**Vous êtes prêt!** 🚀 Profitez de votre interface!
+**Note** : Ce panel est compatible uniquement avec Minecraft 1.6.4 en raison du format spécifique des fichiers de joueurs et des codes couleur §.