Read-only homelab metrics dashboard.
List machines in a YAML file. Dash connects over SSH (or local Docker), shows Proxmox guests and containers, and can pull stats from known apps using drop-in YAML definitions. The web UI builds itself from your layout config and stays view-only.
On the LXC only keep:
~/dash/
compose.yaml
Caddyfile
.env
config/
No source tree, no binary, no local build. Images are pulled:
ghcr.io/<owner>/dash— app (built by GitHub Actions)caddybuilds/caddy-cloudflare— Caddy with Cloudflare DNS plugin for TLS
mkdir -p ~/dash/config
cd ~/dash
# copy compose.yaml, Caddyfile, .env.example→.env from the repo
nano .env # set CLOUDFLARE_API_TOKEN, GITHUB_OWNER, CADDY_EMAIL
# if the GHCR package is private:
echo "$GHCR_TOKEN" | docker login ghcr.io -u USERNAME --password-stdin
docker compose pull
docker compose up -d- Config:
~/dash/config→/configin the container (first start writesapp.yamlif missing) - UI:
https://dash.dns.puvvadi.net - TLS: Let’s Encrypt via Cloudflare DNS challenge (
CLOUDFLARE_API_TOKENneeds Zone → DNS → Edit)
Push to main (or run Build and push manually) runs .github/workflows/publish.yml:
- Builds the multi-stage
Dockerfile(Vite UI + Go binary inside Docker — nothing to pre-build on your laptop) - Pushes to
ghcr.io/<github.repository>:latest(and version tags onv*)
On the server after CI finishes:
cd ~/dash && docker compose pull && docker compose up -dDo not commit web/dist or internal/embedui/dist/assets. Only a tiny stub internal/embedui/dist/index.html exists so local go build / tests compile; the real UI is copied in during the Docker build.
- Settings guide — plain English
- Add an app
- Contributing
- UI target: docs/design/figma-homelab-overview.png
dash serve -config /config
dash init -config /config
dash validate -config /config
dash apps -config /config
dash discover --host 10.20.20.1- Go hub (SSH collector, SQLite history, WebSocket)
- Vite React UI (embedded in the image)
- Caddy + Cloudflare DNS for TLS
- GitHub Container Registry for the app image