alexjustesen / speedtest-tracker-docs

Docs for Speedtest Tracker.

description
A Docker image to check your internet speed using Ookla's Speedtest service. Build using Laravel and the Speedtest CLI.

Introduction

{% hint style="info" %} Docs are up to date through version: 0.20.x {% endhint %}

V0.20.6 Dashboard

Introduction

Speedtest Tracker is a self-hosted internet performance tracking application that runs speedtest checks against Ookla's Speedtest service.

Why might I want this?

The main use case for Speedtest Tracker is to build a history of your internet's performance so that you can be informed when you're not receiving your ISP's advertised rates.

...also some of us just like a lot of data.

What about that other Speedtest Tracker?

As far as I can tell https://github.com/henrywhitaker3/Speedtest-Tracker was abandoned. This version is meant to be an actively maintained replacement with an improved UI and feature set.

Do you have a demo?

No, but DB Tech and Awesome Opens Source over on YouTube have awesome videos showing you how to get Speedtest Tracker up and running with and a quick demo.

speedtest-tracker-docs's Issues

PUID , GUID change PI , Docker (Soluce)

the PUID GUID 1000 corresponds to the root on PI, you can either make an #id in your pi shell to see which GUID and PUID uses docker for me it's 995 I changed in the ENV configuration in container , and I no longer have any worries when the container is launched

Add ntfy as a Notification Option

Would be a nice feature to include ntfy as an option when setting up notifications.

https://ntfy.sh/

Synology install steps

Really need to add steps for installing on Synology devices.

Combine "installation" and "environment variable" lists

Leaving myself a note but README.md seems to be a duplicate of the environment variables page we should consolidate these two pages down to one.

Originally posted by @alexjustesen in #26 (comment)

Grafana Dashboard Guage Question

Thank you keeping this project going. Appreciate your work.

I have the grafana dashboard setup. I see data in the graphs, but not in the gauges. Not sure what I am missing. I am not a Grafana expert. If I click on edit for a gauge, click on query inspector, and then the data tab, it shows the correct value there. Not sure why it is then not showing on the gauge.

Add Environment Variable to disable Authentication

Add Environment Variable to disable Authentication.
If middleware like authentik or authelia is used to secure access.

environment-variables link not working

hmm this link doesnt seem to work? - can you help
https://github.com/alexjustesen/speedtest-tracker-docs/blob/main/getting-started/installation/environment-variables.md

thanks

Grafana Dashboard

Do we want to publish a ready-made Grafana dashboard? :)

I just completed it. It shows the history of the tests, an average per server, and a table for all tests. I added the jitter and packet-loss to the table views. I hope the influxdb structure won't change much. :)

`app url` ?

Sorry for posting here but there is no discussion section
Amazing work here Alex. Everything is working great, and I got few emails but I can't open the links.

I noticed you mentioned app_url in here but I am not sure how to go about setting that up.

add more detail to the environment-variable docs

I think the environment-variables could be improved in both format and content.

At a minimum i feel that each variable in the table should additionally have a type specified (bool, string, int) and at least 1 valid example. This is especially true for the datetime formatting.

For example:

• what format do i use to specify APP_TIMEZONE ? Docs say nothing about this.
• CHART_DATETIME_FORMAT , DATETIME_FORMAT : a couple of common examples would probably satisfy 99% of use cases and save users from wading through PHP docs
• DISPLAY_TIMEZONE: I'm assuming this is bool or should it be string?

i think clearer tables would look something like this (or contain the same information in different format):

Example1

Name	Required	Description	Example
SPEEDTEST_SCHEDULE str	✅	Cron expression used to run speedtests on a scheduled basis. Default: None	* 1 * * *

Example2

Name	Description
SPEEDTEST_SCHEDULE str	Cron expression used to run speedtests on a scheduled basis. Default: None Example: * 1 * * * Required: ✅

Traefik config missing in Gitbook

@alexjustesen some how the page does not show up :(

Originally posted by @svenvg93 in #24 (comment)

cannot select servers to test from?

EDIT: nevermind, i RTFM, disregard.

i used to be able to select which servers to test from but am no longer able to do so. was this feature removed?

No cron jon any more

My speedtest-tracker on docker used to measure scheduled every 15min. Since June 7th it stopped doing this. What can I do?

QNAP Instructions Result in Error

Following these instructions on my QNAP TVS-h874T running QuTShero h5.1.7.2770, this is what I get as a result:

I see there was a commit to remove the version number. I added it back, and it liked it better:

Documentation nginx reverse proxy

Could we have a documentation for nginx reverse proxy please ?
I've tried to add the APP_URL like https://127.0.0.1/speedtest in .env and a configuration in my nginx.conf something like this

location /speedtest {
proxy_pass https://127.0.0.1:3149/speedtest;
proxy_redirect off;
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

But it doesn't work.
Thanks.