Speedarr documentation
Speedarr is an internet speed monitoring dashboard and tooling. It runs speed tests on a schedule, stores results in SQLite, and can run as a full dashboard (complete mode) or as an API-only node (node mode) for remote dashboards.
Documentation index
Section titled “Documentation index”| Doc | Description |
|---|---|
| Deployment | Docker (GHCR, example compose files, single container, main + nodes), env, volumes |
| Configuration | config.json, Settings, Gluetun, nodes, schedules, first-run |
| Development | Local run, dev vs node mode, tests, Ookla CLI |
| API | Authentication, endpoints, API key usage |
Quick start (Docker)
Section titled “Quick start (Docker)”Using the pre-built image from GitHub Container Registry:
docker pull ghcr.io/whats-a-mattr/speedarr:latestdocker run -d -p 3000:3000 -v speedarr-config:/config -e SPEEDARR_PASSWORD=your-password ghcr.io/whats-a-mattr/speedarr:latestOr use an example compose file: docker compose -f examples/complete.yml up -d.
Open http://localhost:3000 and sign in (or complete first-run if no password was set).
For a main dashboard plus three test nodes, see Deployment → Main + nodes.