Documentation
The same docs whether we run uptimepage for you or you run it yourself. Pages marked self-hosting or hosted only matter for one of the two.
start here
What the service is and how the pieces fit together.
using uptimepage
Day-to-day work: monitors, incidents, status pages, alerts.
- Web UI A tour of the app: dashboard, monitors, incidents, settings, and sharing a monitor.
- Incident management Acknowledgement, ownership, on-call, escalation, and the retrospective around a failing check.
- Monitor types The eight check kinds, what each one actually proves, and which to reach for.
- Notifications Alert channels, how a monitor binds them, and what decides when an alert fires.
- Public status page The customer-facing surface: components, incidents, maintenance, badges, JSON and RSS.
- Per-org status pages Running one or more branded status pages per organization, each on its own subdomain.
- Share links Read-only capability URLs that open one monitor's full dashboard without an account.
- Team Roles, inviting people, seats, and what a member can do that an owner cannot.
- Variables and secrets Reusable org-scoped values and write-only secrets referenced from monitor request fields.
reference
The API, Terraform, MCP, and the limits everything runs under.
- Authentication OAuth sign-in, magic links, API tokens, and the scopes that bound them.
- REST API The /api/v1 surface: monitors, incidents, channels, status pages, and the public endpoints.
- Terraform Managing monitors, channels, and status pages as code with the official provider.
- MCP server Letting an LLM client answer operational questions and take guarded actions on one org.
- Quotas and rate limits How plans bound resources and request budgets, and how each limit is enforced.
- Multi-tenancy The org model, how the active org is resolved, and how tenant isolation is enforced.
hosted service
What differs when we run it for you at uptimepage.dev.
- Plans and limits hosted The quotas and rate budgets each hosted plan carries, and what happens at the ceiling.
- Probe regions hosted Where the hosted service checks from, and how to pick regions for a monitor.
- Data retention hosted How long raw checks, rollups, incidents, and audit records are kept on the hosted service.
- Support hosted How to reach us, what to include, and where the hosted service stands on SLAs.
self-hosting
Running your own instance: deploy, configure, operate, debug.
- Configuration self-hosting Every configuration key, its default, and the environment variable that overrides it.
- Deployment self-hosting Running the production stack: Caddy, TLS, the public status surface, and email.
- Multi-region probes self-hosting Running probe agents in more than one region, and the operator surface that manages them.
- Metrics and tracing self-hosting The Prometheus series the service exposes and how to ship traces off the box.
- Troubleshooting self-hosting Symptoms you are likely to hit while operating an instance, and what they mean.
- Development self-hosting Local setup for working on the service itself: toolchain, workflows, and the test gates.
- Benchmarks self-hosting Criterion micro-benchmarks measuring the cost of a single check through the production path.
- Load test self-hosting The end-to-end harness that drives the real check executor against in-process mock servers.