Skip to content

Commit 6f17715

Browse files
alexjustesengitbook-bot
alexjustesen
authored and
gitbook-bot
committed
GitBook: [alexjustesen#17] No subject
1 parent 3c383fc commit 6f17715

File tree

6 files changed

+79
-54
lines changed

6 files changed

+79
-54
lines changed

‎.gitbook/assets/influxdb2_settings.png‎

18.6 KB
Loading

‎SUMMARY.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
* [Notifications](getting-started/notifications/README.md)
1111
* [Database](getting-started/notifications/database.md)
1212
* [Mail](getting-started/notifications/mail.md)
13+
* [Data Platforms](getting-started/data-platforms/README.md)
14+
* [InfluxDB2](getting-started/data-platforms/influxdb2.md)
1315

1416
## 🤹 Contributing
1517

‎getting-started/data-platforms/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Data Platforms
2+
3+
Speedtest Tracker supports reporting data to InfluxDB2, a time series database. Additional data platforms are planned and listed on the [Features](../features.md) page.

‎getting-started/data-platforms/influxdb2.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# InfluxDB2
2+
3+
{% hint style="info" %}
4+
At this time only InfluxDB2 is supported, InfluxDB(1) is planned
5+
{% endhint %}
6+
7+
<figure><img src="../../.gitbook/assets/influxdb2_settings.png" alt=""><figcaption><p>InfluxDB2 settings</p></figcaption></figure>
8+
9+
### Settings
10+
11+
| Name | Default | Description |
12+
| ------ | ------------------- | --------------------------------------------------------------------- |
13+
| URL | `blank` | FQDM or IP address to the InfluxDB2 instance |
14+
| Org | `blank` | Organization on which you created your bucket in |
15+
| Bucket | `speedtest-tracker` | The name of the bucket you created in your org |
16+
| Token | `blank` | API token that has access to write to the org and bucket listed above |

‎getting-started/features.md‎

Lines changed: 47 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -6,50 +6,50 @@ description: A full list of implemented features and those that are planned.
66

77
<figure><img src="https://github.com/alexjustesen/speedtest-tracker/blob/main/.github/screenshots/dashboard_screenshot.png?raw=true" alt=""><figcaption><p><em>Dashboard</em></p></figcaption></figure>
88

9-
| Features | Status |
10-
| ------------------------------------------------------------------------------------------------------------------------------- | ------: |
11-
| **Install options** | |
12-
| Docker images for x86 | Done |
13-
| Docker images for arm64 | Done |
14-
| unRAID Community App | Done |
15-
| Bare metal | Planned |
16-
| | |
17-
| **Dashboard** | |
18-
| Show the most recent results | Done |
19-
| Pretty graphs | Planned |
20-
| History of results | Done |
21-
| | |
22-
| **Speedtest options** | |
23-
| Scheduled tests | Done |
24-
| Adhoc test | Done |
25-
| Manually specify a server | Done |
26-
| Manually specify a list of servers | Planned |
27-
| Threshold alerts | Done |
28-
| | |
29-
| **Ping options** | |
30-
| Ping a domain or list of domains | Planned |
31-
| | |
32-
| **Database support** | |
33-
| SQLite (default) | Done |
34-
| MariaDB / MySQL | Done |
35-
| Postgresql | Done |
36-
| InfluxDB v1 | Planned |
37-
| InfluxDB v2 | Done |
38-
| Prometheus | Planned |
39-
| | |
40-
| **Notification Channels** | |
41-
| In-app | Done |
42-
| Mail | Planned |
43-
| Discord | Planned |
44-
| Gotify | Planned |
45-
| Slack | Planned |
46-
| Telegram | Planned |
47-
| | |
48-
| **Application Monitoring** | |
49-
| [https://ohdear.app/](https://ohdear.app/) | Planned |
50-
| [https://thenping.me/](https://thenping.me/) | Planned |
51-
| [https://healthchecks.io/](https://healthchecks.io/) | Planned |
52-
| | |
53-
| **Other** | |
54-
| Backup / Restore | Planned |
55-
| Import data from [https://github.com/henrywhitaker3/Speedtest-Tracker](https://github.com/henrywhitaker3/Speedtest-Tracker) | Planned |
9+
| Features | Status |
10+
| ------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------: |
11+
| **Install options** | |
12+
| Docker images for x86 | Done |
13+
| Docker images for arm64 | Done |
14+
| unRAID Community App | Done |
15+
| Bare metal | Planned |
16+
| | |
17+
| **Dashboard** | |
18+
| Show the most recent results | Done |
19+
| Pretty graphs | Planned |
20+
| History of results | Done |
21+
| | |
22+
| **Speedtest options** | |
23+
| Scheduled tests | Done |
24+
| Adhoc test | Done |
25+
| Manually specify a server | Done |
26+
| Manually specify a list of servers | Planned |
27+
| Threshold alerts | Done |
28+
| | |
29+
| **Ping options** | |
30+
| Ping a domain or list of domains | Planned |
31+
| | |
32+
| **Database support** | |
33+
| SQLite (default) | Done |
34+
| MariaDB / MySQL | Done |
35+
| Postgresql | Done |
36+
| InfluxDB v1 | Planned |
37+
| InfluxDB v2 | Done |
38+
| Prometheus | Planned |
39+
| | |
40+
| **Notification Channels** | |
41+
| In-app | [Done](https://github.com/alexjustesen/speedtest-tracker/releases/tag/v0.1.0) |
42+
| Mail | [Done](https://github.com/alexjustesen/speedtest-tracker/releases/tag/v0.4.0) |
43+
| Discord | Planned |
44+
| Gotify | Planned |
45+
| Slack | Planned |
46+
| Telegram | Planned |
47+
| | |
48+
| **Application Monitoring** | |
49+
| [https://ohdear.app/](https://ohdear.app/) | Planned |
50+
| [https://thenping.me/](https://thenping.me/) | Planned |
51+
| [https://healthchecks.io/](https://healthchecks.io/) | Planned |
52+
| | |
53+
| **Other** | |
54+
| Backup / Restore | Planned |
55+
| Import data from [https://github.com/henrywhitaker3/Speedtest-Tracker](https://github.com/henrywhitaker3/Speedtest-Tracker) | Planned |

‎getting-started/notifications/mail.md‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,6 @@ Notifications sent to the mail channel will be emailed to the list of recipients
44

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

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-
147
### Setting Up SMTP
158

169
Speedtest Tracker uses SMTP maill protocol to send email messages, you can use any service that allows you to send emails via SMTP.&#x20;
@@ -25,3 +18,14 @@ MAIL_PASSWORD=null
2518
MAIL_ENCRYPTION=null
2619
MAIL_FROM_ADDRESS="[email protected]"
2720
```
21+
22+
### Triggers
23+
24+
| Name | Description |
25+
| ----------------------------- | --------------------------------------------------------------------------------- |
26+
| On completed speedtest | On each successful speedtest a notification will be send to the application. |
27+
| On absolute threshold failure | On any absolute threshold failure a notification will be send to the application. |
28+
29+
### Recipients
30+
31+
A recipient is any valid email address, you can add one or many recipients that will receive notifications based on the triggers selected.

0 commit comments

Comments
 (0)