194 lines
5.0 KiB
Markdown
194 lines
5.0 KiB
Markdown
# 📚 Documentation InnotexBoard
|
|
|
|
Bienvenue ! Cette page vous guide vers toute la documentation du projet.
|
|
|
|
## 🚀 Démarrage rapide
|
|
|
|
**👉 Commencez ici !**
|
|
|
|
- [QUICKSTART.md](QUICKSTART.md) - Installation et premiers tests en 5 minutes
|
|
|
|
## 📖 Documentation générale
|
|
|
|
| Document | Contenu |
|
|
|----------|---------|
|
|
| [README.md](README.md) | Vue d'ensemble, features, stack tech |
|
|
| [PERMISSIONS.md](PERMISSIONS.md) | Configuration Docker, PAM, système |
|
|
| [ANSWERS.md](ANSWERS.md) | Réponses aux 3 questions principales |
|
|
|
|
## 🔧 Documentation technique
|
|
|
|
| Document | Contenu |
|
|
|----------|---------|
|
|
| [TECHNICAL_EXPLANATION.md](TECHNICAL_EXPLANATION.md) | Architecture, flux, sécurité en détail |
|
|
| [backend/README.md](backend/README.md) | Guide backend FastAPI |
|
|
| [frontend/README.md](frontend/README.md) | Guide frontend Vue.js |
|
|
|
|
## 🧪 Testing
|
|
|
|
- [test_api.sh](test_api.sh) - Script de test des endpoints
|
|
|
|
## 📁 Structure du projet
|
|
|
|
```
|
|
innotexboard/
|
|
├── 📘 Docs
|
|
│ ├── README.md (Vue d'ensemble)
|
|
│ ├── QUICKSTART.md (5 minutes)
|
|
│ ├── PERMISSIONS.md (Sécurité)
|
|
│ ├── ANSWERS.md (Vos questions)
|
|
│ └── TECHNICAL_EXPLANATION.md (Détails)
|
|
│
|
|
├── 🐍 Backend (Python/FastAPI)
|
|
│ ├── main.py (Point d'entrée)
|
|
│ ├── requirements.txt (Dépendances)
|
|
│ ├── app/
|
|
│ │ ├── core/ (Config, Sécurité)
|
|
│ │ ├── api/endpoints/ (Routes)
|
|
│ │ └── services/ (Logique métier)
|
|
│ └── Dockerfile
|
|
│
|
|
├── 🚀 Frontend (Vue.js 3)
|
|
│ ├── src/
|
|
│ │ ├── main.js
|
|
│ │ ├── App.vue
|
|
│ │ ├── views/ (Pages)
|
|
│ │ ├── stores/ (State)
|
|
│ │ ├── api/ (HTTP)
|
|
│ │ └── assets/ (Styles)
|
|
│ ├── package.json
|
|
│ ├── vite.config.js
|
|
│ ├── tailwind.config.js
|
|
│ └── Dockerfile
|
|
│
|
|
├── 🐳 Déploiement
|
|
│ ├── docker-compose.yml (Basique)
|
|
│ ├── docker-compose.advanced.yml (Production)
|
|
│ └── nginx.conf (Reverse proxy)
|
|
│
|
|
└── 🧪 Tests
|
|
└── test_api.sh (Tests API)
|
|
```
|
|
|
|
## 🎯 Par cas d'usage
|
|
|
|
### Je veux juste démarrer l'app
|
|
→ [QUICKSTART.md](QUICKSTART.md)
|
|
|
|
### Je veux comprendre l'architecture
|
|
→ [TECHNICAL_EXPLANATION.md](TECHNICAL_EXPLANATION.md)
|
|
|
|
### J'ai des problèmes de permissions
|
|
→ [PERMISSIONS.md](PERMISSIONS.md)
|
|
|
|
### Je veux déployer en production
|
|
→ [docker-compose.advanced.yml](docker-compose.advanced.yml) + [nginx.conf](nginx.conf)
|
|
|
|
### Je veux modifier/étendre le code
|
|
→ [TECHNICAL_EXPLANATION.md](TECHNICAL_EXPLANATION.md) + Code source
|
|
|
|
### Je veux connaître les réponses aux questions principales
|
|
→ [ANSWERS.md](ANSWERS.md)
|
|
|
|
## 💡 Tips utiles
|
|
|
|
### Démarrage classique
|
|
|
|
```bash
|
|
# Backend
|
|
cd backend && python3 main.py
|
|
|
|
# Frontend (autre terminal)
|
|
cd frontend && npm run dev
|
|
```
|
|
|
|
### Déploiement Docker
|
|
|
|
```bash
|
|
# Dev
|
|
docker-compose up
|
|
|
|
# Production
|
|
docker-compose -f docker-compose.advanced.yml up
|
|
|
|
# Avec Nginx
|
|
docker-compose -f docker-compose.advanced.yml --profile production up
|
|
```
|
|
|
|
### Tests
|
|
|
|
```bash
|
|
# Tester l'API
|
|
bash test_api.sh your_user your_pass
|
|
|
|
# Documentation Swagger
|
|
http://localhost:8000/docs
|
|
|
|
# Interface web
|
|
http://localhost:3000
|
|
```
|
|
|
|
## 📚 Ressources externes
|
|
|
|
### Backend
|
|
- [FastAPI Docs](https://fastapi.tiangolo.com)
|
|
- [python-pam](https://github.com/firecat53/python-pam)
|
|
- [psutil](https://psutil.readthedocs.io)
|
|
- [Docker Python SDK](https://docker-py.readthedocs.io)
|
|
- [PyJWT](https://pyjwt.readthedocs.io)
|
|
|
|
### Frontend
|
|
- [Vue 3 Docs](https://vuejs.org)
|
|
- [Vue Router](https://router.vuejs.org)
|
|
- [Pinia](https://pinia.vuejs.org)
|
|
- [Tailwind CSS](https://tailwindcss.com)
|
|
- [Vite](https://vitejs.dev)
|
|
- [Axios](https://axios-http.com)
|
|
|
|
### DevOps
|
|
- [Docker Docs](https://docs.docker.com)
|
|
- [Docker Compose](https://docs.docker.com/compose)
|
|
- [Nginx Docs](https://nginx.org)
|
|
|
|
## ✨ Features implémentées
|
|
|
|
- ✅ Authentification PAM (utilisateurs système Debian)
|
|
- ✅ JWT tokens pour l'API
|
|
- ✅ Dashboard avec CPU/RAM en temps réel
|
|
- ✅ Liste des processus actifs
|
|
- ✅ Gestion Docker (list/start/stop/restart/delete)
|
|
- ✅ Interface responsive mobile/desktop
|
|
- ✅ Design dark mode moderne
|
|
- ✅ CORS et TrustedHost middleware
|
|
- ✅ Validation Pydantic
|
|
- ✅ Docker Compose pour dev et prod
|
|
- ✅ Nginx reverse proxy
|
|
- ✅ Scripts de test
|
|
- ✅ Documentation complète
|
|
|
|
## 🚦 Roadmap possible
|
|
|
|
- [ ] Historique des stats (graphiques)
|
|
- [ ] Gestion des volumes Docker
|
|
- [ ] Configuration réseau
|
|
- [ ] Logs en temps réel
|
|
- [ ] Alertes/notifications
|
|
- [ ] 2FA (Two-Factor Auth)
|
|
- [ ] WebSocket pour updates live
|
|
- [ ] Backup automatiques
|
|
- [ ] Multi-serveurs
|
|
|
|
## 📞 Support
|
|
|
|
En cas de problème:
|
|
1. Vérifier [PERMISSIONS.md](PERMISSIONS.md)
|
|
2. Consulter [TECHNICAL_EXPLANATION.md](TECHNICAL_EXPLANATION.md)
|
|
3. Regarder les logs : `docker-compose logs -f backend`
|
|
4. Tester l'API : `bash test_api.sh`
|
|
|
|
---
|
|
|
|
**Bon développement avec InnotexBoard ! 🎉**
|
|
|
|
Pour toute question ou contribution, consultez le README.md principal.
|