Bring your homelab to life. A self-hosted IPAM and service mapper that visualizes complex hardware, compute, and network relationships in real-time.
Bring your homelab to life. A self-hosted IPAM and service mapper that visualizes complex hardware, compute, and network relationships in real-time.
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.
⚠️ Release Candidate Security Notice 0.4.0. Not fully audited; several 1.0 security acceptance rows are still unevidenced. Run on a trusted LAN or behind a VPN — internet-exposed direct deployment is outside the 1.0.0 support boundary, which is tracked in docs/release/1.0.0-support-contract.md.
User Guide | ️ Discord | X/Twitter
cb-agent (Linux) on a remote site or a separate VLAN for host telemetry, monitor probes, and discovery from inside a network the server cannot reach. Outbound-only, Noise-encrypted, no inbound firewall rule.See Security & Deployment for full details.
curl -fsSL https://raw.githubusercontent.com/BlkLeg/CircuitBreaker/main/install.sh | sudo bashInstalls natively via systemd — no Docker required. On completion it prints the OOBE setup wizard URL: https:///, using a self-signed certificate by default (accept the browser warning). The plain HTTP port (8088) stays reachable but cannot create the first account.
Upgrade: cb update | Uninstall: cb uninstall
bash -c "$(curl -fsSL https://raw.githubusercontent.com/BlkLeg/CircuitBreaker/main/cb-proxmox-deploy.sh)"Runs on your PVE host: creates a Debian 12 LXC container, installs Circuit Breaker natively, and auto-configures Proxmox API integration. Interactive TUI guides you through setup, done in ~3 minutes.
curl -fsSL https://raw.githubusercontent.com/BlkLeg/CircuitBreaker/main/install.sh | bash -s -- --dockerDocker mode now performs a compose-only deployment: installs Docker only if missing, downloads official compose templates into ~/.circuitbreaker, generates .env defaults, and runs docker compose up -d. See docs/installation/docker-compose.md for env vars, persistence, ARP scan, and socket config.
cb is installed automatically by the native and Proxmox installers. Docker Compose deployments use
docker compose directly from ~/.circuitbreaker instead.
| Command | Description |
|---|---|
cb status |
Show status of all Circuit Breaker services |
cb doctor |
Run health checks and diagnose issues |
cb logs |
Tail all service logs (live) |
cb restart |
Restart all services |
cb update |
Update to the latest version |
cb backup |
Back up the database |
cb version |
Show installed version |
cb uninstall |
Remove Circuit Breaker from this system |
Join Discord for support and showcases. Follow @TryHostingCB on X/Twitter.
No open issues yet, or sync has not completed.