|
1 | 1 | # Speedtest |
2 | 2 |
|
3 | | -[](https://hub.docker.com/r/henrywhitaker3/speedtest-tracker) |
4 | | -[](https://github.com/henrywhitaker3/Speedtest-Tracker) |
| 3 | +[](https://hub.docker.com/r/linuxserver/speedtest-tracker) |
| 4 | +[](https://github.com/linuxserver/docker-speedtest-tracker) |
5 | 5 | [](https://github.com/GhostWriters/DockSTARTer/tree/main/compose/.apps/speedtest) |
6 | 6 |
|
7 | 7 | ## Description |
8 | 8 |
|
9 | | -[Speedtest Tracker](https://github.com/henrywhitaker3/Speedtest-Tracker) runs a |
10 | | -speedtest check every hour and graphs the results. The back-end is written in |
11 | | -`Laravel` and the front-end uses `React`. It uses the Ookla's Speedtest cli |
12 | | -package to get the data and uses `Chart.js` to plot the results. |
| 9 | +[Speedtest Tracker](https://github.com/linuxserver/docker-speedtest-tracker) is a self-hosted application that monitors the performance and uptime of your internet connection. |
13 | 10 |
|
14 | | -This program can also be used a home page item in |
15 | | -[Organizr](https://organizr.app). |
| 11 | +### Features |
16 | 12 |
|
17 | | -A demo is available [here](https://speedtest.henrywhitaker.com). |
18 | | - |
19 | | -_Disclaimer: You will need to accept Ookla's EULA and privacy agreements in order to use this container._ |
| 13 | +- **Automated Tests**: Schedule regular speed tests to monitor your internet connection's performance over time. |
| 14 | +- **Detailed Metrics**: Capture download and upload speeds, ping, packet loss and more. |
| 15 | +- **Historical Data**: View historical data and trends to identify patterns and issues with your internet connection. |
| 16 | +- **Notifications**: Receive notifications when your internet performance drops below a certain threshold. |
20 | 17 |
|
21 | 18 | ## Install/Setup |
22 | 19 |
|
23 | | -This application does not have any specific setup instructions documented. If |
24 | | -you need assistance setting up this application please visit our |
25 | | -[support page](https://dockstarter.com/basics/support/). |
| 20 | +### Generate an Application Key |
| 21 | + |
| 22 | +Run the command below to generate a key, the key is required for encryption. Copy this key including the base64: prefix and paste it as your `APP_KEY` value in `env_files/speedtest.env`. |
| 23 | + |
| 24 | +```bash |
| 25 | +echo -n 'base64:'; openssl rand -base64 32; |
| 26 | +``` |
| 27 | + |
| 28 | +### DB Type |
| 29 | + |
| 30 | +`SQLite` is fine for most installs but you can also use more traditional relational databases like `MariaDB`, `MySQL` and `Postgres`. Update your `DB_CONNECTION` value in `env_files/speedtest.env`. |
| 31 | + |
| 32 | +### APP URL |
26 | 33 |
|
27 | | -### Base Path |
| 34 | +The IP:port or URL your application will be accessed on (ie. http://192.168.1.1:6875 or https://speedtest.mydomain.com). Update your `APP_URL` value in `env_files/speedtest.env`. |
28 | 35 |
|
29 | | -You can set a base path for this application if you want to host it behind a |
30 | | -reverse proxy. By default it binds to `/`, but you can change the variable |
31 | | -called `BASE_PATH` in your `env_files/speedtestr.env` file to whatever you want and run |
32 | | -`ds -c up speedtest` afterwards. |
| 36 | +### Speedtest Servers |
33 | 37 |
|
34 | | -As usual, we **strongly discourage** having this application be public facing |
35 | | -without some sort of protection in front of it, such as |
36 | | -[Organizr's Server Auth](https://docs.organizr.app/books/setup-features/page/serverauth). |
| 38 | +A comma-separated list of server IDs to test against. Run the following command to get a list of nearby servers then update your `SPEEDTEST_SERVERS` value in `env_files/speedtest.env`. |
37 | 39 |
|
38 | | -### Notifications |
| 40 | +```bash |
| 41 | +docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/speedtest-tracker:latest list-servers |
| 42 | +``` |
39 | 43 |
|
40 | | -This application supports notifications to some of the most popular services |
41 | | -such as Telegram and Discord. Both of these services can be configured either |
42 | | -using the application's Web GUI or environment variables through an |
43 | | -[override](https://dockstarter.com/overrides/introduction). |
| 44 | +If you need further assistance setting up this application, please visit the official |
| 45 | +[GitHub repository](https://github.com/alexjustesen/speedtest-tracker), [Hub Docker](https://hub.docker.com/r/linuxserver/speedtest-tracker) or our |
| 46 | +[support page](https://dockstarter.com/basics/support). |
0 commit comments