Server Dashboard

🇬🇧 English version

Dashboard web auto-hébergé, dans l'esprit de Homarr, pour accéder aux services de ton serveur depuis une seule page. Interface en français et en anglais (bouton EN / FR).

Captures réalisées avec les faux services de npm run mocks.

• Tuiles d'applications classées par catégories, avec icônes (dashboardicons.com) et indicateur en ligne / hors ligne. Le ping est fait côté serveur, donc il marche aussi pour les services du réseau local. Une tuile peut être liée à sa VM, son LXC Proxmox ou son conteneur Docker pour afficher leur CPU et leur RAM.
• Stats du serveur : CPU, mémoire, disque, uptime (mises à jour toutes les 5 s).
• Panneau Docker : liste des conteneurs et leur état, avec démarrage, arrêt et redémarrage.
• Recherche rapide : commence à taper n’importe où. Elle filtre les tuiles et propose, au clavier, la tuile à ouvrir, l’adresse tapée (nas.maison:8080) ou une recherche web (DuckDuckGo, Google, Qwant…, ou une adresse personnalisée, réglable dans Affichage).
• Widgets d'intégration :
  • Jellyfin / Plex : lectures en cours (utilisateur, progression, pause) et taille de la bibliothèque.
  • qBittorrent : débits, torrents actifs, progression et temps restant.
  • Sonarr / Radarr / Lidarr / Readarr : épisodes, films, albums et livres à venir, file de téléchargement.
  • Prowlarr : indexeurs actifs et en pause, requêtes et téléchargements récupérés. Bazarr : épisodes et films sans sous-titres.
  • Proxmox VE : stats de l’hôte, VM et conteneurs LXC, stockages.
  • Proxmox Backup Server : sauvegardes réussies et en échec des dernières 24 h, occupation des datastores.
  • Scrutiny : santé SMART des disques, ceux en échec en premier, avec leur température.
  • Speedtest Tracker : dernier test de débit, moyenne sur 7 jours et derniers tests.
  • Uptime Kuma : sondes d’une page de statut, celles en panne en premier, avec le temps de réponse et la disponibilité sur 24 h.
  • Glances : CPU, mémoire, disques, température et uptime d’une autre machine (PC, Raspberry Pi, NAS…), un widget par machine ; une machine éteinte est clairement signalée.
  • Pulse : santé globale, alertes actives, nœuds / VM / LXC, en blocs à placer où tu veux.
  • Pi-hole / AdGuard Home : requêtes DNS, requêtes bloquées et pourcentage, état de la protection (avec la pause en cours).
  • Immich : nombre de photos et de vidéos, stockage utilisé, détail par utilisateur avec les quotas. Si un compteur de téléchargements dl-stats est placé devant Immich, ses totaux (téléchargements, photos téléchargées, visiteurs) s’affichent aussi.
  • GoAccess : visiteurs uniques d’un site (total, aujourd’hui, 7 derniers jours), requêtes et trafic, lus dans un rapport JSON de GoAccess.
  • Alwaysdata : les sites d’un compte d’hébergement, chacun testé par le dashboard (en ligne, en panne, temps de réponse), ceux en panne en premier.
  • Calendrier : les événements des 7 prochains jours d’un ou plusieurs agendas iCal (Nextcloud, Google Agenda, Proton…), récurrents compris, groupés par jour.
  • Flux RSS / Atom : les 10 derniers articles d’un ou plusieurs flux, mélangés par date.
  • CrowdSec : les attaques détectées sur ton serveur dans les dernières 24 h (adresse, pays, opérateur, scénario), les plus actifs, et les adresses bannies ; alerte en cas de pic.
  • Wazuh : les agents actifs et déconnectés, et, avec l’indexer, les alertes de sécurité des 24 h par gravité ; alerte quand un agent se déconnecte ou en cas d’alerte critique.
  • Traefik : routeurs, services et middlewares, avec ceux en erreur ou en alerte ; alerte quand un routeur tombe en erreur.
  • Météo : température actuelle et prévisions sur 5 jours (Open-Meteo, sans clé API).
  • Frigate : caméras en ligne et images par seconde, vitesse de détection, derniers événements (personne, voiture…) avec leur miniature, servie par le dashboard.
  • Home Assistant : les capteurs choisis (température, consommation, portes, mouvement, lumières, présence…), avec leur état traduit et depuis quand.
  • Nginx Proxy Manager : hôtes actifs et désactivés, certificats SSL triés par date d’expiration, ceux qui expirent dans les 14 jours mis en évidence.
  • GitHub : suivre un dépôt, avec sa dernière version, les commits non publiés depuis, les issues et les pull requests ouvertes.
  • API personnalisée : n’importe quelle API JSON (service sans widget, script maison) : on choisit les valeurs à afficher par leur chemin dans la réponse, avec un format (nombre, pourcentage, octets, débit, date).
• Mode édition protégé par mot de passe : ajouter, modifier ou supprimer des apps et des catégories, réordonner par glisser-déposer.
• Onglets (ex. « Maison », « Serveur », « Médias ») pour répartir widgets et catégories sur plusieurs pages, avec un lien direct par onglet (#medias). La recherche parcourt tous les onglets.
• Catégories repliables d’un clic sur leur titre (état mémorisé dans le navigateur, ou repliées par défaut), avec une icône facultative.
• Agent pour les machines derrière un NAT ou sans port ouvert : un petit script (Node.js, sans dépendance) envoie lui-même CPU, mémoire, disques et température au dashboard ; voir agent/README.md.
• Notifications vers ntfy, Gotify, Discord ou un webhook quand une application tombe, puis quand elle revient : le serveur vérifie toutes les minutes, même dashboard fermé. Avec la case « M’alerter » d’un widget, aussi pour ce qu’il surveille : VM, conteneur ou nœud Proxmox arrêté, disque à plus de 90 % (Proxmox, Glances, Agent), machine Glances ou Agent hors ligne, certificat Nginx Proxy Manager qui expire dans 7 jours, sonde Uptime Kuma hors ligne, caméra Frigate coupée.
• Sauvegarde : export de la configuration en un fichier (avec ou sans les clés API), et import pour la restaurer ou la recopier sur une autre machine.

Stack : Node.js + Express côté serveur, HTML/CSS/JS sans étape de build côté client. La config est stockée dans data/config.json.

Déploiement sur le serveur (Docker)

L'image est publiée à chaque version sur ghcr.io/circule-studio/server-dashboard (amd64 et arm64, donc Raspberry Pi compris) : pas besoin de cloner le dépôt.

1. Récupère les deux fichiers de configuration :

   mkdir server-dashboard && cd server-dashboard
   curl -fsSLO https://raw.githubusercontent.com/Circule-studio/server-dashboard/main/compose.yaml
   curl -fsSL https://raw.githubusercontent.com/Circule-studio/server-dashboard/main/.env.example -o .env
   

2. Ouvre .env et remplace change-moi par un vrai mot de passe. .env ne doit jamais être publié : ne mets pas de mot de passe directement dans compose.yaml.

3. Lance :

   docker compose up -d
   

4. Ouvre http://IP-DU-SERVEUR:7575 : un écran d'accueil te guide (Connexion, puis Éditer).

Mettre à jour : docker compose pull && docker compose up -d. La config reste dans ./data.

Depuis le code source (développement) : clone le dépôt, remplace la ligne image: de compose.yaml par build: ., puis docker compose up -d --build.

Installation sans Docker (Debian / Ubuntu, LXC Proxmox)

Une commande, en root, sur Debian 12+ ou Ubuntu 22.04+ avec systemd. Ça marche aussi dans un conteneur LXC Proxmox ou sur un Raspberry Pi :

curl -fsSL https://raw.githubusercontent.com/Circule-studio/server-dashboard/main/packaging/install.sh | sudo bash

Le script :

• installe Node.js 22 si besoin ;
• télécharge la dernière release dans /opt/server-dashboard ;
• crée un utilisateur système server-dashboard et un service systemd du même nom ;
• génère un mot de passe admin et l'affiche une seule fois.

Quoi	Où
Réglages (mot de passe, port, REQUIRE_LOGIN…)	/etc/server-dashboard/server-dashboard.env, puis sudo systemctl restart server-dashboard
Config du dashboard (tuiles, widgets)	/var/lib/server-dashboard/
Logs	journalctl -u server-dashboard -f

• Mettre à jour : relance la même commande. La config et les réglages sont conservés.
• Choisir une version, un port ou un mot de passe à la première installation : … | sudo SD_VERSION=v0.1.0 SD_PORT=8080 SD_ADMIN_PASSWORD=… bash
• Désinstaller : … | sudo bash -s -- --uninstall (ajoute --purge pour effacer aussi la config).
• Panneau Docker : si Docker est installé sur la machine, le service est ajouté au groupe docker. Sinon, le panneau est simplement masqué.

Développement en local

npm install
npm run dev

Puis ouvre http://localhost:7575. Le mot de passe est celui de ton fichier .env s'il existe (attention aux majuscules), sinon admin.

Pour travailler sur les widgets sans avoir les vrais services, lance un faux service pour chaque widget (Jellyfin, Plex, Proxmox, Home Assistant, GitHub…) et un faux Docker dans un second terminal :

npm run mocks

Les URL et clés de test à saisir sont en tête de dev/mocks.js.

Plusieurs disques

En mode édition, le bouton Disques liste les disques détectés sur la machine (C:\, D:\… sous Windows, les partitions réelles comme / ou /mnt/data sous Linux). Coche ceux à afficher et donne-leur un nom (« Films », « Sauvegardes »…) : chacun a sa carte dans les stats. Tu peux aussi saisir un chemin à la main (partage réseau monté, dossier…).

Avec Docker, le conteneur ne voit que ce qui est monté. compose.yaml monte déjà la racine de l'hôte en lecture seule (/:/host:ro) : les autres disques de l'hôte apparaissent sous /host/… (ex. /host/mnt/data). Un disque monté ailleurs peut être ajouté explicitement :

    volumes:
      - /srv/films:/host/srv/films:ro

Dans un conteneur LXC Proxmox, le dashboard ne voit que le disque du conteneur : utilise plutôt le widget Proxmox VE pour les stockages de l'hôte.

Widgets : où trouver les identifiants

Service	Champs	Où les trouver
Jellyfin	URL + clé API	Tableau de bord > Clés API > « + »
Plex	URL + token	Valeur X-Plex-Token (doc Plex)
qBittorrent	URL + utilisateur / mot de passe de la WebUI	Options > Interface web
Sonarr / Radarr / Lidarr / Readarr / Prowlarr	URL + clé API	Settings > General > API Key
Bazarr	URL (http://IP:6767) + clé API	Settings > General > Security > API Key
Pulse	URL (http://IP:7655) + jeton d’API	Pulse > Paramètres > API Access, scope monitoring:read
Proxmox VE	URL (https://IP:8006) + identifiant et secret d’un jeton d’API	Voir ci-dessous
Proxmox Backup Server	URL (https://IP:8007) + identifiant et secret d’un jeton d’API	Configuration > Access Control > API Token, avec le rôle Audit sur / pour le jeton (lecture seule)
Scrutiny	URL de l’interface (http://IP:8080)	Aucune clé
Speedtest Tracker	URL + jeton d’API facultatif	v1 : Settings > API Tokens (lecture). Sans jeton : ancienne API publique (v0)
Pi-hole (v6)	URL (http://IP) + mot de passe	Celui de l’interface web. Avec la 2FA : mot de passe d’application (Paramètres > Web interface / API, mode Expert, « Configure app password »). Vide si Pi-hole n’a pas de mot de passe
AdGuard Home	URL (http://IP) + utilisateur / mot de passe	Ceux de l’interface web (vides si elle n’en a pas)
Immich	URL (http://IP:2283) + clé API	Paramètres du compte > Clés API, avec un compte administrateur (permission server.statistics si la clé est limitée)
Calendrier	Adresse(s) .ics + identifiant / mot de passe facultatifs

Pulse : coche les blocs à afficher (Santé, Alertes, Nœuds / VM / LXC). Pour les placer librement, ajoute plusieurs widgets Pulse avec chacun un bloc, puis déplace-les par glisser-déposer.

Proxmox VE : le widget affiche les stats de l’hôte (CPU, RAM, disque), l’état de toutes les VM et conteneurs LXC, et les stockages. C’est la façon de voir la machine complète quand le dashboard tourne lui-même dans un LXC, qui ne voit que ses propres limites. Crée un jeton en lecture seule dans le shell de l’hôte Proxmox :

pveum user token add root@pam dashboard --privsep 1
pveum acl modify / --tokens "root@pam!dashboard" --roles PVEAuditor

La première commande affiche le secret (une seule fois). Dans le widget : identifiant root@pam!dashboard, secret = la valeur value affichée.

Les URL doivent être joignables depuis le serveur du dashboard (par exemple http://jellyfin:8096 si les deux sont dans le même réseau Docker). Les clés et mots de passe restent sur le serveur : ils ne sont jamais renvoyés au navigateur.

Versions

Les versions stables sont publiées dans les Releases, et le détail des changements est dans le CHANGELOG. Pour publier une version : mettre à jour version dans package.json et CHANGELOG.md, fusionner dans main, puis pousser un tag vX.Y.Z. Le workflow release.yml crée la release.

Contribuer

Les contributions sont bienvenues, en particulier sur l'interface. Voir CONTRIBUTING.md.

Variables d'environnement

Variable	Défaut	Rôle
PORT	7575	Port HTTP
ADMIN_PASSWORD	admin	Mot de passe du mode édition
DATA_DIR	./data	Dossier de la config et du secret de session
SERVER_NAME	nom de la machine	Nom affiché à côté du titre (utile en Docker)
DISK_PATH	/ (C:\ sous Windows)	Disque affiché par défaut, tant qu'aucun disque n'est choisi en mode édition
DOCKER_SOCKET	/var/run/docker.sock	Socket de l'API Docker
REQUIRE_LOGIN	false	true : tout le dashboard (lecture comprise) exige d’être connecté
TRUST_PROXY	–	Derrière un reverse proxy, mettre 1 pour que la limite de tentatives de connexion voie la vraie IP des visiteurs
SESSION_SECRET	généré dans data/.secret	Clé de signature des cookies de session
NOTIFY_INTERVAL_MS	60000	Intervalle de vérification des applications pour les notifications (en millisecondes)
UPDATE_CHECK	true	false : ne pas vérifier sur GitHub si une nouvelle version existe (la version installée reste affichée à l’admin)

Sécurité

• Les tentatives de connexion sont limitées à 10 par IP toutes les 15 minutes. Changer ADMIN_PASSWORD déconnecte toutes les sessions ouvertes.
• Par défaut, le dashboard est lisible sans connexion (seule la modification est protégée). Si tu l’exposes en dehors de ton réseau, mets REQUIRE_LOGIN=true.
• Monter /var/run/docker.sock donne au conteneur un accès équivalent à root sur l'hôte. Les actions Docker exigent d'être connecté, mais n'expose pas le dashboard directement sur Internet : place-le derrière un reverse proxy en HTTPS (Nginx Proxy Manager, Caddy, Traefik) ou derrière un VPN (WireGuard, Tailscale).
• Pour un panneau Docker en lecture seule, utilise un proxy de socket comme tecnativa/docker-socket-proxy et pointe DOCKER_SOCKET dessus (ou retire simplement le volume).

API

Méthode	Route	Auth
GET	/api/config	–
PUT	/api/config	✔
GET	/api/status	–
GET	/api/system	–
GET	/api/widgets/:id	–
GET	/api/docker/containers	–
POST	/api/docker/containers/:id/(start|stop|restart)	✔
POST	/api/login, /api/logout · GET /api/me	–