Skip to content

Commit e952674

Browse files
committed
docs(readme): mis à jour de la documentation
1 parent 78de7b8 commit e952674

File tree

1 file changed

+29
-9
lines changed

1 file changed

+29
-9
lines changed

README.md

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,17 @@ 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.0)
7+
## Fonctionnalités (v0.3.1)
88

99
- **Auto-détection** : Récupération du nom d'hôte, de la RAM totale et du modèle de CPU.
1010
- **Audit d'activité** : Capture des processus actifs et cartographie de l'arborescence `/home/vagrant`.
1111
- **Audit de sécurité** : Détection des ports réseau en écoute (`ss -tuln`) et identification des utilisateurs avec privilèges sudo.
1212
- **Interopérabilité** : Exportation des rapports au format texte brut (`.txt`) ou structuré (`.json`).
13-
- **Tableau de bord web** : Visualisation des données en temps réel via un serveur HTTP intégré (port 8080), lancé en arrière-plan grâce au multithreading.
13+
- **Tableau de bord web** : Visualisation des données en temps réel via un serveur Flask intégré (port 8080), lancé en arrière-plan grâce au multithreading.
1414
- **Menu interactif SSH** : Interface de navigation accessible directement depuis la session SSH.
1515
- **Horodatage** : Traçabilité précise de l'heure de l'audit.
1616
- **Version dynamique** : La version est lue automatiquement depuis le `CHANGELOG.md`.
17+
- **Automatisation Cron** : Génération quotidienne automatique d'un rapport JSON à minuit.
1718

1819
## Prérequis
1920

@@ -46,9 +47,11 @@ L'environnement est entièrement automatisé. L'outil s'installe globalement sur
4647
vagrant ssh
4748
```
4849

50+
> Le port `8080` de la VM est automatiquement redirigé vers le port `8081` de la machine hôte.
51+
4952
## Utilisation
5053

51-
Une fois connecté en SSH, la commande `lsit` est disponible globalement sur le système.
54+
Une fois connecté en SSH, le menu interactif se lance automatiquement. La commande `lsit` est également disponible globalement sur le système.
5255

5356
```bash
5457
# Lancer le menu interactif (défaut)
@@ -71,7 +74,7 @@ lsit -v
7174

7275
```text
7376
===================================
74-
LSIT v0.3.0 - 2026-03-25
77+
LSIT v0.3.1 - 2026-03-26
7578
===================================
7679
1. Générer un rapport TXT
7780
2. Générer un rapport JSON
@@ -82,7 +85,7 @@ lsit -v
8285

8386
## Tableau de bord web
8487

85-
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.
88+
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.
8689

8790
Il affiche en temps réel les informations suivantes :
8891

@@ -103,7 +106,7 @@ Pour arrêter le serveur, tapez `exit` ou `end` dans le terminal.
103106
### TXT (`rapport_lsit.txt`)
104107

105108
```text
106-
Date de l'audit : 2026-03-25 10:30:00
109+
Date de l'audit : 2026-03-26 10:30:00
107110
La cible a été identifiée. Nom de la machine : debian-vm
108111
Mémoire totale : MemTotal: 2048000 kB
109112
Modèle du CPU : Intel(R) Core(TM) i7-...
@@ -131,7 +134,7 @@ Netid State Local Address:Port ...
131134

132135
```json
133136
{
134-
"date": "2026-03-25 10:30:00",
137+
"date": "2026-03-26 10:30:00",
135138
"machine": "debian-vm",
136139
"ram": "MemTotal: 2048000 kB",
137140
"cpu": "Intel(R) Core(TM) i7-...",
@@ -142,15 +145,32 @@ Netid State Local Address:Port ...
142145
}
143146
```
144147

148+
## CI/CD — Versioning automatique
149+
150+
Le projet utilise un workflow GitHub Actions (`versionning.yml`) pour gérer le versioning sémantique automatiquement à chaque push sur `main`.
151+
152+
| Préfixe de commit | Effet |
153+
| --- | --- |
154+
| `feat:` / `` / `🚀` | Bump mineur (x.**Y**.0) |
155+
| `fix:` / `🐛` / `perf:` / `refactor:` | Bump patch (x.y.**Z**) |
156+
| `BREAKING CHANGE` / `!:` | Bump majeur (**X**.0.0) |
157+
| `docs:` / autres | Pas de bump |
158+
159+
Le workflow génère et commit automatiquement le `CHANGELOG.md`, puis crée et pousse le tag Git correspondant. Un mode **dry-run** est disponible via `workflow_dispatch` pour prévisualiser les changements sans les appliquer.
160+
145161
## Structure du projet
146162

147163
```text
148164
Linux-System-Inventory-Tool/
165+
├── .github/
166+
│ └── workflows/
167+
│ └── versionning.yml # Workflow CI/CD de versioning sémantique
149168
├── lsit.py # Script principal
150169
├── Vagrantfile # Configuration de la VM Debian 12
151170
├── CHANGELOG.md # Historique des versions
152171
├── templates/
153-
│ ├── dashboard.html # Template du tableau de bord web
172+
│ └── dashboard.html # Template du tableau de bord web (Flask)
173+
├── static/
154174
│ └── dashboard.css # Styles du tableau de bord
155175
└── .gitignore
156-
```
176+
```

0 commit comments

Comments
 (0)