Skip to content

Self-hosted monitoring for homelabs: host and container metrics and uptime checks from all your machines in one dashboard, with an optional AI agent that diagnoses incidents and suggests fixes.

2.7 KB
Raw Blame

Documentation

The README is the short version: what the project is, how to start it. Everything else lives here.

Using the dashboard

Page What is in it
The dashboard and system health Fleet cards, storage bars, the Network and System rows, active incidents, the optional system helper.
Statistics History from the last hour to all time: servers, containers and the whole fleet.
Metrics: what every number means CPU %, load, memory, swap, disk, inodes, network, container and system figures: how each is measured and its limits.
Alerts and incidents Every rule, its default thresholds, and how incidents open and resolve.
Accounts, roles and two-factor sign-in Passwords, roles, the Account page, authenticator codes, recovery codes, locked-out accounts.
Incident agent The optional agent: diagnoses, watching the fix, notifications, chat, who sees what, and what it costs.
How the agent investigates The agent's look-ups end to end: what the model sees, who writes each part of what you see, the budget, what is checked and stored, and the limits.

Installing and running

Page What is in it
The containers and why each one exists Every container in the stack: what it does, how it works, why it is separate, and what happens when it stops.
Deploying on a server The server stack behind your reverse proxy (ready-made for Traefik), the VPN collector gate, publishing the collector images, updating, other proxies.
Deploy Infradeck behind Traefik Step by step on a server that already runs Traefik: .env, first start, admin account, verifying, upgrading and rolling back, common errors.
Adding servers Connect a server, what its command does, how registration and approval work, networking.
Configuration Every .env setting for the stack, the collector and the frontend build.
Troubleshooting Symptoms and what to check.

For developers

Page What is in it
Development Running the backend and frontend without Docker, tests, project layout.
Database schema Tables, summarised history, indexes and migrations.
API overview Every endpoint, who may call it, and what it returns.
../TESTS.md How the tests work, what they don't cover, and what each one checks.
../SECURITY.md What every component can touch, and the limits of each protection.