Documentation
Documentation
Everything you need
to run it.
These pages are copies of the documentation in the product repository, so they never disagree with what shipped. Anything not reproduced here is linked at the bottom.
Getting started
Installing Uptime Cairn
Four ways in — Docker, Compose, a plain binary, and a Raspberry Pi — all producing one process, one database file, and a dashboard on port 3000.
Read itYour first monitor
Sixty seconds from a running install to a monitor checking something, an alert channel that really fires, and a status page your customers can read.
Read itMigrating from Uptime Kuma
What `cairn import kuma` brings across from a kuma.db, how to merge several Kuma instances into one install, and exactly what it cannot bring.
Read itReporting
Reporting
Scheduled, branded reports over your monitoring history — what a template is, how a schedule fires, where the files live, and what arrives in a client's inbox.
Read itBrand profiles
White-labelling for reports: a logo, two colours, a client name, and the two lines of text that appear on the cover and in the footer.
Read itSLA methodology
The page to read when a figure is disputed: exactly what counts as downtime, what leaves the denominator, and which of those choices a report prints on its own face.
Read itReference
Monitor types
The nine types — http, tcp, icmp, dns, tls_expiry, domain_expiry, push, docker and grpc — what each one actually checks, and the fields where the obvious reading is wrong.
Read itAlerting
Sixteen channel types, what each one needs, webhook templating, and the two rules that apply to every channel before you configure any of them.
Read itAPI conventions
Authentication, scopes, cursor pagination, error documents, and the compatibility promise — plus where to get the OpenAPI spec and the full 140-operation reference.
Read itIn the repository
Deliberately not mirrored here — these change with the code and are better read beside it.
- OperationsBackups, upgrades, reverse proxies, and what to alert on.
- Why this existsThe design principles and the architecture behind them.
- RoadmapTeams, multi-tenancy, and scale — what is next and in what order.
- Architecture decisionsTen ADRs: the probe split, storage, tenancy, UI state, and how reports are rendered and stored.
- Security policyHow security is handled, and how to report a problem privately.
- ContributingWhat is most useful right now, and how the project is governed.