← StatusReport

Documentation

Setup notes for the hosted service and self-hosted installs.

Custom domains

Open a status page, go to Custom domain, and enter a hostname such as status.example.com. Then add a CNAME record at your DNS provider:

Record type
CNAME
Host
status.example.com
Target
statuspage.statusreport.roleflow.site

We check DNS automatically and provision an SSL certificate once it resolves. Apex domains work through CNAME flattening (Cloudflare) or A records that match the target.

REST API

Create a scoped key under Team & audit logs, then send it as a bearer token. The full specification is at /api/v1/openapi.json.

curl -H "Authorization: Bearer sr_live_…" http://localhost:3000/api/v1/monitors

Heartbeats (cron jobs)

Append a request to the end of your job. Use a failure flag to report errors explicitly.

0 3 * * * /usr/local/bin/backup.sh && curl -fsS --retry 3 http://localhost:3000/api/v1/heartbeat/<token>

Self-hosting

Copy .env.example to .env, set AUTH_SECRET, then run docker compose up -d. The default uses SQLite; set DATABASE_URL to a PostgreSQL URL for multi-tenant SaaS.

Set SAAS_MODE=false to keep registration closed after the first account.