{"id":47613974,"url":"https://github.com/Pouzor/homelable","last_synced_at":"2026-04-06T11:00:52.803Z","repository":{"id":343204645,"uuid":"1174815292","full_name":"Pouzor/homelable","owner":"Pouzor","description":"Self-hosted homelab infrastructure visualizer — interactive network diagram with live status monitoring","archived":false,"fork":false,"pushed_at":"2026-04-04T21:32:36.000Z","size":3049,"stargazers_count":967,"open_issues_count":8,"forks_count":32,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-04-04T23:34:56.876Z","etag":null,"topics":["diagram","network","proxmox-ve","self-hosted"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Pouzor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-06T21:49:54.000Z","updated_at":"2026-04-04T21:31:49.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/Pouzor/homelable","commit_stats":null,"previous_names":["pouzor/homelable"],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/Pouzor/homelable","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pouzor%2Fhomelable","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pouzor%2Fhomelable/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pouzor%2Fhomelable/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pouzor%2Fhomelable/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Pouzor","download_url":"https://codeload.github.com/Pouzor/homelable/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pouzor%2Fhomelable/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31469743,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-06T08:36:52.050Z","status":"ssl_error","status_checked_at":"2026-04-06T08:36:51.267Z","response_time":112,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["diagram","network","proxmox-ve","self-hosted"],"created_at":"2026-04-01T21:00:30.897Z","updated_at":"2026-04-06T11:00:52.798Z","avatar_url":"https://github.com/Pouzor.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Homelable\n\nHomelable is a self-hosted infrastructure visualization solution. It provides a network scanning feature to accelerate the identification of machines and services deployed on your local infrastructure.\n\nHomelable also offers a healthcheck system (WIP) through multiple methods (ping/TCP, /health API, etc.) to get a global overview of online/offline services.\n\nYou can also select some pre-built design styles, or personalize each device in your diagram.\n\nIf you just like the design, you can only run the frontend and export your design as PNG.\n\n\n---\n\n## Screenshots\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"docs/homelable1.png\" alt=\"Homelable canvas overview\" width=\"100%\" /\u003e\n  \u003cimg src=\"docs/homelable2.png\" alt=\"Homelable node detail\" width=\"100%\" /\u003e\n  \u003cimg src=\"docs/homelable3.png\" alt=\"Homelable sidebar and scan\" width=\"48%\" /\u003e\n  \u003cimg src=\"docs/homelable4.png\" alt=\"Homelable edit pannel\" width=\"48%\" /\u003e\n\u003c/p\u003e\n\n---\n\n## Installation\n\nDocker, Proxmox LXC, build from source, configuration, and development setup are all covered in **[INSTALLATION.md](./INSTALLATION.md)**.\n\n---\n\n## Network Scanner\n\nThe scanner runs `nmap -sV --open` on your configured CIDR ranges and populates a **Pending Devices** queue. From the sidebar you can then approve (adds a node to the canvas), hide, or ignore each discovered device.\n\n### Triggering a scan\n\nTo save you time when mapping your infrastructure, Homlable can scan your network and report all the services it detects. It can also identify them, saving you even more time.\nClick **Scan Network** in the sidebar. The Scan History tab opens automatically and refreshes every 3 seconds until the scan completes.\n\n### macOS / root privileges\n\nSome nmap scan types (SYN scan, OS detection) require root. If the scan fails with a permissions error, run it manually with sudo using the included script:\n\n```bash\ncd backend\nsudo python ../scripts/run_scan.py 192.168.1.0/24\n\n# Multiple ranges:\nsudo python ../scripts/run_scan.py 192.168.1.0/24 10.0.0.0/24\n```\n\nResults are written directly to the database and appear as Pending Devices in the UI without restarting the backend.\n\n\u003e On Linux the backend process itself can be given the `NET_RAW` capability instead of running as root:\n\u003e ```bash\n\u003e sudo setcap cap_net_raw+ep $(which nmap)\n\u003e ```\n\n---\n\n## Node Check Methods\n\nHomelable continuously monitors your nodes and displays their live status (online / offline / unknown) directly on the canvas. Each node can be configured with an independent check method suited to the service it runs.\n\n| Method | Description |\n|--------|-------------|\n| `ping` | ICMP ping |\n| `http` | GET request, success if status \u003c 500 |\n| `https` | GET with TLS verify |\n| `tcp` | TCP connect (target: `host:port`) |\n| `ssh` | TCP connect to port 22 |\n| `prometheus` | GET `/metrics` |\n| `health` | GET `/health` |\n\n---\n\n## Live View (read-only public canvas)\n\nLive View lets you share a read-only snapshot of your canvas with anyone on your network — no login required. It is disabled by default.\n\n### Activation\n\nAdd LIVEVIEW_KEY to your .env:\n\n`LIVEVIEW_KEY=your-secret-key`\n\n\nThen restart the backend:\n\n`docker compose restart backend`\n\n### Usage\n\nUse this URL to view your canvas:\n\nhttp://\u003cyour-homelab-ip\u003e/view?key=your-secret-key\n\nThe page shows your canvas in pan/zoom-only mode — no editing, no credentials needed. Clicking a node that has an IP opens it in a new tab.\n\n---\n\n## MCP Server (AI Integration) (optionnal)\n\nHomelable can exposes a [Model Context Protocol](https://modelcontextprotocol.io) server so any MCP-compatible AI client (Claude Code, Claude Desktop, Open WebUI…) can read your homelab topology and act on it.\n\n### What the AI can do\n\n| | Action |\n|---|---|\n| **Read** | List all nodes, edges, full canvas, pending devices, scan history |\n| **Write** | Add / update / delete nodes and edges, trigger a network scan, approve or hide discovered devices |\n\n### Setup\n\n**1. Add the keys to your `.env`:**\n\n```env\n# Authenticates AI clients (Claude Code, etc.) → MCP server\nMCP_API_KEY=mcp_sk_changeme\n\n# Authenticates MCP server → backend (internal Docker network only, never exposed)\nMCP_SERVICE_KEY=svc_changeme\n\n# Generate both with:\n# python3 -c \"import secrets; print(secrets.token_hex(32))\"\n```\n\nNo plain-text passwords involved — `AUTH_PASSWORD_HASH` is only used for the web UI login.\n\n**2. Start the MCP service:**\n\n```bash\ndocker compose up -d mcp\n# MCP server is now listening on http://\u003cyour-homelab-ip\u003e:8001\n```\n\n**3. Configure your AI client:**\n\n**Claude Code** — run this command in your terminal:\n```bash\nclaude mcp add --transport sse homelable http://\u003cyour-homelab-ip\u003e:8001/mcp \\\n  --header \"X-API-Key: mcp_sk_yourkey\"\n```\n\nOr add it manually to `~/.claude.json`:\n```json\n{\n  \"mcpServers\": {\n    \"homelable\": {\n      \"type\": \"sse\",\n      \"url\": \"http://\u003cyour-homelab-ip\u003e:8001/mcp\",\n      \"headers\": {\n        \"X-API-Key\": \"mcp_sk_yourkey\"\n      }\n    }\n  }\n}\n```\n\n**Claude Desktop** — edit `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\\Claude\\claude_desktop_config.json` (Windows):\n```json\n{\n  \"mcpServers\": {\n    \"homelable\": {\n      \"type\": \"sse\",\n      \"url\": \"http://\u003cyour-homelab-ip\u003e:8001/mcp\",\n      \"headers\": {\n        \"X-API-Key\": \"mcp_sk_yourkey\"\n      }\n    }\n  }\n}\n```\n\n### Example prompts\n\n- *\"What nodes are currently offline?\"*\n- *\"Add a new LXC container named `pihole` at 192.168.1.5, connected to my switch.\"*\n- *\"Trigger a network scan on 192.168.1.0/24 and show me the pending devices.\"*\n- *\"Show me the full canvas topology.\"*\n\n### Security\n\n- The MCP server is **not** intended to be exposed to the internet — keep port 8001 firewalled to your LAN.\n- Rotate the key any time by updating `MCP_API_KEY` in `.env` and restarting: `docker compose restart mcp`.\n- The MCP server communicates with the backend over the internal Docker network — the backend API is never directly exposed to MCP clients.\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPouzor%2Fhomelable","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FPouzor%2Fhomelable","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPouzor%2Fhomelable/lists"}