Files
homelab-monitor/README.md
T
jhodgkin a075488f4b
CI / web (push) Failing after 1m11s
CI / api (push) Successful in 1m19s
Scaffold homelab-monitor: Fastify API + React dashboard + CI
Vertical slice for Phase 1 (v1-dashboard milestone): Proxmox collector,
SQLite storage, local auth, and a dashboard UI showing host/container
status cards. Config-driven collector registry so future data sources
(SSH-based hosts, Zabbix, network discovery) plug in without rewiring.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-07-12 20:18:44 -06:00

34 lines
1013 B
Markdown

# Homelab Monitor
A single dashboard for the health of everything in the homelab (documented in
[`jhodgkin/homelab`](https://git.jerodrigged.com/jhodgkin/homelab)): Proxmox host + LXC
CPU/mem/disk/pressure, and — as the backlog fills in — SSH-monitored bare-metal boxes, a LAN
device inventory, and Zabbix alerts. One login instead of N.
Project status, architecture, and how to resume work: see [`CLAUDE.md`](./CLAUDE.md).
Roadmap: [Gitea issues](https://git.jerodrigged.com/jhodgkin/homelab-monitor/issues), milestone `v1-dashboard`.
## Local development
```bash
# 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):
```bash
ssh homelab-monitor
cd /opt/homelab-monitor
git pull
docker compose up -d --build
```