README : Quick start et section Features

- URL de clone réelle (Gitea)
- Nom de dossier correct après clone
- Suppression de la commande open (macOS-only)
- Ajout d'une section Features pour les visiteurs du dépôt

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
2026-05-17 09:29:37 +02:00
parent b17e31bdb9
commit 481dde6ac5
+16 -6
View File
@@ -2,6 +2,16 @@
Self-hosted web application for manual network inventory and logical network topology visualisation. Self-hosted web application for manual network inventory and logical network topology visualisation.
## Features
- **Manual inventory** — add and manage devices (18 types) with IPs, VLANs, descriptions and optional web links
- **Topology view** — card-based layout per network (LAN / VLAN 802.1Q), with WAN and gateway sections
- **ICMP ping sweep** — check reachability of all known hosts in one click
- **Auto-discovery** — ping sweep + PTR DNS lookup on a subnet to import new hosts
- **Authentication** — JWT-based login with forced password change on first use
- **Dark mode** — light / dark theme toggle
- **i18n** — French, English, Spanish
## Stack ## Stack
| Layer | Technology | | Layer | Technology |
@@ -17,22 +27,22 @@ Self-hosted web application for manual network inventory and logical network top
```bash ```bash
# 1. Clone and enter the project # 1. Clone and enter the project
git clone <repo> && cd topologie git clone https://git.raspot.in/olivier/stupid-simple-network-inventory.git
cd stupid-simple-network-inventory
# 2. Create the data directory owned by the current user # 2. Create the data directory owned by the current user
mkdir -p db_data mkdir -p db_data
# 3. Configure environment (required for correct bind-mount ownership) # 3. Configure environment (required for correct bind-mount ownership)
cp .env.example .env cp .env.example .env
# Set DOCKER_UID / DOCKER_GID to match your host user: # Edit .env:
# id -u && id -g # DOCKER_UID / DOCKER_GID → output of: id -u && id -g
# Set INITIAL_ADMIN_PASSWORD to avoid the admin/admin bootstrap. # INITIAL_ADMIN_PASSWORD → set to avoid the default admin/admin bootstrap
# 4. Build and start # 4. Build and start
docker compose --env-file .env up --build -d docker compose --env-file .env up --build -d
# 5. Open the app # 5. Open http://localhost:8080 in your browser
open http://localhost:8080
``` ```
### First login ### First login