Merge pull request alexjustesen#76 from svenvg93/update-notifications

Update notifications Docs

Author: alexjustesen

.gitbook/assets/apprise_notification.png

@@ -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
 

.gitbook/assets/db_notification.png

@@ -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>
+
+
+

.gitbook/assets/mail_notification.png

@@ -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.

.gitbook/assets/webhook_notification.png

@@ -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 %}

SUMMARY.md

@@ -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>
+