diff --git a/.gitbook/assets/apprise_notifiations.png b/.gitbook/assets/apprise_notifiations.png new file mode 100644 index 0000000..3586151 Binary files /dev/null and b/.gitbook/assets/apprise_notifiations.png differ diff --git a/.gitbook/assets/db_notification.png b/.gitbook/assets/db_notification.png index 05b928c..51e4170 100644 Binary files a/.gitbook/assets/db_notification.png and b/.gitbook/assets/db_notification.png differ diff --git a/.gitbook/assets/mail_notification.png b/.gitbook/assets/mail_notification.png index 2e69842..035621a 100644 Binary files a/.gitbook/assets/mail_notification.png and b/.gitbook/assets/mail_notification.png differ diff --git a/.gitbook/assets/webhook_notification.png b/.gitbook/assets/webhook_notification.png index 8fad263..e01c405 100644 Binary files a/.gitbook/assets/webhook_notification.png and b/.gitbook/assets/webhook_notification.png differ diff --git a/SUMMARY.md b/SUMMARY.md index 7e69673..08d820c 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -32,6 +32,7 @@ * [Data Integrations](settings/data-platforms/README.md) * [InfluxDB v2](settings/data-platforms/influxdb2.md) * [Notifications](settings/notifications/README.md) + * [Apprise](settings/notifications/apprise.md) * [Database](settings/notifications/database.md) * [Mail](settings/notifications/mail.md) * [Webhook](settings/notifications/webhook.md) diff --git a/getting-started/environment-variables.md b/getting-started/environment-variables.md index a8cd0d5..cb9562d 100644 --- a/getting-started/environment-variables.md +++ b/getting-started/environment-variables.md @@ -8,7 +8,7 @@ description: >- ### Application -
NameRequiredDescriptionExample
PUIDtrueUsed to set the user the container should run as.1000
PGIDtrueUsed to set the group the container should run as.1000
APP_NAMEfalseUsed to define the application's name in the dashboard and in notifications.
APP_KEYtrueKey used to encrypt and decrypt data. See the install docs to generate a key.
ADMIN_NAMEfalseName of the initial admin user.
Note: Only effective during initial setup.
Admin
ADMIN_EMAILfalseEmail of the initial admin user.
Note: Only effective during initial setup.
admin@example.com
ADMIN_PASSWORDfalsePassword of the initial admin user.
Note: Only effective during initial setup.
password
ALLOWED_IPSfalseBlock requests to the application unless from the allowed addresses.127.0.0.1,127.0.0.2
APP_URLfalseURL used for links in emails and notifications.https://speedtest.example.com
ASSET_URLfalseURL used for assets, needed when using a reverse proxy.https://speedtest.example.com
APP_LOCALEfalseChange the default langugage.
APP_TIMEZONEfalseApplication timezone should be set if your database does not use UTC as its default timezone.Europe/London
CHART_BEGIN_AT_ZEROfalseBegin the dashboard axis charts at zero.

- Default: true
true or false
CHART_DATETIME_FORMATfalseSet the formatting of timestamps in charts.

Formatting: https://www.php.net/manual/en/datetime.format.php
j/m G:i
(18/10 20:06)
DATETIME_FORMATfalseSet the formatting of timestamps in tables and notifications.

Formatting: https://www.php.net/manual/en/datetime.format.php
j M Y, G:i:s
(18 Oct 2024, 20:06:01)
DISPLAY_TIMEZONEfalseDisplay timestamps in your local time.America/New_York
CONTENT_WIDTHfalseWidth of the content section of each page. Can be set to any value found in the Filament docs.

- Default:7xl
PUBLIC_DASHBOARDfalseEnables the public dashboard for guest (unauthenticated) users.

- Default:false
DEFAULT_CHART_RANGEfalseSet the default time range for the dashboards

- Default:24h
- Values:24h, week, month
week
+
NameRequiredDescriptionExample
PUIDtrueUsed to set the user the container should run as.1000
PGIDtrueUsed to set the group the container should run as.1000
APP_NAMEfalseUsed to define the application's name in the dashboard and in notifications.
APP_KEYtrueKey used to encrypt and decrypt data. See the install docs to generate a key.
ADMIN_NAMEfalseName of the initial admin user.
Note: Only effective during initial setup.
Admin
ADMIN_EMAILfalseEmail of the initial admin user.
Note: Only effective during initial setup.
admin@example.com
ADMIN_PASSWORDfalsePassword of the initial admin user.
Note: Only effective during initial setup.
password
ALLOWED_IPSfalseBlock requests to the application unless from the allowed addresses.127.0.0.1,127.0.0.2
APP_URLfalseURL used for links in emails and notifications.https://speedtest.example.com
ASSET_URLfalseURL used for assets, needed when using a reverse proxy.https://speedtest.example.com
APP_LOCALEfalseChange the default langugage.
APP_TIMEZONEfalseApplication timezone should be set if your database does not use UTC as its default timezone.Europe/London
APPRISE_URLfalseURL of the Apprise sidecar container for notifications.http://192.168.1.5:8000
CHART_BEGIN_AT_ZEROfalseBegin the dashboard axis charts at zero.

- Default: true
true or false
CHART_DATETIME_FORMATfalseSet the formatting of timestamps in charts.

Formatting: https://www.php.net/manual/en/datetime.format.php
j/m G:i
(18/10 20:06)
DATETIME_FORMATfalseSet the formatting of timestamps in tables and notifications.

Formatting: https://www.php.net/manual/en/datetime.format.php
j M Y, G:i:s
(18 Oct 2024, 20:06:01)
DISPLAY_TIMEZONEfalseDisplay timestamps in your local time.America/New_York
CONTENT_WIDTHfalseWidth of the content section of each page. Can be set to any value found in the Filament docs.

- Default:7xl
PUBLIC_DASHBOARDfalseEnables the public dashboard for guest (unauthenticated) users.

- Default:false
DEFAULT_CHART_RANGEfalseSet the default time range for the dashboards

- Default:24h
- Values:24h, week, month
week
*** @@ -20,5 +20,4 @@ description: >- ### API -
NameRequiredDescriptionExample
API_RATE_LIMITfalseNumber of requests per minute to the API.

- Default: 60
100
API_MAX_RESULTSfalseSets the maximum number of results returned by API.

- Default 500
500
- +
NameRequiredDescriptionExample
API_RATE_LIMITfalseNumber of requests per minute to the API.

- Default: 60
100
API_MAX_RESULTSfalseSets the maximum number of results returned by API.

- Default 500
500
diff --git a/settings/notifications/apprise.md b/settings/notifications/apprise.md index f5d7c98..69a0b88 100644 --- a/settings/notifications/apprise.md +++ b/settings/notifications/apprise.md @@ -1,22 +1,17 @@ ---- -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 provides a unified notification channel that lets you send alerts to numerous services—like Discord, Pushover, and Ntfy as well as many additional platforms + +

Apprise settings

-Apprise allows you to easily deliver alerts to popular platforms such as Discord, Slack, Telegram and many more. +### Apprise Server -{% 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 %} +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. -

Apprise Settings

+### Apprise Channels -
NameDescription
URLThis is the URL of your running Apprise API instance
Service URLThis 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 Apprise notification services documentation.
+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. ### Triggers
NameDescription
On completed speedtestOn each successful speedtest a notification will be send to the application.
On absolute threshold failureOn any absolute threshold failure a notification will be send to the application.
-