Skip to content

Commit d28e44c

Browse files
svenvg93gitbook-bot
authored andcommitted
GitBook: No commit message
1 parent 104e63d commit d28e44c

File tree

2 files changed

+22
-4
lines changed

2 files changed

+22
-4
lines changed
9.1 KB
Loading

settings/notifications/apprise.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,32 @@ Apprise provides a unified notification channel that lets you send alerts to num
44

55
<figure><img src="../../.gitbook/assets/apprise_notifiations.png" alt=""><figcaption><p>Apprise settings</p></figcaption></figure>
66

7+
### Why Apprise
8+
9+
Apprise allows the application to sent notifications to a wide variety of services. It let us focus on features instead of maintaining X number of notification channels. Essentially helping us cut down on maintenance/feature requests.
10+
711
### Apprise Server
812

9-
To use Apprise, you’ll need to set up your own Apprise container. This container isn’t created automatically, so make sure to include it in your deployment. See the Apprise [Github Repo](https://github.com/caronc/apprise-api) for the setup instructions.
13+
To use Apprise, you’ll need to set up your own Apprise instance. This container isn’t created automatically, so make sure to include it in your deployment. See the Apprise [Github Repo](https://github.com/caronc/apprise-api) for the setup instructions. On the notification page you will need to define the location of your Apprise instance. Make sure this instance is reachable for the Speedtest Tracker.
14+
15+
{% hint style="info" %}
16+
We don't offer support on setting up Apprise, incase of any problems with the Apprise Container please reach out to the Apprise team.&#x20;
17+
{% endhint %}
18+
19+
### Notification Channels
20+
21+
Notification channels are the formatted URLs used by Apprise to send notifications to various services. Refer to the [Apprise documentation](https://github.com/caronc/apprise?tab=readme-ov-file#supported-notifications) for a full list of supported channels and their required formats. You can add as many different channels as you wish. The notifications will be sent to all of them.&#x20;
22+
23+
### Tips and Tricks
24+
25+
#### Format
26+
27+
By default the format used for message is `markdown` This allows us to do some formatting on the message like bold text etc.
1028

11-
### Apprise Channels
29+
#### Preview Images
1230

13-
Apprise channels are the formatted URLs used by Apprise to send notifications to various services. Refer to the [Apprise documentation](https://github.com/caronc/apprise?tab=readme-ov-file#supported-notifications) for a full list of supported channels and their required formats.
31+
By default Apprise does not allow preview images for URLs. This is an default setting on the Apprise instance. Depending on the service used you can override this settings in the notification channel URL. Check the Apprise documentation to see if your service support this and how to set it.&#x20;
1432

1533
### Triggers
1634

17-
<table><thead><tr><th width="237">Name</th><th>Description</th></tr></thead><tbody><tr><td>on every scheduled speedtest run</td><td>On each successful scheduled speedtest a notification will be send to the application.</td></tr><tr><td>on threshold failures for scheduled speedtests</td><td>On any absolute threshold failure for scheduled speedtest a notification will be send to the application.</td></tr></tbody></table>
35+
<table><thead><tr><th width="237">Name</th><th>Description</th></tr></thead><tbody><tr><td>on every scheduled speedtest run</td><td>On each successful scheduled speedtest a notification will be send to the application.</td></tr><tr><td>on threshold failures for scheduled speedtests</td><td>On any absolute threshold failure for scheduled speedtest a notification will be send to the application.</td></tr></tbody></table>

0 commit comments

Comments
 (0)