From 8b3955498290454fba1291d5b6d75aca393046ab Mon Sep 17 00:00:00 2001 From: Olivier Date: Sun, 17 May 2026 11:39:46 +0200 Subject: [PATCH] docs: add brand logo detection section to all READMEs Documents keyword-based detection mechanism and lists all 34 supported brands with their trigger keywords, organised by category. Co-Authored-By: Claude Sonnet 4.6 --- README.es.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ README.fr.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 147 insertions(+) diff --git a/README.es.md b/README.es.md index 5537143..670881f 100644 --- a/README.es.md +++ b/README.es.md @@ -270,6 +270,55 @@ Todos los datos se almacenan en `./db_data/`: --- +## 🏷️ Detección de logos de marcas + +La detección se realiza automáticamente sobre el **nombre** y la **descripción** del equipo (coincidencia de palabras clave, sin distinción de mayúsculas). No se requiere configuración manual — basta con incluir una palabra clave reconocible en el nombre o la descripción. + +Los logos se muestran en dos lugares: +- **Vista de topología** — pequeños SVGs en línea junto al nombre del equipo en cada chip +- **Lista de equipos** — badge(s) de color en la card del equipo + +Pueden aparecer varios logos simultáneamente si coinciden varias palabras clave. + +| Categoría | Marca | Palabras clave | +|-----------|-------|----------------| +| Virtualización | Proxmox | `proxmox`, `pve` | +| Virtualización | Docker | `docker` | +| NAS | Synology | `synology`, `dsm` | +| NAS | TrueNAS | `truenas`, `freenas` | +| Red | Ubiquiti / UniFi | `ubiquiti`, `unifi`, `usg`, `udm` | +| Red | MikroTik | `mikrotik`, `routeros` | +| Red | Cisco | `cisco` | +| Red | TP-Link | `tp-link`, `tplink` | +| Red | ASUS | `asus` | +| Red | Netgear | `netgear` | +| Red | pfSense | `pfsense` | +| Red | OPNsense | `opnsense` | +| Red | OpenWrt | `openwrt` | +| Web / proxy | Apache | `apache`, `apache2`, `httpd` | +| Web / proxy | Traefik | `traefik` | +| Base de datos | MariaDB | `mariadb` | +| Orquestación | Kubernetes | `kubernetes`, `k8s`, `kubectl`, `k3s` | +| OS | Debian | `debian` | +| OS | Ubuntu | `ubuntu` | +| Automatización | Ansible | `ansible` | +| Servidores | Dell | `dell`, `idrac`, `poweredge` | +| Servidores | HP | `proliant`, `ilo`, `hewlett` | +| SBC / DIY | Raspberry Pi | `raspberry`, `rpi`, `raspi` | +| SBC / DIY | Arduino | `arduino` | +| Escritorio | KDE / Plasma | `kde`, `plasma` | +| Herramientas | Excalidraw | `excalidraw` | +| Self-hosted | Nextcloud | `nextcloud` | +| Self-hosted | Paperless-NGX | `paperless`, `paperless-ngx` | +| Self-hosted | Uptime Kuma | `uptime-kuma`, `uptime kuma` | +| Self-hosted | MkDocs | `mkdocs` | +| Medios / domótica | Jellyfin | `jellyfin` | +| Medios / domótica | Home Assistant | `homeassistant`, `home assistant`, `hassio` | +| Medios / domótica | Philips Hue | `philips hue`, `hue bridge` | +| Medios / domótica | Xiaomi | `xiaomi`, `mi home`, `yeelight` | + +--- + ## 🧑‍💻 Desarrollo ### Tests del backend diff --git a/README.fr.md b/README.fr.md index a5bb3b2..ab1a58e 100644 --- a/README.fr.md +++ b/README.fr.md @@ -270,6 +270,55 @@ Toutes les données sont stockées dans `./db_data/` : --- +## 🏷️ Détection des logos de marques + +La détection s'effectue automatiquement sur le **nom** et la **description** de l'équipement (correspondance de mots-clés, insensible à la casse). Aucune configuration manuelle nécessaire — il suffit d'inclure un mot-clé reconnaissable dans le nom ou la description. + +Les logos s'affichent à deux endroits : +- **Vue topologie** — petits SVGs inline à côté du nom de l'équipement sur chaque chip +- **Liste des équipements** — badge(s) coloré(s) dans la card de l'équipement + +Plusieurs logos peuvent s'afficher simultanément si plusieurs mots-clés correspondent. + +| Catégorie | Marque | Mots-clés déclencheurs | +|-----------|--------|------------------------| +| Virtualisation | Proxmox | `proxmox`, `pve` | +| Virtualisation | Docker | `docker` | +| NAS | Synology | `synology`, `dsm` | +| NAS | TrueNAS | `truenas`, `freenas` | +| Réseau | Ubiquiti / UniFi | `ubiquiti`, `unifi`, `usg`, `udm` | +| Réseau | MikroTik | `mikrotik`, `routeros` | +| Réseau | Cisco | `cisco` | +| Réseau | TP-Link | `tp-link`, `tplink` | +| Réseau | ASUS | `asus` | +| Réseau | Netgear | `netgear` | +| Réseau | pfSense | `pfsense` | +| Réseau | OPNsense | `opnsense` | +| Réseau | OpenWrt | `openwrt` | +| Web / proxy | Apache | `apache`, `apache2`, `httpd` | +| Web / proxy | Traefik | `traefik` | +| Base de données | MariaDB | `mariadb` | +| Orchestration | Kubernetes | `kubernetes`, `k8s`, `kubectl`, `k3s` | +| OS | Debian | `debian` | +| OS | Ubuntu | `ubuntu` | +| Automatisation | Ansible | `ansible` | +| Serveurs | Dell | `dell`, `idrac`, `poweredge` | +| Serveurs | HP | `proliant`, `ilo`, `hewlett` | +| SBC / DIY | Raspberry Pi | `raspberry`, `rpi`, `raspi` | +| SBC / DIY | Arduino | `arduino` | +| Bureau | KDE / Plasma | `kde`, `plasma` | +| Outils | Excalidraw | `excalidraw` | +| Self-hosted | Nextcloud | `nextcloud` | +| Self-hosted | Paperless-NGX | `paperless`, `paperless-ngx` | +| Self-hosted | Uptime Kuma | `uptime-kuma`, `uptime kuma` | +| Self-hosted | MkDocs | `mkdocs` | +| Médias / domotique | Jellyfin | `jellyfin` | +| Médias / domotique | Home Assistant | `homeassistant`, `home assistant`, `hassio` | +| Médias / domotique | Philips Hue | `philips hue`, `hue bridge` | +| Médias / domotique | Xiaomi | `xiaomi`, `mi home`, `yeelight` | + +--- + ## 🧑‍💻 Développement ### Tests backend diff --git a/README.md b/README.md index 35136b8..0153012 100644 --- a/README.md +++ b/README.md @@ -270,6 +270,55 @@ 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. + +Logos are displayed in two places: +- **Topology view** — small inline SVGs next to the device name on each 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` | +| Network | Ubiquiti / UniFi | `ubiquiti`, `unifi`, `usg`, `udm` | +| Network | MikroTik | `mikrotik`, `routeros` | +| Network | Cisco | `cisco` | +| Network | TP-Link | `tp-link`, `tplink` | +| Network | ASUS | `asus` | +| Network | Netgear | `netgear` | +| Network | pfSense | `pfsense` | +| Network | OPNsense | `opnsense` | +| Network | OpenWrt | `openwrt` | +| Web / proxy | Apache | `apache`, `apache2`, `httpd` | +| Web / proxy | Traefik | `traefik` | +| Database | MariaDB | `mariadb` | +| Orchestration | Kubernetes | `kubernetes`, `k8s`, `kubectl`, `k3s` | +| OS | Debian | `debian` | +| OS | Ubuntu | `ubuntu` | +| Automation | Ansible | `ansible` | +| Servers | Dell | `dell`, `idrac`, `poweredge` | +| Servers | HP | `proliant`, `ilo`, `hewlett` | +| SBC / DIY | Raspberry Pi | `raspberry`, `rpi`, `raspi` | +| SBC / DIY | Arduino | `arduino` | +| Desktop | KDE / Plasma | `kde`, `plasma` | +| Tools | Excalidraw | `excalidraw` | +| Self-hosted | Nextcloud | `nextcloud` | +| Self-hosted | Paperless-NGX | `paperless`, `paperless-ngx` | +| Self-hosted | Uptime Kuma | `uptime-kuma`, `uptime kuma` | +| Self-hosted | MkDocs | `mkdocs` | +| Media / home automation | Jellyfin | `jellyfin` | +| Media / home automation | Home Assistant | `homeassistant`, `home assistant`, `hassio` | +| Media / home automation | Philips Hue | `philips hue`, `hue bridge` | +| Media / home automation | Xiaomi | `xiaomi`, `mi home`, `yeelight` | + +--- + ## 🧑‍💻 Development ### Backend tests