Homelable
Homelable is a self-hosted homelab infrastructure visualizer that scans networks, auto-generates device documentation, imports Proxmox, Zigbee, and Z-Wave data, and shows live service status on an interactive diagram.
Visit Pouzor/homelableOverview
Homelable is a self-hosted infrastructure visualization and documentation solution for homelabs. It scans local networks and Zigbee/Z-Wave devices, builds device documents from scan results, and adds live healthchecks so the diagram reflects what is actually running. A markdown Library stores runbooks, incidents, and network notes alongside the visual map.
Key Features
- Network scanning with nmap populates a Pending Devices queue that can be approved, hidden, or ignored.
- Automatically generated per-device documents plus a markdown Library for runbooks, incidents, and network overview pages.
- Live node healthchecks using ping, HTTP/HTTPS, TCP, SSH, Prometheus, and /health methods.
- Imports from Proxmox VE, Zigbee2MQTT, and Z-Wave JS UI via MQTT or REST API sources.
- Rack canvases with U-height, faceplates, port-to-port patching, floor plans, and per-device design customization.
- Read-only Live View and Documentation View, a documented REST API, and an optional MCP server for AI clients.
Use Cases
- Keep homelab documentation synchronized with the devices and services actually present on the network.
- Map network topology and see online/offline status directly on an interactive canvas.
- Import existing Proxmox VE virtualization inventory or Zigbee/Z-Wave device topology instead of re-entering devices manually.
- Share a read-only canvas or documentation space on the LAN, or connect scripts and AI assistants through the REST API and MCP server.
Getting Started
- Download the latest release or use the pre-built GHCR Docker images.
- Follow the installation documentation for Docker, Proxmox LXC, bare-metal systemd/nginx, or build-from-source setup.
- Run a network scan, then approve discovered devices to add them to the canvas.
- Optionally import from Proxmox VE, Zigbee2MQTT, or Z-Wave JS UI, configure healthchecks, and add Library pages.
Deployment & Requirements
- Docker deployment uses pre-built GHCR images; Proxmox LXC and bare-metal Debian/Ubuntu installs with systemd and nginx are also documented.
- Zigbee2MQTT and Z-Wave JS UI imports require a reachable MQTT broker, such as Mosquitto.
- Proxmox VE import requires a reachable Proxmox host and an API token with the read-only PVEAuditor role.
- The gethomepage widget requires backend port 8000 to be reachable from the gethomepage container.
- Network scans may require root or NET_RAW capabilities for certain nmap scan types.
Before You Adopt
- License: MIT. Review its terms before using, modifying, or distributing the project.
- The project is described as young and still evolving, so users should expect rough edges.