Install¶
Requirements¶
- Docker + docker compose (any modern version).
- For the GPU panels: an NVIDIA GPU and the NVIDIA Container Toolkit.
- No GPU? That's fine — the container, service and host panels still work. Skip the toolkit; the dashboard auto-hides the GPU sections.
Option A — pre-built image (recommended)¶
No clone, no build:
curl -fsSLO https://raw.githubusercontent.com/SikamikanikoBG/homelab-monitor/main/docker-compose.yml
docker compose pull
docker compose up -d
Multi-arch images (linux/amd64, linux/arm64) are published on every release
to sikamikaniko123/homelab-monitor.
Open http://<your-host-ip>:9800 from any device on your LAN or VPN.
Upgrade later
Your SQLite history at./data/gpu.db survives — it's a bind mount.
Option B — from source¶
Handy if you're tweaking the code or contributing:
git clone https://github.com/SikamikanikoBG/homelab-monitor.git
cd homelab-monitor
docker compose up -d --build
Same URL: http://<your-host-ip>:9800.
Verify¶
Uninstall¶
Running on Windows (WSL2 — no Docker Desktop required)¶
The dashboard is a Linux container, but it runs happily on Windows 10/11 through WSL2 — and you don't need the heavyweight Docker Desktop. Install the Docker Engine straight into a WSL distro instead:
# Then, inside your WSL (Ubuntu) shell — install Docker Engine + Compose:
curl -fsSL https://get.docker.com | sh
# Enable systemd so dockerd runs as a service (one-time):
printf '[boot]\nsystemd=true\n' | sudo tee /etc/wsl.conf # then: wsl --shutdown, reopen
curl -fsSLO https://raw.githubusercontent.com/SikamikanikoBG/homelab-monitor/main/docker-compose.yml
docker compose up -d
WSL2 forwards the port to Windows automatically, so the dashboard is reachable at
http://localhost:9800 in your Windows browser. To keep Docker data off your C:
drive, give the distro its own home on another drive with wsl --export / wsl --import.
Want to monitor a Windows box (not run the hub on it)?
You don't need any of the above — just enable OpenSSH Server on the Windows machine and add it on the Hosts tab. See Multi-machine → Windows hosts.
Next steps¶
- Add your other boxes to the cockpit → Multi-machine guide
- Tune sample interval, retention, alert thresholds → Configuration
- See every panel → Features tour