GitBook: [alexjustesen#25] No subject

Author: alexjustesen

.gitbook/assets/telegram_notification.png

@@ -9,7 +9,7 @@ description: >-
 
 
 {% hint style="info" %}
-These docs are up-to-date for version: `0.9.0`
+These docs are up-to-date for version: `v0.11.0`
 {% endhint %}
 
 ### Introduction

README.md

@@ -15,6 +15,7 @@
 * [Notifications](settings/notifications/README.md)
   * [Database](settings/notifications/database.md)
   * [Mail](settings/notifications/mail.md)
+  * [Telegram](settings/notifications/mail-1.md)
 
 ## 🤹 Contributing
 

SUMMARY.md

@@ -17,7 +17,10 @@ description: A full list of implemented features and those that are planned.
 | **Dashboard**                                                                                                                   |                                                                               |
 |     Show the most recent results                                                                                                |                                                                          Done |
 |     Pretty graphs                                                                                                               |            [Done](https://github.com/alexjustesen/speedtest-tracker/pull/213) |
-|     History of results                                                                                                          |                                                                          Done |
+|                                                                                                                                 |                                                                               |
+| **Results**                                                                                                                     |                                                                               |
+|     History of failed and successful results                                                                                    |                                                                          Done |
+|     Filter by `scheduled` and \`successful                                                                                      |            [Done](https://github.com/alexjustesen/speedtest-tracker/pull/318) |
 |                                                                                                                                 |                                                                               |
 | **Speedtest options**                                                                                                           |                                                                               |
 |     Scheduled tests                                                                                                             |                                                                          Done |
@@ -43,7 +46,7 @@ description: A full list of implemented features and those that are planned.
 |     Discord                                                                                                                     |                                                                       Planned |
 |     Gotify                                                                                                                      |                                                                       Planned |
 |     Slack                                                                                                                       |                                                                       Planned |
-|     Telegram                                                                                                                    |                                                                       Planned |
+|     Telegram                                                                                                                    |            [Done](https://github.com/alexjustesen/speedtest-tracker/pull/265) |
 |                                                                                                                                 |                                                                               |
 | **Application Monitoring**                                                                                                      |                                                                               |
 |     [https://ohdear.app/](https://ohdear.app/)                                                                                  |                                                                       Planned |

getting-started/features.md

@@ -9,5 +9,5 @@ Speedtest Tracker uses Filament for the admin panel. During the install process
 | `[email protected]` | `password` |
 
 {% hint style="info" %}
-A process for changing the admin account's email address and password is planned.
+As of v0.11.0 you can add additional users and change the admin account's name, email and password.
 {% endhint %}

settings/authentication.md

@@ -0,0 +1,25 @@
+# Telegram
+
+Notifications sent to the Telegram channel will be sent to the list of recipients.
+
+<figure><img src="../../.gitbook/assets/telegram_notification.png" alt=""><figcaption><p>Telegram settings</p></figcaption></figure>
+
+### Setting Up Telegram
+
+To configure Telegram for notifications you'll need to have a [Telegram](https://telegram.org/) account and follow the directions below.
+
+1. Create a Telegram bot by starting a message with `@BotFather`.
+2. Using the bot's token ID to add the following variable in your `.env` file in your mounted data directory. `TELEGRAM_BOT_TOKEN=putyourtokenhere`
+3. Next you'll need your own chat ID, start a chat with `@Get_Id_Bot` and add that to your "Recipients" list and click "Save".
+4. Start a chat with your bot your created in step 1 to start receiving notification from yout Telegram bot.
+
+### Triggers
+
+| Name                          | Description                                                                       |
+| ----------------------------- | --------------------------------------------------------------------------------- |
+| On completed speedtest        | On each successful speedtest a notification will be send to the application.      |
+| On absolute threshold failure | On any absolute threshold failure a notification will be send to the application. |
+
+### Recipients
+
+A recipient is any valid Telegram chat ID, you can add one or many recipients that will receive notifications based on the triggers selected.

settings/notifications/mail-1.md

@@ -6,7 +6,7 @@ Notifications sent to the mail channel will be emailed to the list of recipients
 
 ### Setting Up SMTP
 
-Speedtest Tracker uses SMTP maill protocol to send email messages, you can use any service that allows you to send emails via SMTP. 
+Speedtest Tracker uses SMTP mail protocol to send email messages, you can use any service that allows you to send emails via SMTP. 
 
 To configure the mail server settings you'll need to update the following variables in your `.env` file in your mounted data directory.