245 lines
6.3 KiB
Markdown
245 lines
6.3 KiB
Markdown
# 📋 Index - Fichiers et Documentation
|
|
|
|
## 🗂️ 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
|
|
```
|
|
|
|
## 📖 Guides de Lecture
|
|
|
|
### Pour Démarrer Rapidement
|
|
1. **QUICKSTART.md** - 5 minutes pour être opérationnel
|
|
2. Suivez les 5 étapes simples
|
|
|
|
### Pour Comprendre la Configuration
|
|
1. **README.md** - Vue d'ensemble
|
|
2. **CONFIGURATION.md** - Configuration détaillée
|
|
3. Éditer les fichiers .env
|
|
|
|
### Pour Utiliser l'Application
|
|
1. Ouvrir http://localhost:3000
|
|
2. Créer le compte admin
|
|
3. Utiliser les onglets du dashboard
|
|
|
|
### Pour Administrer le Serveur
|
|
1. **MAINTENANCE.md** - Commandes utiles
|
|
2. Sauvegardes régulières
|
|
3. Monitoring
|
|
|
|
### Pour la Production
|
|
1. **DEPLOYMENT.md** - Configuration HTTPS/Proxy
|
|
2. Sécurité renforcée
|
|
3. Certificats SSL
|
|
|
|
## 🔑 Points Clés
|
|
|
|
### Configuration
|
|
- **Backend .env**: Variables d'environnement critiques
|
|
- **Server.properties**: RCON du serveur MC
|
|
- **Ops.txt**: Liste des administrateurs
|
|
|
|
### Sécurité
|
|
- SESSION_SECRET unique en production
|
|
- HTTPS recommandé
|
|
- Firewall bien configuré
|
|
|
|
### Maintenance
|
|
- Backups réguliers
|
|
- Logs à surveiller
|
|
- Mises à jour Node.js
|
|
|
|
## 🚀 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:3000
|
|
```
|
|
|
|
## 📚 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)
|