Skip to content

Commit 522b94d

Browse files
adamus1redadamus1red
authored
Merge branch 'alexjustesen:main' into patch-1
2 parents b4a9b67 + ffdc358 commit 522b94d

File tree

3 files changed

+58
-6
lines changed

3 files changed

+58
-6
lines changed

‎README.md‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,14 @@ Speedtest Tracker is in active development, during this "alpha" phase expect thi
1616

1717
### Introduction
1818

19-
Speedtest Tracker runs a speedtest check against Ookla's Speedtest service on a schedule.
19+
Speedtest Tracker is a self-hosted internet performance tracking application that runs speedtest checks against Ookla's Speedtest service.
2020

21-
### Features
21+
#### Why might I want this?
2222

23-
* Scheduled speedtest
24-
* Ad-hoc speedtest
25-
* Specify a speedtest server or use the default "closest" server
26-
* Store results to your database of choice `sqlite`, `mariadb` / `mysql` or `postgresql`
23+
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.
24+
25+
_...also some of us just like a lot of data._
26+
27+
#### What about that other Speedtest Tracker?
28+
29+
As far as I can tell [https://github.com/henrywhitaker3/Speedtest-Tracker](https://github.com/henrywhitaker3/Speedtest-Tracker) was abandoned. This version is meant to be an actively maintained replacement with an improved UI and [feature](getting-started/features.md) set.

‎SUMMARY.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
## 🚀 Getting Started
66

77
* [Installation](getting-started/installation.md)
8+
* [Features](getting-started/features.md)
89
* [Authentication](getting-started/authentication.md)
910

1011
## 🤹 Contributing

‎getting-started/features.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
description: A full list of implemented features and those that are planned.
3+
---
4+
5+
# Features
6+
7+
| Features | Status |
8+
| ------------------------------------------------------------------------------------------------------------------------------- | ------: |
9+
| **Install options** | |
10+
| Docker images for x86 | Done |
11+
| Docker images for arm64 | Planned |
12+
| Bare metal | Planned |
13+
| | |
14+
| **Dashboard** | |
15+
| Show the most recent results | Done |
16+
| Pretty graphs | Planned |
17+
| History of results | Done |
18+
| | |
19+
| **Speedtest options** | |
20+
| Scheduled tests | Done |
21+
| Adhoc test | Done |
22+
| Manually specify a server | Done |
23+
| Manually specify a list of servers | Planned |
24+
| Threshold alerts | Planned |
25+
| | |
26+
| **Database support** | |
27+
| SQLite (default) | Done |
28+
| MariaDB / MySQL | Done |
29+
| Postgresql | Done |
30+
| InfluxDB v1 | Planned |
31+
| InfluxDB v2 | Done |
32+
| Prometheus | Planned |
33+
| | |
34+
| **Notification Channels** | |
35+
| Mail | Planned |
36+
| Discord | Planned |
37+
| Gotify | Planned |
38+
| Slack | Planned |
39+
| Telegram | Planned |
40+
| | |
41+
| **Application Monitoring** | |
42+
| [https://ohdear.app/](https://ohdear.app/) | Planned |
43+
| [https://thenping.me/](https://thenping.me/) | Planned |
44+
| [https://healthchecks.io/](https://healthchecks.io/) | Planned |
45+
| | |
46+
| **Other** | |
47+
| Backup / Restore | Planned |
48+
| Import data from [https://github.com/henrywhitaker3/Speedtest-Tracker](https://github.com/henrywhitaker3/Speedtest-Tracker) | Planned |

0 commit comments

Comments
 (0)