homelab-monitor/README.md

Homelab Monitor

A single dashboard for the health of everything in the homelab (documented in jhodgkin/homelab): Proxmox host + LXC + bare-metal CPU/mem/disk/pressure, historical sparklines, and a LAN device inventory. Local auth always available, plus an optional "Sign in with Authentik" OIDC button. Live at https://monitor.jerodrigged.com.

Project status, architecture, and how to resume work: see CLAUDE.md. Playwright e2e tests against the live deployment: see e2e/README.md.

Local development

# terminal 1
cd apps/api && npm install && cp ../../.env.example ../../.env  # fill in .env first
npm run dev

# terminal 2
cd apps/web && npm install && npm run dev

Web dev server proxies /api to localhost:3000 (see apps/web/vite.config.ts).

Production deploy

Runs as Docker Compose on CT122 (homelab-monitor, 192.168.1.103):

ssh homelab-monitor
cd /opt/homelab-monitor
git pull
docker compose up -d --build