88 lines
1.9 KiB
Markdown
88 lines
1.9 KiB
Markdown
# 🚀 Quick Start Guide
|
|
|
|
## 5 Minutes Setup (Development)
|
|
|
|
```bash
|
|
# 1. Installer les dépendances
|
|
npm install
|
|
|
|
# 2. Initialiser la base de données
|
|
npm run init-db
|
|
|
|
# 3. Démarrer le serveur
|
|
npm run dev
|
|
|
|
# 4. Accéder à l'application
|
|
# http://localhost:3000
|
|
```
|
|
|
|
## Ajouter votre premier service
|
|
|
|
1. Ouvrir http://localhost:3000/admin
|
|
2. Cliquer **+ New Service**
|
|
3. Remplir le formulaire :
|
|
```
|
|
Name: Mon App
|
|
Path: /myapp
|
|
Target URL: http://localhost:8080
|
|
Require Auth: ✓
|
|
```
|
|
4. Cliquer **Create Service**
|
|
|
|
## Tester le proxy
|
|
|
|
```bash
|
|
# Service accessible via proxy
|
|
http://localhost:3000/myapp
|
|
# Redirige vers → http://localhost:8080
|
|
```
|
|
|
|
## Fichiers Clés
|
|
|
|
| Fichier | Description |
|
|
|---------|-------------|
|
|
| `src/server.js` | Serveur principal Express |
|
|
| `src/middleware/oidcMiddleware.js` | Authentification OIDC |
|
|
| `src/middleware/proxyMiddleware.js` | Logique du reverse proxy |
|
|
| `src/services/serviceManager.js` | Gestion des services |
|
|
| `public/admin.html` | Interface admin |
|
|
| `.env` | Configuration |
|
|
|
|
## Options Avancées
|
|
|
|
- **Keycloak** : Voir `INSTALLATION.md`
|
|
- **Docker** : `docker-compose up`
|
|
- **Production** : `NODE_ENV=production`
|
|
- **Logs** : `LOG_LEVEL=debug`
|
|
|
|
## URLs Importantes
|
|
|
|
- Home : http://localhost:3000/
|
|
- Admin Panel : http://localhost:3000/admin
|
|
- API : http://localhost:3000/api/services
|
|
|
|
## Besoin d'aide ?
|
|
|
|
- Lire `README.md` pour la documentation complète
|
|
- Consulter `INSTALLATION.md` pour Keycloak et déploiement
|
|
- Vérifier les logs : `npm run dev` affiche tout
|
|
|
|
## Exemple Real-World
|
|
|
|
```bash
|
|
# Terminal 1 : Grafana sur 3001
|
|
docker run -p 3001:3000 grafana/grafana
|
|
|
|
# Terminal 2 : Proxy sur 3000
|
|
npm run dev
|
|
|
|
# Terminal 3 : Accéder
|
|
# http://localhost:3000/admin → Ajouter service
|
|
# Name: Grafana, Path: /grafana, Target: http://localhost:3001
|
|
# Puis : http://localhost:3000/grafana
|
|
```
|
|
|
|
---
|
|
|
|
**C'est tout ! Le service est opérationnel** 🎉
|