Skip to content

Commit b7b4451

Browse files
committed
docs(readme): mettre à jour la documentation pour la v0.5.0
1 parent 3345fa1 commit b7b4451

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

README.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,16 @@ LSIT est un outil d'inventaire et de cartographie d'infrastructure système dév
44

55
Ce projet met en pratique les concepts d'Infrastructure as Code (IaC) et de développement d'outils d'administration en ligne de commande (CLI).
66

7-
## Fonctionnalités (v0.3.1)
7+
## Fonctionnalités (v0.5.0)
88

99
- **Auto-détection** : Récupération du nom d'hôte, de la RAM totale et du modèle de CPU.
10+
- **Métriques Système** : Collecte de l'espace disque (`df -h`), du temps d'activité (Uptime) et de la charge système (Load Average).
1011
- **Audit d'activité** : Capture des processus actifs et cartographie de l'arborescence `/home/vagrant`.
1112
- **Audit de sécurité** : Détection des ports réseau en écoute (`ss -tuln`) et identification des utilisateurs avec privilèges sudo.
12-
- **Monitoring système** : Affichage de l'espace disque (`df -h`), de l'uptime et du load average.
13+
- **Tableau de bord web "Live"** : Interface UI/UX moderne (thème Cybersec) avec rafraîchissement asynchrone (API REST / Fetch) en temps réel, propulsé par le micro-framework Flask (port 8080).
1314
- **Interopérabilité** : Exportation des rapports au format texte brut (`.txt`) ou structuré (`.json`).
14-
- **Tableau de bord web** : Visualisation des données en temps réel via un serveur Flask intégré (port 8080), avec rafraîchissement automatique toutes les 5 secondes.
15-
- **API REST** : Endpoint `/api/donnees` retournant les métriques au format JSON.
1615
- **Menu interactif SSH** : Interface de navigation accessible directement depuis la session SSH.
17-
- **Horodatage** : Traçabilité précise de l'heure de l'audit.
18-
- **Version dynamique** : La version est lue automatiquement depuis le `CHANGELOG.md`.
16+
- **Horodatage & Version dynamique** : Traçabilité de l'audit et lecture automatique de la version depuis le `CHANGELOG.md`.
1917
- **Automatisation Cron** : Génération quotidienne automatique d'un rapport JSON à minuit.
2018

2119
## Prérequis
@@ -87,19 +85,19 @@ lsit -v
8785

8886
## Tableau de bord web
8987

90-
Le tableau de bord web est accessible sur `http://localhost:8081` (port forwardé depuis la VM) après le lancement via `lsit --serve` ou l'option 3 du menu interactif.
88+
Le tableau de bord web est accessible sur `http://localhost:8080` après le lancement via `lsit --serve` ou l'option 3 du menu interactif.
9189

92-
Il affiche en temps réel les informations suivantes (rafraîchissement automatique toutes les 5 secondes) :
90+
L'interface a été conçue pour s'actualiser automatiquement et de manière asynchrone (sans rechargement de page) toutes les 5 secondes via une API interne. Elle affiche les informations suivantes :
9391

9492
| Section | Contenu |
9593
| --- | --- |
9694
| Machine | Nom d'hôte de la machine |
9795
| Processeur | Modèle du CPU |
98-
| Mémoire RAM | Quantité totale de RAM |
99-
| Uptime | Temps d'activité du système |
100-
| Load Average | Charge moyenne (1/5/15 min) |
96+
| Mémoire RAM | Quantité totale de RAM avec barre de progression |
10197
| Sudoers | Utilisateurs avec privilèges sudo |
102-
| Espace disque | Sortie de `df -h` |
98+
| Stockage | Espace disque disponible sur les partitions (`df -h`) |
99+
| Uptime | Temps depuis le dernier démarrage |
100+
| Charge Système | Load Average sur 1, 5 et 15 minutes |
103101
| Ports réseau en écoute | Sortie de `ss -tuln` |
104102
| Arborescence /home/vagrant | Structure des dossiers (2 niveaux) |
105103
| Processus actifs | Sortie de `ps aux` |
@@ -143,21 +141,22 @@ Ports ouverts :
143141
Netid State Local Address:Port ...
144142
```
145143

146-
### JSON (`rapport_lsit.json`)
144+
### JSON (`rapport_lsit.json` ou sortie API)
147145

148146
```json
149147
{
150148
"date": "2026-03-26 10:30:00",
151149
"machine": "debian-vm",
152150
"ram": "MemTotal: 2048000 kB",
153151
"cpu": "Intel(R) Core(TM) i7-...",
152+
"uptime": "up 2 hours, 30 minutes",
153+
"load_average": "0.01, 0.05, 0.00",
154+
"stockage": "Filesystem Size Used Avail Use% Mounted on...",
154155
"processus": "...",
155156
"arborescence": "...",
156157
"securite_ports": "Netid State Local Address:Port ...",
157158
"securite_sudoers": "sudo:x:27:vagrant",
158-
"stockage": "Filesystem Size Used Avail Use% ...",
159-
"uptime": "10:30:00 up 2 days, 3:45, 1 user",
160-
"load_average": "0.15, 0.10, 0.05"
159+
"version_lsit": "LSIT v0.5.0"
161160
}
162161
```
163162

0 commit comments

Comments
 (0)