Skip to content

Commit 6e45fe0

Browse files
alexjustesengitbook-bot
authored andcommitted
GitBook: [alexjustesen#14] No subject
1 parent 47e8cdf commit 6e45fe0

File tree

4 files changed

+18
-7
lines changed

4 files changed

+18
-7
lines changed

README.md

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

99
{% hint style="info" %}
10-
These docs are up-to-date for version `0.1.0-alpha7`
11-
{% endhint %}
12-
13-
{% hint style="warning" %}
14-
Speedtest Tracker is in active development, during this "alpha" phase expect things to change and maybe break.
10+
These docs are up-to-date for version `0.1.0-beta`
1511
{% endhint %}
1612

1713
### Introduction

getting-started/authentication.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
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` |

getting-started/features.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,14 @@ 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** | |
1012
| Docker images for x86 | Done |
11-
| Docker images for arm64 | Planned |
13+
| Docker images for arm64 | Done |
14+
| unRAID Community App | Done |
1215
| Bare metal | Planned |
1316
| | |
1417
| **Dashboard** | |
@@ -21,7 +24,10 @@ description: A full list of implemented features and those that are planned.
2124
| Adhoc test | Done |
2225
| Manually specify a server | Done |
2326
| Manually specify a list of servers | Planned |
24-
| Threshold alerts | Planned |
27+
| Threshold alerts | Done |
28+
| | |
29+
| **Ping options** | |
30+
| Ping a domain or list of domains | Planned |
2531
| | |
2632
| **Database support** | |
2733
| SQLite (default) | Done |
@@ -32,6 +38,7 @@ description: A full list of implemented features and those that are planned.
3238
| Prometheus | Planned |
3339
| | |
3440
| **Notification Channels** | |
41+
| In-app | Done |
3542
| Mail | Planned |
3643
| Discord | Planned |
3744
| Gotify | Planned |

getting-started/installation.md

Lines changed: 6 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 |
@@ -154,3 +156,7 @@ volumes:
154156
```
155157
{% endtab %}
156158
{% endtabs %}
159+
160+
### Install on unRAID
161+
162+
The unRAID community app store contains an app template managed by ZappyZap. Search "Speedtest Tracker" to install. Template support can be found [here](https://forums.unraid.net/topic/130245-support-devzwf-speedtest-tracker/).

0 commit comments

Comments
 (0)