Speedtest Visualisation Utiliy

Summary

Run speedtest calculations using Ookla

TL/DR

Speedtest-Viz Setup

To set up and run the Speedtest-Viz app, follow these steps:

1. Operating System: The setup script is designed to work on MacOS and Linux systems.

2. Ruby Installation:

   • If Ruby is not installed, the setup script will prompt you to install it.
   • On MacOS, make sure you have Homebrew installed. If not, follow the instructions on the website to install it.
   • On Linux, the script will use apt-get for package management.

3. Oookla Speedtest and speedtest-cli Installation:

   • If Oookla Speedtest or speedtest-cli is not installed, the setup script will prompt you to install them.
   • The script will use brew on MacOS and apt-get on Linux for installation.

Running the Setup Script

Execute the following command in your terminal:

bash setup.sh

Running the Setup Crontab Script

Execute the following command in your terminal:

bash setup_crontab.sh

cron speedtest & parser to run every 5 minutes :

The following two scripts are show as crontab entries,

'speedtest.simple' runs a simple speedtest with human readable output

'parse.speedtest.simple_to_csv' will take the output of the simple speedtest and creates a 'speedtest.csv' file that is read by 'app.rb' to plot data

both example scripts are in the 'bin' directory, edit them to point to your own 'bin' dir

• */5 * * * * /Users/morgan/bin/speedtest.simple

• */6 * * * * /Users/morgan/bin/parse.speedtest.simple_to_csv

Charting

Google Charts

The Google Charts library is used to provide the visualisation, and abillity to zoom into a selected subsection of the chart

Docker

Create the docker group.

sudo groupadd docker

Add your user to the docker group.

sudo usermod -aG docker ${USER}

You would need to log out and log back in so that your group membership is re-evaluated or type the following command:

su -s ${USER}

Build the container

docker build --tag speedtest .

Run the app : note the bindmount to make '/var/data/log/speedtest' directory available to the running container

docker run -p 4567:4567 --mount type=bind,source=/var/data/log/speedtest,target=/var/data/log/speedtest speedtest

Contributing

This started as a quick knock it out and hold Virgin Media accountable for the lies they tell. They promise a lot and deliver very little. This simple app is provided to help you when dealing with your ISP or maybe you would like to be able to "see" what your bandwidth looks like. It's prolly full of bugs and tpyos .. or as I see it: Opportunities for improvement. ;-)

If you would like to contribute, please feal free to fork this repo, make changes and submit a PR. I'm happy to review.

Still working on the concept of releases as this is more of a stream of consciousness thing. I hope this helps you in some way. morgan@morganism.dev