david/homelab-dashboard
Watch
1
0
Fork
You've already forked homelab-dashboard
 0
Code Issues Pull requests Projects Releases 93 Packages 1 Wiki Activity Actions
Page: Home
Pages
Changelog Container Registry Dense View Design Language Documentation Screenshots Grimmory Home Kavita Lab View Module Setup Navidrome Notifications Plex Proxmox Roadmap SABnzbd Security Hardening Seerr Requests Storage Health UniFi Network Uptime Kuma Wallboard White Labeling qBittorrent
16 Home
David Spitzer edited this page 2026-10-21 13:39:00 -07:00
Table of contents

Homelab Dashboard Wiki

Operational documentation for the Homelab Dashboard.

Setup

  • Module Setup: start here for dashboard admin setup and troubleshooting.
  • White Labeling: rename the dashboard, customize header copy, logo URL, and documentation links.
  • Uptime Kuma: public status-page monitor data.
  • Proxmox: cluster resources, nodes, guests, and backup status.
  • Plex: Plex sign-in, token setup, libraries, and active streams.
  • Seerr Requests: Overseerr/Jellyseerr stats, search, and request submission.
  • UniFi Network: UniFi Cloud and local Network API setup.
  • Storage Health: TrueNAS, ASUSTOR and UniFi NAS storage health and capacity setup.
  • qBittorrent: WebUI login, transfer speeds, torrent errors and free disk space.
  • SABnzbd: API key, queue, failed downloads and free disk space.
  • Kavita: Kavita Auth Key and library stats.
  • Grimmory: Grimmory Komga-compatible API setup.
  • Navidrome: Subsonic API library and now-playing stats.
  • Notifications: optional webhook alerts.

Views

  • Dense View: the default page at /, an operations console for a work screen.
  • Wallboard: the /wall view for a wall-mounted TV, the read-only display key, kiosk setup, and screen size versus viewing distance.
  • Design Language: the shared visual rules for every screen: flat panels, blue for normal, red for problems, contrast targets.
  • Lab View: the wall-board mode of the original card dashboard, which is still available at /classic.

Operations

  • Changelog: what changed in each release, with upgrade notes and a test checklist.
  • Container Registry: image tags, publishing, test releases, and deployment notes.
  • Documentation Screenshots: screenshot checklist, redaction rules, and how the generated screenshots are made.
  • Roadmap: selected future-feature work and the current iteration rule.
  • Security Hardening: login protection, reverse-proxy settings, origin checks, the display key, and settings backup guidance.

The dashboard stores shared status changes, Uptime Kuma samples, and integration diagnostic samples in SQLite so operational history follows the deployment instead of a single browser. Admins can tune retention, export full or filtered history, clear server-side history from Dashboard Recovery, and adjust diagnostic response thresholds from Integration Health. Persisted diagnostic samples also drive warnings for slow or unstable integrations.

Keep secrets out of the wiki. Store tokens only in the dashboard admin settings.