olivier/stupid-simple-network-inventory
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Olivier
2026-05-17 10:21:23 +02:00
parent 9adaf28faa
commit 53417985ba
3 changed files with 90 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.es.md
+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
**Aplicación web autoalojada para inventario de red y visualización de topología lógica**
[English](README.md) · [Français](README.fr.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)
Aplicación web autoalojada para inventario manual de red y visualización de topología de red lógica.
</div>
---
![Vista de Topología](img/tpology.png)
## Características
---
- **Inventario manual** — añade y gestiona dispositivos (18 tipos) con IPs, VLANs, descripciones y enlaces web opcionales
- **Vista de topología** — disposición en tarjetas por red (LAN / VLAN 802.1Q), con secciones WAN y puerta de enlace
- **Ping ICMP** — comprueba la accesibilidad de todos los hosts conocidos con un clic
- **Descubrimiento automático** — ping sweep + consulta PTR DNS en una subred para importar nuevos hosts
- **Autenticación** — inicio de sesión JWT con cambio de contraseña obligatorio en el primer uso
- **Modo oscuro** — alternancia entre tema claro y oscuro
- **Logos de fabricantes** — detección y visualización automáticas de logos de editores/fabricantes (Proxmox, Cisco, Synology, Docker, y más de 30 más)
- **i18n** — francés, inglés, español
## ✨ Características
## Stack
- 🗂️ **Inventario manual** — añade y gestiona dispositivos (18 tipos) con IPs, VLANs, descripciones y enlaces web opcionales
- 🗺️ **Vista de topología** — disposición en tarjetas por red (LAN / VLAN 802.1Q), con secciones WAN y puerta de enlace
- 📡 **Ping ICMP** — comprueba la accesibilidad de todos los hosts conocidos con un clic
- 🔍 **Descubrimiento automático** — ping sweep + consulta PTR DNS en una subred para importar nuevos hosts
- 🏷️ **Logos de fabricantes** — detección y visualización automáticas de logos de editores/fabricantes (Proxmox, Cisco, Synology, Docker, y más de 30 más)
- 🔐 **Autenticación** — inicio de sesión JWT con cambio de contraseña obligatorio en el primer uso
- 🌙 **Modo oscuro** — alternancia entre tema claro y oscuro
- 🌍 **i18n** — francés, inglés, español
## 🛠️ Stack
| Capa | Tecnología |
|------|-----------|
@@ -33,7 +45,7 @@ Aplicación web autoalojada para inventario manual de red y visualización de to
---
## Inicio rápido
## 🚀 Inicio rápido
```bash
# 1. Clonar y entrar en el proyecto
@@ -64,7 +76,7 @@ docker compose --env-file .env up --build -d
---
## Configuración
## ⚙️ Configuración
Toda la configuración se realiza mediante variables de entorno. Ver `.env.example` para la lista completa con descripciones.
@@ -76,8 +88,6 @@ Toda la configuración se realiza mediante variables de entorno. Ver `.env.examp
| `BIND_ADDRESS` | `0.0.0.0` | Dirección IP de escucha. Definir en la interfaz frente al reverse proxy. |
| `DOCKER_UID` / `DOCKER_GID` | `1000` | UID/GID para el proceso backend. Debe coincidir con el usuario propietario de `./db_data/`. |
### Usar .env con Docker Compose
```bash
cp .env.example .env
# Editar .env — definir como mínimo DOCKER_UID, DOCKER_GID, INITIAL_ADMIN_PASSWORD
@@ -86,7 +96,7 @@ docker compose --env-file .env up --build -d
---
## Seguridad
## 🔒 Seguridad
### Gestión de secretos
@@ -120,8 +130,6 @@ Luego descomentar los bloques `secrets:` en `docker-compose.yml` (ver los coment
docker compose up -d
```
---
### Rotación de clave
Para rotar el secreto JWT (invalida todas las sesiones activas):
@@ -142,7 +150,6 @@ docker compose start backend
Esta aplicación no termina TLS. Para uso en producción, colócala detrás de un reverse proxy que gestione HTTPS:
```nginx
# Ejemplo de reverse proxy nginx (externo, en el host o en un contenedor dedicado)
server {
listen 443 ssl;
server_name inventory.example.com;
@@ -172,8 +179,6 @@ services:
### Endurecimiento de contenedores
Los contenedores se ejecutan con privilegios reducidos:
| Medida | Backend | Frontend |
|--------|---------|----------|
| Usuario no-root | `DOCKER_UID:DOCKER_GID` (usuario host) | `nginx` (UID 101) |
@@ -186,7 +191,7 @@ Los contenedores se ejecutan con privilegios reducidos:
---
## Persistencia de datos
## 💾 Persistencia de datos
Todos los datos se almacenan en `./db_data/`:
@@ -201,7 +206,7 @@ Todos los datos se almacenan en `./db_data/`:
---
## Desarrollo
## 🧑‍💻 Desarrollo
### Tests del backend
@@ -227,6 +232,6 @@ npm run dev # Servidor dev Vite en :5173, proxifica /api/ hacia :8000
---
## Arquitectura
## 🏗️ Arquitectura
Ver [`docs/architecture.md`](docs/architecture.md) para el flujo de solicitudes detallado, la configuración Docker y el modelo de autenticación.