docs: redesign all READMEs with centered header, emojis and language links

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
2026-05-17 10:21:23 +02:00
parent 9adaf28faa
commit 53417985ba
3 changed files with 90 additions and 75 deletions
+30 -25
View File
@@ -1,4 +1,12 @@
# <img src="frontend/public/favicon.svg" width="22" height="22" alt="" /> Stupid Simple Network Inventory
<div align="center">
<img src="frontend/public/favicon.svg" width="96" height="96" alt="" />
# Stupid Simple Network Inventory
**Application web auto-hébergée pour l'inventaire réseau et la visualisation de topologie logique**
[English](README.md) · [Español](README.es.md)
![Python](https://img.shields.io/badge/Python-3.11-3776AB?logo=python&logoColor=white)
![FastAPI](https://img.shields.io/badge/FastAPI-009688?logo=fastapi&logoColor=white)
@@ -7,22 +15,26 @@
![Nginx](https://img.shields.io/badge/Nginx-009639?logo=nginx&logoColor=white)
![Docker](https://img.shields.io/badge/Docker-2496ED?logo=docker&logoColor=white)
Application web auto-hébergée pour l'inventaire manuel de réseau et la visualisation de topologie réseau logique.
</div>
---
![Vue Topologie](img/tpology.png)
## Fonctionnalités
---
- **Inventaire manuel** — ajout et gestion d'équipements (18 types) avec IPs, VLANs, descriptions et liens web optionnels
- **Vue topologie** — disposition en cards par réseau (LAN / VLAN 802.1Q), avec sections WAN et passerelle
- **Ping ICMP** — vérification de l'accessibilité de tous les hôtes connus en un clic
- **Découverte automatique** — ping sweep + lookup PTR DNS sur un sous-réseau pour importer de nouveaux hôtes
- **Authentification** — connexion JWT avec changement de mot de passe forcé à la première utilisation
- **Mode sombre** — bascule thème clair / sombre
- **Logos de marques** — détection et affichage automatiques des logos éditeurs/fabricants (Proxmox, Cisco, Synology, Docker, et plus de 30 autres)
- **i18n** — français, anglais, espagnol
## ✨ Fonctionnalités
## Stack
- 🗂️ **Inventaire manuel** — ajout et gestion d'équipements (18 types) avec IPs, VLANs, descriptions et liens web optionnels
- 🗺️ **Vue topologie** — disposition en cards par réseau (LAN / VLAN 802.1Q), avec sections WAN et passerelle
- 📡 **Ping ICMP** — vérification de l'accessibilité de tous les hôtes connus en un clic
- 🔍 **Découverte automatique** — ping sweep + lookup PTR DNS sur un sous-réseau pour importer de nouveaux hôtes
- 🏷️ **Logos de marques** — détection et affichage automatiques des logos éditeurs/fabricants (Proxmox, Cisco, Synology, Docker, et plus de 30 autres)
- 🔐 **Authentification** — connexion JWT avec changement de mot de passe forcé à la première utilisation
- 🌙 **Mode sombre** — bascule thème clair / sombre
- 🌍 **i18n** — français, anglais, espagnol
## 🛠️ Stack
| Couche | Technologie |
|--------|------------|
@@ -33,7 +45,7 @@ Application web auto-hébergée pour l'inventaire manuel de réseau et la visual
---
## Démarrage rapide
## 🚀 Démarrage rapide
```bash
# 1. Cloner et entrer dans le projet
@@ -64,7 +76,7 @@ docker compose --env-file .env up --build -d
---
## Configuration
## ⚙️ Configuration
Toute la configuration se fait via des variables d'environnement. Voir `.env.example` pour la liste complète avec descriptions.
@@ -76,8 +88,6 @@ Toute la configuration se fait via des variables d'environnement. Voir `.env.exa
| `BIND_ADDRESS` | `0.0.0.0` | Adresse IP d'écoute. À définir sur l'interface face au reverse proxy. |
| `DOCKER_UID` / `DOCKER_GID` | `1000` | UID/GID pour le processus backend. Doit correspondre à l'utilisateur propriétaire de `./db_data/`. |
### Utilisation de .env avec Docker Compose
```bash
cp .env.example .env
# Éditer .env — définir au minimum DOCKER_UID, DOCKER_GID, INITIAL_ADMIN_PASSWORD
@@ -86,7 +96,7 @@ docker compose --env-file .env up --build -d
---
## Sécurité
## 🔒 Sécurité
### Gestion des secrets
@@ -120,8 +130,6 @@ Décommenter ensuite les blocs `secrets:` dans `docker-compose.yml` (voir les co
docker compose up -d
```
---
### Rotation de clé
Pour faire tourner le secret JWT (invalide toutes les sessions actives) :
@@ -142,7 +150,6 @@ docker compose start backend
Cette application ne termine pas TLS. Pour un usage en production, placez-la derrière un reverse proxy gérant HTTPS :
```nginx
# Exemple de reverse proxy nginx (externe, sur l'hôte ou un conteneur dédié)
server {
listen 443 ssl;
server_name inventory.example.com;
@@ -172,8 +179,6 @@ services:
### Durcissement des conteneurs
Les conteneurs s'exécutent avec des privilèges réduits :
| Mesure | Backend | Frontend |
|--------|---------|----------|
| Utilisateur non-root | `DOCKER_UID:DOCKER_GID` (utilisateur hôte) | `nginx` (UID 101) |
@@ -186,7 +191,7 @@ Les conteneurs s'exécutent avec des privilèges réduits :
---
## Persistance des données
## 💾 Persistance des données
Toutes les données sont stockées dans `./db_data/` :
@@ -201,7 +206,7 @@ Toutes les données sont stockées dans `./db_data/` :
---
## Développement
## 🧑‍💻 Développement
### Tests backend
@@ -227,6 +232,6 @@ npm run dev # Serveur dev Vite sur :5173, proxifie /api/ vers :8000
---
## Architecture
## 🏗️ Architecture
Voir [`docs/architecture.md`](docs/architecture.md) pour le flux de requêtes détaillé, la configuration Docker et le modèle d'authentification.