Skip to content

Commit ace2313

Browse files
alexjustesengitbook-bot
authored andcommitted
GitBook: [alexjustesen#15] No subject
1 parent 7c9d8e3 commit ace2313

File tree

5 files changed

+21
-3
lines changed

5 files changed

+21
-3
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: >-
77
# 🐇 Speedtest Tracker
88

99
{% hint style="info" %}
10-
These docs are up-to-date for version `0.1.0-beta`
10+
These docs are up-to-date for version `0.1.0`
1111
{% endhint %}
1212

1313
### Introduction
@@ -23,3 +23,7 @@ _...also some of us just like a lot of data._
2323
#### What about that other Speedtest Tracker?
2424

2525
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.
26+
27+
#### Do you have a demo?
28+
29+
No, but DB Tech over on YouTube has an awesome [video](https://www.youtube.com/watch?v=feArak6WCLw) showing you how to get Speedtest Tracker up and running with Portainer and a quick demo.

SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
## 🔗 More
1616

17+
* [Source Code](https://github.com/alexjustesen/speedtest-tracker)
1718
* [Update the Docs](https://github.com/alexjustesen/speedtest-tracker-docs)
1819
* [About Me](https://alexjustesen.com/?utm\_campaign=oss-projects\&utm\_source=speedtest-tracker-docs\&utm\_medium=textlink)
1920
* [Donate](https://github.com/sponsors/alexjustesen)
20-
* [Source Code](https://github.com/alexjustesen/speedtest-tracker)

getting-started/authentication.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,16 @@
22

33
Speedtest Tracker uses Filament for the admin panel. During the install process an admin account is created for you.
44

5+
<figure><img src="https://github.com/alexjustesen/speedtest-tracker/blob/main/.github/screenshots/login_screenshot.png?raw=true" alt=""><figcaption><p><em>Login</em></p></figcaption></figure>
6+
57
| Username | Password |
68
| ------------------- | ---------- |
79
| `[email protected]` | `password` |
810

911
{% hint style="info" %}
1012
A process for changing the admin account's email address and password is planned.
1113
{% endhint %}
14+
15+
{% hint style="info" %}
16+
As of the latest version you can not disable authentication but this is a planned feature.
17+
{% endhint %}

getting-started/features.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ description: A full list of implemented features and those that are planned.
44

55
# Features
66

7+
<figure><img src="https://github.com/alexjustesen/speedtest-tracker/blob/main/.github/screenshots/dashboard_screenshot.png?raw=true" alt=""><figcaption><p><em>Dashboard</em></p></figcaption></figure>
8+
79
| Features | Status |
810
| ------------------------------------------------------------------------------------------------------------------------------- | ------: |
911
| **Install options** | |
@@ -22,7 +24,10 @@ description: A full list of implemented features and those that are planned.
2224
| Adhoc test | Done |
2325
| Manually specify a server | Done |
2426
| Manually specify a list of servers | Planned |
25-
| Threshold alerts | Planned |
27+
| Threshold alerts | Done |
28+
| | |
29+
| **Ping options** | |
30+
| Ping a domain or list of domains | Planned |
2631
| | |
2732
| **Database support** | |
2833
| SQLite (default) | Done |
@@ -33,6 +38,7 @@ description: A full list of implemented features and those that are planned.
3338
| Prometheus | Planned |
3439
| | |
3540
| **Notification Channels** | |
41+
| In-app | Done |
3642
| Mail | Planned |
3743
| Discord | Planned |
3844
| Gotify | Planned |

getting-started/installation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Installation
22

3+
<figure><img src="https://github.com/alexjustesen/speedtest-tracker/blob/main/.github/screenshots/results_screenshot.png?raw=true" alt=""><figcaption><p><em>Results</em></p></figcaption></figure>
4+
35
### Required Configuration
46

57
| Variable | Default Value | Description |

0 commit comments

Comments
 (0)