Speedtest Tracker

This program runs a speedtest check every hour and graphs the results. The back-end is written in Laravel and the front-end uses React. It uses the Ookla's speedtest cli package to get the data and uses Chart.js to plot the results.

A demo can be found here

Disclaimer: You will need to accept Ookla's EULA and privacy agreements in order to use this container.

Features

• Automatically run a speedtest every hour
• Graph of previous speedtests going back x days
• Backup/restore data in JSON/CSV format
• Slack/Discord/Telegram notifications
• healthchecks.io integration
• Organizr integration
• InfluxDB integration (currently v1 only, v2 is a WIP)

Installation & Setup

Using Docker

A docker image is available here, you can create a new conatiner by running:

docker create \
      --name=speedtest \
      -p 8765:80 \
      -v /path/to/data:/config \
      -e OOKLA_EULA_GDPR=true \
      --restart unless-stopped \
      henrywhitaker3/speedtest-tracker

Using Docker Compose

version: '3.3'
services:
    speedtest:
        container_name: speedtest
        image: henrywhitaker3/speedtest-tracker
        ports:
            - 8765:80
        volumes:
            - /path/to/data:/config
        environment:
            - TZ=
            - PGID=
            - PUID=
            - OOKLA_EULA_GDPR=true
        logging:
            driver: "json-file"
            options:
                max-file: "10"
                max-size: "200k"
        restart: unless-stopped

Images

There are 2 different docker images:

| Tag | Description | | :----: | --- | | latest | This is the stable release of the app | | dev | This release has more features, although could have some bugs |

Parameters

Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate

:

-p 8080:80

80

8080

| Parameter | Function | | :----: | --- | |

-p 8765:80

-v /config

-e OOKLA_EULA_GDPR

-e SLACK_WEBHOOK

/slack

-e TELEGRAM_BOT_TOKEN

-e TELEGRAM_CHAT_ID

-e PUID

-e PGID

-e AUTH

-e INFLUXDB_RETENTION

30d

-e INFLUXDB_HOST_TAG |   Optional. Sets the InfluxDB host tag value, defaults to

Authentication

Authentication is optional. When enabled, unauthenticated users will only be able to see the graphs and tests table. To be able to queue a new speedtest, backup/restore data and update instance settings you will need to log in. To enable authentication, pass the

AUTH=true

php artisan speedtest:auth --enable

--disable

The default credentials are:

| Field | Function | | --- | --- | | username | [email protected] | | password | password |

After enabling, you should change the password through the web UI.

Manual Install

For manual installations, please follow the instructions here.

Kubernetes

There is a 3rd party helm chart available here.