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

docs: update READMEs — IP view, OS detection, auto brand icons

Browse Source 
- Add IP addressing view and collapsible groups to features list
- Add OS auto-detection feature bullet
- Replace 90-entry brand logo table with description of AUTO_SI
  approach (simple-icons full import, ~3000 logos, word-boundary regex)
- Update brand logo count from "30+" to "3000+"

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Olivier
2026-05-22 10:30:13 +02:00
parent 66aeb04cb5
commit be64727d48
3 changed files with 27 additions and 351 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -117
View File
@@ -28,9 +28,11 @@
- 🗂️ **Manual inventory** — add and manage devices (21 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
- 🌐 **IP addressing view** — IP list grouped by network, groups collapsible individually or all at once
- 📡 **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
- 🏷️ **Brand logos** — automatic detection and display of vendor logos (Proxmox, Cisco, Synology, Docker, 30+ more)
- 🏷️ **Brand logos** — automatic detection from name and description via [simple-icons](https://simpleicons.org/) (3,000+ logos); custom aliases for common variants (`pve`, `unifi`, `k3s`…)
- 🖥️ **OS detection** — operating system icon inferred automatically from the description (51 recognised distributions)
- 🔐 **Authentication** — JWT-based login with forced password change on first use
- 🌙 **Dark mode** — light / dark theme toggle
- 🌍 **i18n** — French, English, Spanish
@@ -273,128 +275,18 @@ All data is stored in `./db_data/`:
## 🏷️ Brand logo detection
Logo detection runs automatically against the device **name** and **description** fields (case-insensitive keyword matching). No manual configuration needed — just include a recognisable keyword in the name or description.
Logo detection runs automatically against the device **name** and **description** fields (case-insensitive, whole-word matching). No manual configuration needed.
Logos are displayed in two places:
- **Topology view** — small inline SVGs next to the device name on each chip
- **Topology view** — small inline SVGs on each device chip
- **Device list** — coloured badge(s) in the device card
Multiple logos can appear simultaneously if several keywords match.
| Category | Brand | Trigger keywords |
|----------|-------|-----------------|
| Virtualisation | Proxmox | `proxmox`, `pve` |
| Virtualisation | Docker | `docker` |
| NAS | Synology | `synology`, `dsm` |
| NAS | TrueNAS | `truenas`, `freenas` |
| UPS | Schneider Electric / APC | `apc`, `schneider electric`, `symmetra`, `smart-ups`, `easy ups`, `galaxy ups` |
| UPS | Eaton | `eaton`, `powerware`, `eaton ups` |
| UPS | Riello | `riello`, `riello ups` |
| UPS | Vertiv | `vertiv`, `liebert`, `avocent`, `geist` |
| French ISP | Orange | `orange`, `sosh`, `livebox` |
| French ISP | OVH | `ovh`, `ovhcloud`, `kimsufi`, `soyoustart` |
| French ISP | Free | `freebox`, `free mobile`, `free telecom`, `iliad` |
| French ISP | Bouygues Telecom | `bouygues`, `bbox` |
| French ISP | SFR | `sfr`, `red by sfr`, `sfr box` |
| Network | Ubiquiti / UniFi | `ubiquiti`, `unifi`, `usg`, `udm` |
| Network | MikroTik | `mikrotik`, `routeros` |
| Network | Cisco | `cisco` |
| Network | TP-Link | `tp-link`, `tplink`, `tp link` |
| Network | ASUS | `asus` |
| Network | Netgear | `netgear` |
| Network | pfSense | `pfsense` |
| Network | OPNsense | `opnsense` |
| Network | OpenWrt | `openwrt` |
| Network security | Fortinet / FortiGate | `fortinet`, `fortigate`, `fortios`, `fortimanager`, `fortiauthenticator` |
| Web / proxy | Apache | `apache`, `apache2`, `httpd` |
| Web / proxy | Nginx | `nginx` |
| Web / proxy | Traefik | `traefik` |
| Web / proxy | Apache Guacamole | `guacamole` |
| Bastion | Bastion / jump host | `bastion`, `jumphost`, `jump host`, `jump server`, `teleport`, `bastillion` |
| Auth / SSO | Authelia | `authelia` |
| Auth / SSO | Keycloak | `keycloak` |
| Auth / SSO | Authentik | `authentik` |
| Auth / SSO | Okta | `okta` |
| Auth / SSO | Auth0 | `auth0` |
| Password vault | Vaultwarden | `vaultwarden` |
| Password vault | Bitwarden | `bitwarden` |
| Password vault | 1Password | `1password`, `onepassword` |
| Password vault | KeePassXC | `keepass`, `keepassxc` |
| Password vault | HashiCorp Vault | `hashicorp vault`, `hashicorp` |
| Archiving | Archive server | `archive`, `archiver`, `archivage`, `archivar`, `archivebox` |
| Mail | Mail server | `mail`, `smtp`, `imap`, `postfix`, `dovecot`, `mailcow`, `mailu`, `roundcube` |
| Database | MariaDB | `mariadb`, `maria db` |
| Orchestration | Kubernetes | `kubernetes`, `k8s`, `kubectl`, `k3s` |
| Monitoring | Zabbix | `zabbix` |
| Monitoring | Centreon | `centreon` |
| Monitoring | Nagios | `nagios`, `nagiosxi`, `nagios xi` |
| Monitoring | PRTG | `prtg`, `paessler` |
| Monitoring | Prometheus | `prometheus` |
| Monitoring | Grafana | `grafana` |
| Monitoring | Datadog | `datadog` |
| Monitoring | Netdata | `netdata` |
| Monitoring | Checkmk | `checkmk`, `check_mk` |
| Monitoring | Icinga | `icinga`, `icinga2` |
| Monitoring | InfluxDB | `influxdb`, `influx db` |
| Monitoring | VictoriaMetrics | `victoriametrics`, `victoria metrics` |
| Alerting | Opsgenie | `opsgenie` |
| Alerting | PagerDuty | `pagerduty`, `pager duty` |
| Logs / Traces | Elastic / ELK | `elasticsearch`, `elastic stack`, `elk` |
| Logs / Traces | Kibana | `kibana` |
| Logs / Traces | Logstash | `logstash` |
| Logs / Traces | Splunk | `splunk` |
| Logs / Traces | Graylog | `graylog` |
| Logs / Traces | Jaeger | `jaeger` |
| Logs / Traces | OpenTelemetry | `opentelemetry`, `otel` |
| Apple ecosystem | Apple | `apple`, `iphone`, `ipad`, `ipados`, `macbook`, `imac`, `mac mini`, `mac pro`, `mac studio`, `macos`, `mac os`, `ios`, `icloud`, `airpods`, `airdrop` |
| OS | Windows | `windows`, `win10`, `win11`, `winserver`, `windows server` |
| OS | Debian | `debian` |
| OS | Ubuntu | `ubuntu` |
| Automation | Ansible | `ansible` |
| Servers | Dell | `dell`, `idrac`, `poweredge` |
| Servers | HP | `proliant`, `ilo`, `hewlett` |
| SBC / DIY | Raspberry Pi | `raspberry`, `raspberrypi`, `rpi`, `raspi` |
| SBC / DIY | Arduino | `arduino` |
| Browser | Firefox | `firefox` |
| Desktop | KDE / Plasma | `kde`, `plasma`, `kde desktop` |
| Tools | Excalidraw | `excalidraw` |
| Self-hosted | Nextcloud | `nextcloud` |
| Self-hosted | Paperless-NGX | `paperless`, `paperless-ng`, `paperless-ngx` |
| Self-hosted | Uptime Kuma | `uptime-kuma`, `uptimekuma`, `uptime kuma` |
| Self-hosted | MkDocs | `mkdocs`, `material for mkdocs` |
| CMS / Blog | WordPress | `wordpress` |
| CMS / Blog | Ghost | `ghost` |
| CMS / Blog | Grav | `grav` |
| CMS / Blog | Jekyll | `jekyll` |
| CMS / Blog | Hugo | `hugo` |
| CMS / Blog | Hexo | `hexo` |
| CMS / Blog | Drupal | `drupal` |
| CMS / Blog | Joomla | `joomla` |
| CMS / Blog | TYPO3 | `typo3` |
| CMS / Blog | OctoberCMS | `octobercms`, `october cms` |
| CMS / Blog | Textpattern | `textpattern` |
| Analytics | Matomo | `matomo` |
| Analytics | Plausible | `plausible` |
| Smart TV | Samsung | `samsung`, `tizen`, `samsung tv` |
| Smart TV | LG | `lg`, `webos`, `lg tv` |
| Smart TV | Sony | `sony`, `bravia` |
| Smart TV | Panasonic | `panasonic` |
| Smart TV | Sharp | `sharp` |
| Smart TV | Toshiba | `toshiba` |
| Smart TV | Vestel | `vestel` |
| TV Box | Chromecast / Google TV | `chromecast`, `google tv` |
| TV Box | Android TV | `android tv`, `androidtv` |
| TV Box | Apple TV | `apple tv`, `appletv` |
| TV Box | Amazon Fire TV | `fire tv`, `firetv`, `amazon fire` |
| TV Box | Roku | `roku` |
| TV Box | Kodi | `kodi` |
| Media / torrent | Radarr | `radarr` |
| Media / torrent | Sonarr | `sonarr` |
| Media / torrent | Transmission | `transmission` |
| Media / home automation | Jellyfin | `jellyfin` |
| Media / home automation | Home Assistant | `homeassistant`, `home assistant`, `hassio`, `hass` |
| Media / home automation | Philips Hue | `philips hue`, `hue bridge`, `hue hub` |
| Media / home automation | Xiaomi | `xiaomi`, `mi home`, `yeelight` |
**Source**: the [simple-icons](https://simpleicons.org/) library is fully imported (~3,000 logos). Detection runs in two passes:
1. **Curated aliases** — ~50 entries for cases not covered by the exact icon title: common aliases (`pve` → Proxmox, `unifi` → Ubiquiti, `k3s` → Kubernetes, `routeros` → MikroTik…), icons absent from simple-icons (Eaton, Riello, Vertiv, Zabbix, Centreon, Nagios, PRTG, Free, Bouygues, SFR, Windows…), custom colours or shapes.
2. **Auto-detection** — all remaining simple-icons logos (title ≥ 4 characters) are automatically available: Grafana, Gitea, Portainer, GitLab, Immich, and thousands more, with no additional code.
---