|
1 | 1 | # 🐇 Speedtest Tracker |
2 | 2 |
|
3 | | -Speedtest Tracker is a self-hosted internet performance tracking application that runs speedtests using Ookla's Speedtest service. |
| 3 | +Speedtest Tracker is a self-hosted application that monitors the performance and uptime of your internet connection. |
4 | 4 |
|
5 | | -[](https://star-history.com/#alexjustesen/speedtest-tracker&Date) |
6 | | - |
7 | | -### Why might I use this? |
| 5 | + |
8 | 6 |
|
9 | | -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. |
| 7 | +## Features |
10 | 8 |
|
11 | | -### What about that other Speedtest Tracker? |
12 | | - |
13 | | -As far as I can tell https://github.com/henrywhitaker3/Speedtest-Tracker was abandoned. This is meant to be an actively maintained replacement with an improved UI and feature set. |
| 9 | +- **Automated Tests**: Schedule regular speed tests to monitor your internet connection's performance over time. |
| 10 | +- **Detailed Metrics**: Capture download and upload speeds, ping, packet loss and more. |
| 11 | +- **Historical Data**: View historical data and trends to identify patterns and issues with your internet connection. |
| 12 | +- **Notifications**: Receive notifications when your internet performance drops below a certain threshold. |
14 | 13 |
|
15 | 14 | ## Getting Started |
16 | 15 |
|
17 | | -Speedtest Tracker is containerized so you can run it anywhere you run your Docker containers. The [install](https://docs.speedtest-tracker.dev/getting-started/installation) documentation will get you up and running with using Docker or Docker Composer along with choosing a database (SQLite, MySQL/MariaDB or Postgresql). |
18 | | - |
19 | | -### Quick Start |
20 | | - |
21 | | -#### Docker |
22 | | - |
23 | | -```bash |
24 | | -docker run -d --name speedtest-tracker --restart unless-stopped \ |
25 | | - -p 8080:80 \ |
26 | | - -e PUID=1000 \ |
27 | | - -e PGID=1000 \ |
28 | | - -e APP_KEY= \ # How to generate an app key: https://speedtest-tracker.dev/ |
29 | | - # -e SPEEDTEST_SCHEDULE= \ # optional: schedule a speedtest with an cronjob https://crontab.guru |
30 | | - -e APP_URL=http://localhost \ |
31 | | - -e DB_CONNECTION=sqlite \ |
32 | | - -v ${PWD}:/config \ |
33 | | - lscr.io/linuxserver/speedtest-tracker:latest |
34 | | -``` |
35 | | - |
36 | | -#### Docker Compose |
37 | | - |
38 | | -```bash |
39 | | -services: |
40 | | - speedtest-tracker: |
41 | | - container_name: speedtest-tracker |
42 | | - ports: |
43 | | - - 8080:80 |
44 | | - - 8443:443 |
45 | | - environment: |
46 | | - - PUID=1000 |
47 | | - - PGID=1000 |
48 | | - - APP_KEY= # How to generate an app key: https://speedtest-tracker.dev/ |
49 | | - - APP_URL=http://localhost |
50 | | - - DB_CONNECTION=sqlite |
51 | | - # - SPEEDTEST_SCHEDULE= # optional: schedule a speedtest with an cronjob https://crontab.guru |
52 | | - volumes: |
53 | | - - /path/to/data:/config |
54 | | - - /path/to-custom-ssl-keys:/config/keys |
55 | | - image: lscr.io/linuxserver/speedtest-tracker:latest |
56 | | - restart: unless-stopped |
57 | | -``` |
58 | | -For more environment configuration to customize your installation see the docs: https://docs.speedtest-tracker.dev/getting-started/environment-variables |
| 16 | +Speedtest Tracker is containerized so you can run it anywhere you run your containers. The image is built by LinuxServer.io, build information can be found [here](https://fleet.linuxserver.io/image?name=linuxserver/speedtest-tracker). |
59 | 17 |
|
| 18 | +- [Installation](https://docs.speedtest-tracker.dev/getting-started/installation) guide will get you up and running and includes steps for deploying the Docker image or to NAS platforms like Synology and Unraid. |
| 19 | +- [Configurations](https://docs.speedtest-tracker.dev/getting-started/environment-variables) are used to tailor Speedtest Tracker to your needs. |
| 20 | +- [Notifications](https://docs.speedtest-tracker.dev/settings/notifications) channels alert you when issues happen. |
| 21 | +- [Frequently Asked Questions](https://docs.speedtest-tracker.dev/help/faqs) are common questions that can help you resolve issues. |
60 | 22 |
|
61 | | -## Image version |
62 | | - |
63 | | -A full list of released versions can be found here: https://fleet.linuxserver.io/image?name=linuxserver/speedtest-tracker |
64 | | - |
65 | | -### FAQs and Features |
66 | | - |
67 | | -[FAQs](https://docs.speedtest-tracker.dev/faqs) and a full list of planned and completed [features](https://docs.speedtest-tracker.dev/getting-started/features) can be found in the [documentation](https://docs.speedtest-tracker.dev). |
68 | | - |
69 | | -## API |
70 | | - |
71 | | -A robust API is planned for a later release but as of `v0.11.8` a legacy endpoint `/api/speedtest/latest` which is used by home lab dashboards like [Homepage](https://github.com/benphelps/homepage) and [Organizr](https://github.com/causefx/Organizr/tree/v2-master). |
72 | | - |
73 | | -## Screenshots |
74 | | - |
75 | | - |
76 | | -**Dashboard** |
| 23 | +[](https://star-history.com/#alexjustesen/speedtest-tracker&Date) |
0 commit comments