Circuit Breaker is a self-hosted homelab visualization platform that maps your infrastructure—hardware, services, networks, and clusters—with interactive topology, live telemetry, and auto-discovery.
⚠️ Beta Security Notice Not fully audited. Run on trusted LAN only. Do not expose publicly until v1.0.
📖 User Guide | 🗣️ Discord | 🐦 X/Twitter
- Auto-Discovery: Scan LAN with nmap/SNMP/ARP. Auto-populate Proxmox VMs, TrueNAS pools, UniFi APs. Review & merge into topology.
- Live Telemetry: iDRAC/iLO/APC UPS/SNMP health badges update via WebSockets. Green/yellow/red health rings.
- Proxmox Integration: One-click cluster import — nodes, VMs, and health metrics visualized instantly.
- Interactive Topology: Hierarchical/cluster/radial layouts with live animations. Drag-to-save positions.
- 3D Rack Simulator: U-height drag-drop, cable management, front/rear views, power modeling.
- Vendor Catalog: 100+ devices (Dell/HPE/Ubiquiti/Synology/APC). Freeform entry always works.
- Audit Logs: Tamper-evident SHA-256 hash chain. Every change tracked with actor, IP, and diff.
- Authentication: bcrypt passwords, TOTP MFA, OAuth/OIDC (GitHub, Google, Authentik, Keycloak), HttpOnly session cookies
- RBAC: 4 built-in roles (viewer/editor/admin/demo), granular scopes, admin masquerade with full audit trail
- Secrets Vault: Fernet encryption at rest for all credentials; auto-generated key, never stored in plaintext
- Transport: Automatic HTTPS via Caddy — Let's Encrypt for public domains, local self-signed CA for LAN
- HTTP Hardening: CSP, HSTS, X-Frame-Options, rate limiting, SSRF guard, and tamper-evident audit log
See Security & Deployment for full details.
curl -fsSL https://raw.githubusercontent.com/BlkLeg/CircuitBreaker/main/install.sh | bashInstalls natively via systemd — no Docker required. Opens the OOBE setup wizard at http://<host>:8088 on completion.
Upgrade: cb update | Uninstall: cb uninstall
curl -fsSL https://raw.githubusercontent.com/BlkLeg/CircuitBreaker/main/cb-proxmox.sh | bashRuns on your PVE host: creates a Debian 12 LXC container, installs Circuit Breaker natively, and auto-configures Proxmox API integration. Asks 3 questions, done in ~3 minutes.
curl -fsSL https://raw.githubusercontent.com/BlkLeg/CircuitBreaker/main/install.sh | bash -s -- --dockerFull stack with Caddy, NATS, and discovery workers. See docs/installation/docker-compose.md for env vars, persistence, ARP scan, and socket config.
cb is installed automatically alongside Circuit Breaker.
| Command | Description |
|---|---|
cb status |
Show service status |
cb logs [-f] |
Show logs (add -f to follow) |
cb restart |
Restart Circuit Breaker |
cb update |
Pull latest release and restart |
cb vault-recover |
Recover an uninitialized vault (edge cases only) |
cb version |
Show installed version |
cb uninstall |
Remove Circuit Breaker from this system |
Join Discord for support and showcases. Follow @TryHostingCB on X/Twitter.
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}