Meerkat docs
Everything here is generated from the Markdown files in the repository, so it always matches the code.
Getting started
Install Meerkat with Docker, configure monitors and Telegram, and use the API.
Architecture
How Meerkat works today and the outage-resilient architecture it is moving towards.
Roadmap
Known issues, the resilience plan, the contributor backlog and the release timeline.
Design system
Meerkat's UX principles, invariants, Savanna tokens and component rules.
Feature comparison
How Meerkat compares with Uptime Kuma, Beszel, Gatus, Netdata and healthchecks.io.
UX comparison
How Meerkat's user experience compares with other homelab monitoring tools.
Contributing
Set up a development environment and send your first pull request.
Rules for AI agents
What automated coding agents must and must not change in Meerkat.
Security
How to report vulnerabilities and harden your Meerkat install.