Skip to content

Update notifications Docs #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexjustesen merged 11 commits into from
May 23, 2025
Merged

Update notifications Docs #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
8e479db
GITBOOK-1: No subject
svenvg93 Apr 29, 2025
0d63381
GITBOOK-2: No subject
svenvg93 Apr 30, 2025
5f176aa
GITBOOK-3: No subject
svenvg93 May 3, 2025
6ea97dc
Merge branch 'alexjustesen:main' into main
svenvg93 May 12, 2025
22da9c1
GITBOOK-4: No subject
svenvg93 May 12, 2025
65c9e9c
GITBOOK-5: No subject
svenvg93 May 12, 2025
0adda60
GITBOOK-6: No subject
svenvg93 May 12, 2025
525f64f
Merge branch 'main' into main
svenvg93 May 19, 2025
bfd24aa
Merge branch 'alexjustesen:main' into main
svenvg93 May 20, 2025
adc98a6
Merge branch 'alexjustesen:main' into main
svenvg93 May 22, 2025
2106819
Update SUMMARY.md
svenvg93 May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .gitbook/assets/apprise_notification.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/db_notification.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/mail_notification.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/webhook_notification.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
* [Notifications](settings/notifications/README.md)
* [Database](settings/notifications/database.md)
* [Mail](settings/notifications/mail.md)
* [Telegram](settings/notifications/telegram.md)
* [Webhook](settings/notifications/webhook.md)

## 👀 Other

Expand Down
5 changes: 4 additions & 1 deletion other/commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,13 @@ Core commands exist at the framework level and might be extended to provide addi

Application commands are built to extend Speedtest Tracker's functionality from the CLI.

<table><thead><tr><th width="261">Command</th><th>Description</th></tr></thead><tbody><tr><td><code>app:install</code></td><td>Installs a fresh version of Speedtest Tracker. If you have an existing install <em><strong>this will delete all data</strong></em>.</td></tr><tr><td><code>app:ookla-list-servers</code></td><td>Get a list of local Ookla speedtest servers.</td></tr><tr><td><code>app:user-change-role</code></td><td>Change the role for a user.</td></tr><tr><td><code>app:user-reset-password</code></td><td>Change the password for a user.</td></tr><tr><td><code>app:version</code></td><td>Sends a notification to the admin users when Speedtest Tracker is outdated.</td></tr></tbody></table>
<table><thead><tr><th width="261">Command</th><th>Description</th></tr></thead><tbody><tr><td><code>app:install</code></td><td>Installs a fresh version of Speedtest Tracker. If you have an existing install <em><strong>this will delete all data</strong></em>.</td></tr><tr><td><code>app:ookla-list-servers</code></td><td>Get a list of local Ookla speedtest servers.</td></tr><tr><td><code>app:user-change-role</code></td><td>Change the role for a user.</td></tr><tr><td><code>app:user-reset-password</code></td><td>Change the password for a user.</td></tr></tbody></table>

### Maintenance commands

Maintenance commands help fix issues that might crop up over time.

<table><thead><tr><th width="261">Command</th><th>Description</th></tr></thead><tbody><tr><td><code>app:result-fix-statuses</code></td><td>Reviews the data payload of each result and corrects the status attribute.</td></tr></tbody></table>



2 changes: 2 additions & 0 deletions other/speedtest-process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@ Speedtest Tracker uses the [Official Ookla CLI](https://www.speedtest.net/apps/c

{% stepper %}
{% step %}

#### Waiting

The speedtest run request was created but has not been started.
{% endstep %}

{% step %}

#### Started

The speedtest process has been started by a queue worker.
Expand Down
2 changes: 1 addition & 1 deletion settings/notifications/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Notifications

{% hint style="warning" %}
Database, mail and webhook notifications are considered "core" channels. We're currently working on integrating Apprise and all other notification channels should be considered deprecated.
Database, Mail and Webhook notifications are considered "core" channels. We're currently working on integrating Apprise and all other notification channels should be considered deprecated.
{% endhint %}
22 changes: 22 additions & 0 deletions settings/notifications/apprise.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
hidden: true
---

# Apprise

Speedtest Tracker uses [Apprise](https://github.com/caronc/apprise-api) to send notifications to a wide variety of messaging services with a simple, unified configuration.

Apprise allows you to easily deliver alerts to popular platforms such as Discord, Slack, Telegram and many more.

{% hint style="warning" %}
To use Apprise notifications, you must deploy the [Apprise API](https://github.com/caronc/apprise-api) service. This is out of scope of this documentation.
{% endhint %}

<figure><img src="../../.gitbook/assets/apprise_notification.png" alt=""><figcaption><p>Apprise Settings</p></figcaption></figure>

<table><thead><tr><th width="200">Name</th><th width="535">Description</th></tr></thead><tbody><tr><td>URL</td><td>This is the URL of your running Apprise API instance </td></tr><tr><td>Service URL</td><td>This is the URL of the service that will receive the notification. You can find a full list of supported services and how to format their URLs in the <a href="https://github.com/caronc/apprise/wiki#notification-services">Apprise notification services documentation</a>.</td></tr></tbody></table>

### Triggers

<table><thead><tr><th width="237">Name</th><th>Description</th></tr></thead><tbody><tr><td>On completed speedtest</td><td>On each successful speedtest a notification will be send to the application.</td></tr><tr><td>On absolute threshold failure</td><td>On any absolute threshold failure a notification will be send to the application.</td></tr></tbody></table>

22 changes: 0 additions & 22 deletions settings/notifications/telegram.md
View file
Open in desktop

This file was deleted.

62 changes: 62 additions & 0 deletions settings/notifications/webhook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Webhook

A webhook will send a JSON payload to a receiver of your choice

<figure><img src="../../.gitbook/assets/webhook_notification.png" alt=""><figcaption><p>Webhook settings</p></figcaption></figure>

### Payload

Payload sent for a completed test

```json
{
"result_id": 2,
"site_name": "Speedtest Tracker",
"service": "Ookla",
"serverName": "Speedtest",
"serverId": 12345,
"isp": "Speedtest Communications",
"ping": 6.7,
"download": 93281280,
"upload": 28769728,
"packetLoss": 0,
"speedtest_url": "https://docs.speedtest-tracker.dev",
"url": "http://localhost/admin/results"
}
```

Payload sent for a threshold failure

```json
{
"result_id": 8,
"site_name": "Speedtest Tracker",
"service": "Ookla",
"serverName": "Speedtest",
"serverId": 12345,
"isp": "Speedtest Communications",
"metrics": [
{
"name": "Download",
"threshold": "1000 Mbps",
"value": "91.78 Mbps"
},
{
"name": "Upload",
"threshold": "1000 Mbps",
"value": "28.18 Mbps"
},
{
"name": "Ping",
"threshold": "2 ms",
"value": "6.41 ms"
}
],
"speedtest_url": "https://docs.speedtest-tracker.dev",
"url": "http://localhost/admin/results"
}
```

### Triggers

<table><thead><tr><th width="237">Name</th><th>Description</th></tr></thead><tbody><tr><td>On completed speedtest</td><td>On each successful speedtest a notification will be send to the application.</td></tr><tr><td>On absolute threshold failure</td><td>On any absolute threshold failure a notification will be send to the application.</td></tr></tbody></table>