|
1 | | -# VPSControlPanel |
| 1 | +# VPS Monitor |
| 2 | + |
| 3 | +Application web de monitoring pour VPS multi-applications. Supervise les containers Docker et la disponibilité des applications web via une interface légère sans framework. |
| 4 | + |
| 5 | +## Fonctionnalités |
| 6 | + |
| 7 | +- Dashboard temps réel des containers Docker (statut, image, ports, uptime) |
| 8 | +- Monitoring HTTP des applications web exposées via Nginx |
| 9 | +- Actions Docker : restart, stop, start d'un container |
| 10 | +- Authentification par session (login/password, durée 8h) |
| 11 | +- Page publique d'accueil avec liens vers les applications |
| 12 | +- Rafraîchissement automatique toutes les 5 secondes |
| 13 | +- Indicateurs visuels : vert (running/OK), rouge (exited/DOWN), orange (restarting) |
| 14 | +- Statut global OK/KO affiché dans le header |
| 15 | + |
| 16 | +## Stack technique |
| 17 | + |
| 18 | +| Couche | Technologie | |
| 19 | +|--------|-------------| |
| 20 | +| Backend | Node.js 20 + Express 5 | |
| 21 | +| Docker | Dockerode (via socket) | |
| 22 | +| Frontend | HTML + CSS + JS vanilla (sans build) | |
| 23 | +| Auth | express-session | |
| 24 | +| Tests | Jest + Supertest | |
| 25 | +| Lint | ESLint | |
| 26 | + |
| 27 | +## Structure du projet |
| 28 | + |
| 29 | +``` |
| 30 | +vps-monitor-app/ |
| 31 | +├── api/ |
| 32 | +│ ├── server.js # Serveur Express + routes |
| 33 | +│ ├── server.test.js # Tests Jest |
| 34 | +│ └── services/ |
| 35 | +│ ├── docker.js # Intégration Docker socket |
| 36 | +│ └── http.js # Checks HTTP des applications |
| 37 | +├── public/ |
| 38 | +│ ├── home.html # Page publique (non connecté) |
| 39 | +│ ├── index.html # Dashboard (connecté) |
| 40 | +│ ├── login.html # Formulaire de login |
| 41 | +│ ├── app.js # Logique frontend |
| 42 | +│ └── style.css |
| 43 | +├── Dockerfile |
| 44 | +└── package.json |
| 45 | +``` |
| 46 | + |
| 47 | +## API |
| 48 | + |
| 49 | +### Routes publiques |
| 50 | + |
| 51 | +| Méthode | Route | Description | |
| 52 | +|---------|-------|-------------| |
| 53 | +| GET | `/` | Home publique ou dashboard (selon session) | |
| 54 | +| POST | `/auth/login` | Connexion | |
| 55 | +| POST | `/auth/logout` | Déconnexion | |
| 56 | + |
| 57 | +### Routes protégées (session requise) |
| 58 | + |
| 59 | +| Méthode | Route | Description | |
| 60 | +|---------|-------|-------------| |
| 61 | +| GET | `/api/status` | Statut containers + sites web | |
| 62 | +| POST | `/api/container/restart` | Redémarre un container | |
| 63 | +| POST | `/api/container/stop` | Arrête un container | |
| 64 | +| POST | `/api/container/start` | Démarre un container arrêté | |
| 65 | + |
| 66 | +#### Exemple de réponse `GET /api/status` |
| 67 | + |
| 68 | +```json |
| 69 | +{ |
| 70 | + "containers": [ |
| 71 | + { "name": "sbv-api", "status": "running", "ports": ["3006:5000"], "image": "sbv-api:latest", "uptime": "2h" } |
| 72 | + ], |
| 73 | + "websites": [ |
| 74 | + { "name": "SaintBarth Volley", "url": "/saintbarthvolley/", "status": "OK" } |
| 75 | + ], |
| 76 | + "globalStatus": "OK" |
| 77 | +} |
| 78 | +``` |
| 79 | + |
| 80 | +## Variables d'environnement |
| 81 | + |
| 82 | +Créer un fichier `.env` à la racine de `vps-monitor-app/` : |
| 83 | + |
| 84 | +```env |
| 85 | +PORT=3000 |
| 86 | +BASE_URL=http://localhost:3000 |
| 87 | +AUTH_USER=admin |
| 88 | +AUTH_PASS=your-password |
| 89 | +SESSION_SECRET=your-secret |
| 90 | +``` |
| 91 | + |
| 92 | +## Lancement |
| 93 | + |
| 94 | +### Développement |
| 95 | + |
| 96 | +```bash |
| 97 | +cd vps-monitor-app |
| 98 | +npm install |
| 99 | +npm run dev |
| 100 | +``` |
| 101 | + |
| 102 | +### Production (Docker) |
| 103 | + |
| 104 | +```yaml |
| 105 | +# docker-compose.yml |
| 106 | +vps-monitor: |
| 107 | + build: ./vps-monitor-app |
| 108 | + container_name: vps-monitor |
| 109 | + volumes: |
| 110 | + - /var/run/docker.sock:/var/run/docker.sock |
| 111 | + ports: |
| 112 | + - "3020:3000" |
| 113 | + env_file: ./vps-monitor-app/.env |
| 114 | + restart: unless-stopped |
| 115 | +``` |
| 116 | +
|
| 117 | +```bash |
| 118 | +docker compose up -d vps-monitor |
| 119 | +``` |
| 120 | + |
| 121 | +## Intégration Nginx |
| 122 | + |
| 123 | +Remplace la homepage statique en proxifiant `/` vers vps-monitor : |
| 124 | + |
| 125 | +```nginx |
| 126 | +location / { |
| 127 | + proxy_pass http://127.0.0.1:3020; |
| 128 | + proxy_http_version 1.1; |
| 129 | + proxy_set_header Host $host; |
| 130 | + proxy_set_header X-Real-IP $remote_addr; |
| 131 | +} |
| 132 | +``` |
| 133 | + |
| 134 | +## Tests et lint |
| 135 | + |
| 136 | +```bash |
| 137 | +npm run lint # ESLint |
| 138 | +npm test # Jest + Supertest |
| 139 | +``` |
| 140 | + |
| 141 | +## CI/CD |
| 142 | + |
| 143 | +- **CI** : lint + tests sur toutes les branches et PRs (GitHub Actions) |
| 144 | +- **CD** : déploiement automatique sur le VPS via SSH au push sur `staging` |
| 145 | + |
| 146 | +## Applications monitorées |
| 147 | + |
| 148 | +| Application | Route Nginx | |
| 149 | +|-------------|-------------| |
| 150 | +| TP Vue | `/B3dev-TP_VUE/` | |
| 151 | +| SaintBarth Volley | `/saintbarthvolley/` | |
| 152 | +| Lucky7 | `/lucky7/` | |
| 153 | +| College La Boussole | `/collegelaboussole/` | |
| 154 | +| Cinemap | `/cinemap/` | |
| 155 | + |
| 156 | +## Sécurité |
| 157 | + |
| 158 | +- Le socket Docker (`/var/run/docker.sock`) donne un accès total au serveur — déployer uniquement en environnement de confiance |
| 159 | +- Toutes les routes `/api/*` et les actions containers sont protégées par la session |
| 160 | +- Cookies `httpOnly`, session de 8h |
| 161 | + |
| 162 | +## Évolutions prévues |
| 163 | + |
| 164 | +- Alertes Discord / email |
| 165 | +- Historique uptime |
| 166 | +- Graphiques CPU / RAM |
| 167 | +- Logs en temps réel |
| 168 | +- Support multi-serveurs |
0 commit comments