Quick start
The one-command run, explained — and where to go next.
Uptimer is a self-hosted uptime & synthetic monitor: it checks your HTTP(S) endpoints on a schedule and alerts you when they break. The same engine runs hosted at myuptime.info — and you can export your data as YAML and import it into your own instance (or the other way round) at any time, so neither choice locks you in.
Below is the one-command run, explained.
Run it
docker run -p 2517:2517 ghcr.io/myuptime-info/uptimer:1.3.0
2517serves the web UI and the REST API (the API lives under/api).- The default command is
dev: every service in one process, an in-memory database that resets on restart, and fake auth — any visitor is an admin.
Open http://127.0.0.1:2517, create a rule, and point it at a URL. Uptimer starts checking it.
Talk to the API
The dashboard is just a REST client. Every request carries a Bearer token — create one in
the dashboard (Settings → API Keys) and send it in the Authorization header:
curl -H "Authorization: Bearer $UPTIMER_TOKEN" http://127.0.0.1:2517/api/version
{ "result": "1.3.0", "error": null, "meta": null }
Every response is HTTP 200 with a {result, error, meta} envelope — check error, not the
status code. Full details in the REST API reference.
Next
Dev mode is for trying, not for running. When you’re ready:
- Core concepts — what you’re actually configuring.
- Self-hosting — grow this into a real deployment.