- 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
145 lines
3.7 KiB
Markdown
145 lines
3.7 KiB
Markdown
# Guide de Démarrage Rapide
|
|
|
|
Ce guide vous permettra de démarrer le panel web en moins de 5 minutes.
|
|
|
|
## Prérequis
|
|
|
|
✅ Docker et Docker Compose installés
|
|
✅ Serveur Minecraft 1.6.4 avec RCON activé
|
|
✅ Ports 4001 et 25575 disponibles
|
|
|
|
## Installation en 3 Étapes
|
|
|
|
### 1. Configuration RCON du Serveur Minecraft
|
|
|
|
Éditez \`server.properties\` de votre serveur Minecraft :
|
|
|
|
\`\`\`properties
|
|
enable-rcon=true
|
|
rcon.port=25575
|
|
rcon.password=VotreMotDePasse
|
|
\`\`\`
|
|
|
|
Redémarrez le serveur Minecraft.
|
|
|
|
### 2. Configuration du Panel Web
|
|
|
|
Éditez \`docker-compose.yml\` et ajustez les variables d'environnement :
|
|
|
|
\`\`\`yaml
|
|
environment:
|
|
- SERVER_DIR=/chemin/vers/serveur/minecraft
|
|
- RCON_PASSWORD=VotreMotDePasse # Le même que dans server.properties
|
|
- SESSION_SECRET=UnSecretAleatoire
|
|
\`\`\`
|
|
|
|
### 3. Démarrage
|
|
|
|
\`\`\`bash
|
|
docker-compose up -d
|
|
\`\`\`
|
|
|
|
C'est tout ! Le panel est maintenant accessible sur **http://localhost:4001**
|
|
|
|
## Première Connexion
|
|
|
|
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\`
|
|
|
|
## Fonctionnalités Principales
|
|
|
|
### 📊 Dashboard
|
|
- Affiche le nombre de joueurs connectés (X/Y)
|
|
- État du serveur en temps réel
|
|
|
|
### ⌨️ 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...
|
|
|
|
### 👥 Players
|
|
- Liste des joueurs connectés avec support des codes couleur § de Minecraft
|
|
- Informations détaillées (UUID, dernière connexion)
|
|
|
|
### ✅ Whitelist
|
|
- Ajout/suppression de joueurs autorisés
|
|
- Gestion complète de la whitelist
|
|
|
|
### 📜 Logs
|
|
- Visualisation des logs du serveur
|
|
- Recherche dans les logs
|
|
|
|
### ⚙️ 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
|
|
|
|
## Commandes Utiles
|
|
|
|
\`\`\`bash
|
|
# Voir les logs du panel
|
|
docker-compose logs -f app
|
|
|
|
# Redémarrer le panel
|
|
docker-compose restart app
|
|
|
|
# Arrêter le panel
|
|
docker-compose down
|
|
|
|
# Reconstruire après modifications du code
|
|
docker-compose up -d --build
|
|
\`\`\`
|
|
|
|
## Volumes Docker
|
|
|
|
Le projet utilise deux volumes :
|
|
|
|
1. **mc-server** : Montage du serveur Minecraft (lecture/écriture)
|
|
2. **web-admin** : Données persistantes du panel (historique RCON, etc.)
|
|
|
|
Pour voir les volumes :
|
|
\`\`\`bash
|
|
docker volume ls | grep web
|
|
\`\`\`
|
|
|
|
## Dépannage Rapide
|
|
|
|
### Le panel ne démarre pas
|
|
\`\`\`bash
|
|
docker-compose logs app
|
|
\`\`\`
|
|
|
|
### 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
|
|
|
|
### 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
|
|
|
|
### 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\`
|
|
|
|
## Prochaines Étapes
|
|
|
|
- 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
|
|
|
|
---
|
|
|
|
**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 §.
|