Skip to content

Latest commit

 

History

History
33 lines (28 loc) · 1.67 KB

README.md

File metadata and controls

33 lines (28 loc) · 1.67 KB
Raw

License: MIT

speedtest-tool

speedtest-tool is used to gather and visualize speedtest statistics about your local network.

Structure of speedtest-tool

Parts

  • speedtest.sh is a script that is used to run a speedtest and report the values to a local InfluxDB
  • docker-compose.yml is used to start InfluxDB and Grafana with the needed configuration
  • grafana is used to predefine the needed dashboard in Grafana
  • .env is used to define variables
  • install.sh is used to install the needed cli-tools

Install

  1. Install the Docker Engine (Install instructions: https://docs.docker.com/engine/install/)
  2. Install Docker Compose (Install instructions: https://docs.docker.com/compose/install/)
  3. Install speedtest, jq and curl or run install.sh
  4. Run docker-compose up to start InfluxDB and Grafana
  5. Configure a cronjob that runs speedtest.sh at your given interval (Crontab-Guru)
    To configure a cronjob the command crontab -e has to be used. At the end of the file the following line has to be inserted:
* * * * * /path/to/speedtest.sh
  1. Open http://localhost:3000/ in your browser and login (default credentials: user: admin, password: admin)
  2. Open the dashbard Speedtest using the left navigation bar

Prerequisites