Deploy a Reporter
in Under 60 Seconds

The BitWell Reporter is a lightweight Docker container that runs on any Linux host. It enrolls with the network, pulls check targets, and starts reporting — no config files, no fuss.

Requirements Linux (x86_64 or arm64) Docker 20.10+ with Compose Outbound HTTPS access Enrollment token from your dashboard
01

Generate an enrollment token

Each token is single-use and expires after the chosen TTL. The reporter exchanges it for a permanent identity on first start — re-enrollment is never needed after that.

Expires in

Token is returned once and never stored — copy it before leaving this page.

02

Build your install command

Paste your token below. Optionally add a region label so you can identify this reporter on the status page (e.g. us-east, home-lab). Then run the command on your server.


                
              

Re-running the command on an already-enrolled host is safe — it updates config and restarts the container. The installer auto-fetches Docker if not present. View raw script.

03

You're live

The reporter enrolls with BitWell, fetches its check list, and begins submitting results within seconds. It will appear on the status page as an active reporter in your chosen region.

To view logs on your server:

docker compose -f /opt/bitwell-reporter/docker-compose.yml logs -f

What the reporter does

Once enrolled, the reporter runs autonomously — no ongoing maintenance required.

Continuous checks

Polls each assigned target on a configurable interval and records latency and HTTP status.

Signed reports

Results are HMAC-signed before upload so the gatherer can verify authenticity and reject tampering.

Auto-updates

The container pulls the latest image on restart, so you always get the newest check logic and bug fixes.