Sign inSign up

ghosttorment/iperf3_statuspage

By ghosttorment

•Updated about 1 year ago

Runs scheduled iperf3 tests, exposing results through a lightweight self-hosted JSON API

Image
Networking
Internet of things
Monitoring & observability
0

1.1K

ghosttorment/iperf3_statuspage repository overview

⁠📡 Iperf3 Statuspage

A lightweight self-hosted service that runs scheduled iperf3 tests at configurable intervals and exposes results via a simple JSON API.

⁠🚀 Features

  • Runs iperf3 tests periodically based on configured interval
  • Exposes a single API endpoint /iperf3 returning the latest test results in JSON
  • Built in Rust for performance and safety
  • Minimal Alpine-based container image
  • Runs as a non-root user inside the container

⁠🐳 Usage

Run the container with environment variables to configure the server and test interval:

docker run -d \
  -p 8080:8080 \
  -e BIND_ADDRESS=0.0.0.0 \
  -e BIND_PORT=8080 \
  -e INTERVAL_MINUTES=60 \
  -e IPERF3_SERVER_IP=0.0.0.0 \
  -e IPERF3_SERVER_PORT=5201 \
  ghosttorment/iperf3_statuspage:latest

⁠⚙️ Configuration Environment Variables

VariableDescriptionDefault
BIND_ADDRESSAddress to bind the HTTP server to127.0.0.1
BIND_PORTPort for the HTTP server8080
INTERVAL_MINUTESMinutes between running iperf3 tests60
IPERF3_SERVER_IPIP Address of the Iperf3 Server0.0.0.0
IPERF3_SERVER_PORTPort of the Iperf3 Server5201

⁠📡 API Endpoint

  • GET /iperf3 — Returns the latest iperf3 test results as JSON.

⁠🔒 Security & Design

  • Built with Rust ensuring memory safety and performance
  • Runs as non-root user inside a minimal Alpine Linux container
  • No web UI included — designed for API consumption

⁠📜 Licenses

  • Apache License 2.0
  • MIT License

⁠📎 Links

Tag summary

Content type

Image

Digest

sha256:55c835f50…

Size

9.2 MB

Last updated

about 1 year ago

docker pull ghosttorment/iperf3_statuspage