A speed test tracker for your homelab. Measures on a schedule, shows every test live on a gauge, keeps the history and tells you when your line is slower than what you pay for.
Status: early. A small side project, part of the nex apps (Nexview and friends).
The screenshots show a throwaway instance with made-up data.
- Live view with a gauge: ping, download and upload as they happen, whether you started the test or a schedule did.
- Four sources: Cloudflare (works right away), LibreSpeed (public servers or your own), iperf3 against a server of your own, and, if you activate it yourself, Ookla. See below.
- Everything measurable: download, upload, ping, jitter, lowest and highest ping, latency under load (bufferbloat), and packet loss where the source measures it.
- Schedules: every n minutes, once a day, a cron expression, or n times a day at random times: the day is split into n equal parts with one test at a random minute in each, drawn anew every day, so over a few weeks every hour is covered and busy times show up. All of them can be limited to weekdays and a time window. Tests never overlap.
- History with charts, averages and a CSV export.
- Your plan: enter what your provider promises, and nexpulse marks tests below a threshold of it.
- Alerts via ntfy, Gotify or a webhook: slow test, high ping, failed test.
- API for dashboards like nexdeck or Home Assistant, with keys that can only read or also start tests.
- No accounts. Optionally one password for the interface. The API always needs a key.
- German, English and Chinese (Simplified and Traditional), dark and light.
| Source | Server choice | Packet loss | Notes |
|---|---|---|---|
| Cloudflare | automatic (nearest data center) | no | The same endpoints as speed.cloudflare.com. Cloudflare refuses tests that come too often; one an hour is plenty. |
| LibreSpeed | automatic, a public server or your own | no | Automatic pings all servers, tries the nearest ones briefly and takes the fastest. |
| Ookla | automatic or any nearby server | yes | Not included. See below. |
| iperf3 | your own servers only | no | For a VPS or a second site: what the line between you and that machine really does. Directions, connections and IP version per server. See below. |
iperf3 measures against a machine you run yourself, so there is no server list:
start iperf3 -s on the target, then add its address under Settings > Sources.
By default nexpulse measures one direction after the other, which takes about
twenty seconds, and reports download, upload, ping and latency under load.
Packet loss stays empty; over TCP there is none to report.
Every server carries its own settings, and you can change them later: which directions to measure (both, download only, upload only), how many parallel connections (1 to 32), and whether to force IPv4 or IPv6.
An iperf3 server lets anyone who knows its address and port run a test against it, and use up its bandwidth. Open the port to your own network only, or to the address nexpulse comes from.
The container ships iperf3 (BSD licensed, by ESnet). If you run nexpulse some
other way, install the iperf3 package; without it the source stays off.
nexpulse does not ship any Ookla software. If you activate Ookla in the settings, nexpulse downloads the official Speedtest CLI from Ookla into your data folder.
Ookla's license does not cover this use. It allows the CLI only for personal, non-commercial use on a single personal computer, and forbids running it on a device that other devices can reach over the network, or on routers, modems or other devices that are not personal computers. A container in a homelab falls under that. nexpulse says so before you activate it; if you do, it is your decision and your risk.
services:
nexpulse:
image: ghcr.io/derkezorm/nexpulse:latest
container_name: nexpulse
restart: unless-stopped
ports:
- "8440:8000"
volumes:
- ./data:/data
environment:
PUID: 1000
PGID: 1000
TZ: Europe/BerlinThen open http://<your-host>:8440. The full example with every option is in
docker-compose.yml.
Forgot the password? This turns it off:
docker exec nexpulse python -m app.cli remove-passwordCreate a key under Settings > Access and API, then send it as X-Api-Key
or as Authorization: Bearer.
| Method | Path | Access |
|---|---|---|
| GET | /api/v1/me |
read (any key: name, access, whether it may start tests) |
| GET | /api/v1/status |
read |
| GET | /api/v1/latest |
read |
| GET | /api/v1/results?from=…&to=…&source=… |
read |
| GET | /api/v1/stats?range=24h|7d|30d|90d|all |
read |
| POST | /api/v1/tests with {"source": "cloudflare"} (or librespeed, ookla, iperf3) |
run |
| GET | /api/v1/tests/{id} |
read |
The full reference is at /api/docs on your instance.
| Part | Command |
|---|---|
| Backend | cd backend && python -m venv .venv && .venv/Scripts/pip install -r requirements-dev.txt, then python -m uvicorn app.main:app --port 8440 |
| Frontend | npm --prefix frontend install, then npm --prefix frontend run dev (port 5440, proxies /api to 8440) |
| Checks | python -m ruff check app tests, python -m pytest -q in backend; npm run lint, npm test, npm run build in frontend |
GNU AGPL v3.0. Cloudflare, LibreSpeed, Ookla, Speedtest and iperf are names of their owners; nexpulse is not affiliated with them.