Skip to content

Commit 2deb0ac

Browse files
committed
docs(readme): mettre à jour la documentation pour la v0.3.0
- Ajouter les nouvelles fonctionnalités : tableau de bord web, multithreading et menu SSH - Documenter le flag --serve et le menu interactif - Mettre à jour la structure du projet avec le dossier templates/
1 parent 2a4ae9f commit 2deb0ac

File tree

3 files changed

+47
-24
lines changed

3 files changed

+47
-24
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
- web: ajouter le tableau de bord web, le multithreading et le menu d'accueil SSH ([commit be9bde2](https://github.com/Deniz09OK/Linux-System-Inventory-Tool/commit/be9bde2a91e1a2b6528370d695340eeb2d061b1a)) by Deniz09OK
55

66
### 🔀 Merges
7-
- Merge branch 'main' of https://github.com/Deniz09OK/Linux-System-Inventory-Tool- ([commit ec06928](https://github.com/Deniz09OK/Linux-System-Inventory-Tool/commit/ec0692849f4b6a916d0efcf62af85156fe2af04b)) by Deniz09OK
7+
- Merge branch 'main' of https://github.com/Deniz09OK/Linux-System-Inventory-Tool ([commit ec06928](https://github.com/Deniz09OK/Linux-System-Inventory-Tool/commit/ec0692849f4b6a916d0efcf62af85156fe2af04b)) by Deniz09OK
88

99
### 📊 Release Stats
1010
- Commits: 3

README.md

Lines changed: 39 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,29 @@
1-
# LSIT - Linux System Inventory Tool 🐧🔍
1+
# LSIT - Linux System Inventory Tool
22

3-
LSIT est un outil d'inventaire et de cartographie d'infrastructure système développé en Python. Il permet d'auditer rapidement une machine Linux, d'extraire ses métriques vitales et de générer un rapport structuré.
3+
LSIT est un outil d'inventaire et de cartographie d'infrastructure système développé en Python. Il permet d'auditer rapidement une machine Linux, d'extraire ses métriques vitales et de générer un rapport structuré ou de visualiser les données via un tableau de bord web.
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.1.0)
7+
## Fonctionnalités (v0.3.0)
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.
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.
14+
- **Menu interactif SSH** : Interface de navigation accessible directement depuis la session SSH.
1315
- **Horodatage** : Traçabilité précise de l'heure de l'audit.
16+
- **Version dynamique** : La version est lue automatiquement depuis le `CHANGELOG.md`.
1417

15-
## 🛠️ Prérequis
18+
## Prérequis
1619

1720
Pour déployer le laboratoire d'environnement isolé, vous devez avoir installé sur votre machine hôte :
1821

1922
- [Vagrant](https://developer.hashicorp.com/vagrant)
2023
- [VirtualBox](https://www.virtualbox.org/)
2124
- [Git](https://git-scm.com/)
2225

23-
## 📦 Installation et Déploiement
26+
## Installation et Déploiement
2427

2528
L'environnement est entièrement automatisé. L'outil s'installe globalement sur la machine cible lors du provisionnement.
2629

@@ -43,25 +46,41 @@ L'environnement est entièrement automatisé. L'outil s'installe globalement sur
4346
vagrant ssh
4447
```
4548

46-
## 💻 Utilisation
49+
## Utilisation
4750

4851
Une fois connecté en SSH, la commande `lsit` est disponible globalement sur le système.
4952

5053
```bash
51-
# Afficher l'aide
52-
lsit --help
53-
54-
# Générer un rapport texte (défaut)
54+
# Lancer le menu interactif (défaut)
5555
lsit
5656

57-
# Générer un rapport JSON structuré
57+
# Générer directement un rapport texte
58+
lsit --format txt
59+
60+
# Générer directement un rapport JSON structuré
5861
lsit --format json
5962

63+
# Lancer directement le tableau de bord web sur le port 8080
64+
lsit --serve
65+
6066
# Afficher la version
6167
lsit -v
6268
```
6369

64-
## 📄 Format des rapports
70+
### Menu interactif
71+
72+
```text
73+
===================================
74+
LSIT v0.3.0 - 2026-03-25
75+
===================================
76+
1. Générer un rapport TXT
77+
2. Générer un rapport JSON
78+
3. Lancer le tableau de bord web
79+
4. Retour au menu principal
80+
===================================
81+
```
82+
83+
## Format des rapports
6584

6685
### TXT (`rapport_lsit.txt`)
6786

@@ -94,7 +113,7 @@ Netid State Local Address:Port ...
94113

95114
```json
96115
{
97-
"date": "2024-01-15 10:30:00",
116+
"date": "2026-03-25 10:30:00",
98117
"machine": "debian-vm",
99118
"ram": "MemTotal: 2048000 kB",
100119
"cpu": "Intel(R) Core(TM) i7-...",
@@ -105,11 +124,15 @@ Netid State Local Address:Port ...
105124
}
106125
```
107126

108-
## 🗂️ Structure du projet
127+
## Structure du projet
109128

110129
```text
111130
Linux-System-Inventory-Tool/
112-
├── lsit.py # Script principal
113-
├── Vagrantfile # Configuration de la VM Debian 12
131+
├── lsit.py # Script principal
132+
├── Vagrantfile # Configuration de la VM Debian 12
133+
├── CHANGELOG.md # Historique des versions
134+
├── templates/
135+
│ ├── dashboard.html # Template du tableau de bord web
136+
│ └── dashboard.css # Styles du tableau de bord
114137
└── .gitignore
115138
```

templates/dashboard.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,37 +14,37 @@ <h1>&#9001; LSIT &#9002; <span>Tableau de Bord</span></h1>
1414

1515
<div class="grid">
1616
<div class="card">
17-
<h2>&#127968; Machine</h2>
17+
<h2>Machine</h2>
1818
<p><span class="tag green">hostname</span>&nbsp; {{hostname}}</p>
1919
</div>
2020

2121
<div class="card">
22-
<h2>&#9881; Processeur</h2>
22+
<h2>Processeur</h2>
2323
<p>{{cpu_info}}</p>
2424
</div>
2525

2626
<div class="card">
27-
<h2>&#128190; Mémoire RAM</h2>
27+
<h2>Mémoire RAM</h2>
2828
<p>{{ram_info}}</p>
2929
</div>
3030

3131
<div class="card">
32-
<h2>&#128274; Sudoers</h2>
32+
<h2>Sudoers</h2>
3333
<p><span class="tag red">sudo</span>&nbsp; {{utilisateurs_sudo}}</p>
3434
</div>
3535

3636
<div class="card full-width">
37-
<h2>&#127760; Ports réseau en écoute</h2>
37+
<h2>Ports réseau en écoute</h2>
3838
<pre>{{ports_ouverts}}</pre>
3939
</div>
4040

4141
<div class="card full-width">
42-
<h2>&#128230; Arborescence /home/vagrant</h2>
42+
<h2>Arborescence /home/vagrant</h2>
4343
<pre>{{arborescence}}</pre>
4444
</div>
4545

4646
<div class="card full-width">
47-
<h2>&#9881; Processus actifs</h2>
47+
<h2>Processus actifs</h2>
4848
<pre>{{processus_actifs}}</pre>
4949
</div>
5050
</div>

0 commit comments

Comments
 (0)