File tree Expand file tree Collapse file tree 7 files changed +46
-1
lines changed
getting-started/notifications Expand file tree Collapse file tree 7 files changed +46
-1
lines changed Original file line number Diff line number Diff line change @@ -7,7 +7,7 @@ description: >-
77# 🐇 Speedtest Tracker
88
99{% hint style="info" %}
10- These docs are up-to-date for version ` 0.1 .0 `
10+ These docs are up-to-date for version: ` 0.4 .0 `
1111{% endhint %}
1212
1313### Introduction
Original file line number Diff line number Diff line change 77* [ Installation] ( getting-started/installation.md )
88* [ Features] ( getting-started/features.md )
99* [ Authentication] ( getting-started/authentication.md )
10+ * [ Notifications] ( getting-started/notifications/README.md )
11+ * [ Database] ( getting-started/notifications/database.md )
12+ * [ Mail] ( getting-started/notifications/mail.md )
1013
1114## 🤹 Contributing
1215
1518## 🔗 More
1619
1720* [ Source Code] ( https://github.com/alexjustesen/speedtest-tracker )
21+ * [ Releases] ( https://github.com/alexjustesen/speedtest-tracker/releases )
1822* [ Update the Docs] ( https://github.com/alexjustesen/speedtest-tracker-docs )
1923* [ About Me] ( https://alexjustesen.com/?utm\_ campaign=oss-projects\& utm\_ source=speedtest-tracker-docs\& utm\_ medium=textlink )
2024* [ Donate] ( https://github.com/sponsors/alexjustesen )
Original file line number Diff line number Diff line change 1+ # Notifications
2+
Original file line number Diff line number Diff line change 1+ # Database
2+
3+ Notifications sent to the database channel will show up under the 🔔 icon in the header of the application.
4+
5+ <figure ><img src =" ../../.gitbook/assets/db_notification.png " alt =" " ><figcaption ><p >Database settings</p ></figcaption ></figure >
6+
7+ ### Triggers
8+
9+ | Name | Description |
10+ | ----------------------------- | --------------------------------------------------------------------------------- |
11+ | On completed speedtest | On each successful speedtest a notification will be send to the application. |
12+ | On absolute threshold failure | On any absolute threshold failure a notification will be send to the application. |
Original file line number Diff line number Diff line change 1+ # Mail
2+
3+ Notifications sent to the mail channel will be emailed to the list of recipients.
4+
5+ <figure ><img src =" ../../.gitbook/assets/mail_notification.png " alt =" " ><figcaption ><p >Mail settings</p ></figcaption ></figure >
6+
7+ ### Triggers
8+
9+ | Name | Description |
10+ | ----------------------------- | --------------------------------------------------------------------------------- |
11+ | On completed speedtest | On each successful speedtest a notification will be send to the application. |
12+ | On absolute threshold failure | On any absolute threshold failure a notification will be send to the application. |
13+
14+ ### Setting Up SMTP
15+
16+ Speedtest Tracker uses SMTP maill protocol to send email messages, you can use any service that allows you to send emails via SMTP.  ;
17+
18+ To configure the mail server settings you'll need to update the following variables in your ` .env ` file in your mounted data directory.
19+
20+ ```
21+ MAIL_HOST=mailhog
22+ MAIL_PORT=1025
23+ MAIL_USERNAME=null
24+ MAIL_PASSWORD=null
25+ MAIL_ENCRYPTION=null
26+ MAIL_FROM_ADDRESS="[email protected] " 27+ ```
You can’t perform that action at this time.
0 commit comments