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 -
| Name | Required | Description | Example |
|---|---|---|---|
PUID | true | Used to set the user the container should run as. | 1000 |
PGID | true | Used to set the group the container should run as. | 1000 |
APP_NAME | false | Used to define the application's name in the dashboard and in notifications. | |
APP_KEY | true | Key used to encrypt and decrypt data. See the install docs to generate a key. | |
ADMIN_NAME | false | Name of the initial admin user. Note: Only effective during initial setup. | Admin |
ADMIN_EMAIL | false | Email of the initial admin user. Note: Only effective during initial setup. | admin@example.com |
ADMIN_PASSWORD | false | Password of the initial admin user. Note: Only effective during initial setup. | password |
ALLOWED_IPS | false | Block requests to the application unless from the allowed addresses. | 127.0.0.1,127.0.0.2 |
APP_URL | false | URL used for links in emails and notifications. | https://speedtest.example.com |
ASSET_URL | false | URL used for assets, needed when using a reverse proxy. | https://speedtest.example.com |
APP_LOCALE | false | Change the default langugage. | |
APP_TIMEZONE | false | Application timezone should be set if your database does not use UTC as its default timezone. | Europe/London |
CHART_BEGIN_AT_ZERO | false | Begin the dashboard axis charts at zero. - Default: true | true or false |
CHART_DATETIME_FORMAT | false | Set 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_FORMAT | false | Set 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_TIMEZONE | false | Display timestamps in your local time. | America/New_York |
CONTENT_WIDTH | false | Width of the content section of each page. Can be set to any value found in the Filament docs. - Default: 7xl | |
PUBLIC_DASHBOARD | false | Enables the public dashboard for guest (unauthenticated) users. - Default: false | |
DEFAULT_CHART_RANGE | false | Set the default time range for the dashboards - Default: 24h- Values: 24h, week, month | week |
| Name | Required | Description | Example |
|---|---|---|---|
PUID | true | Used to set the user the container should run as. | 1000 |
PGID | true | Used to set the group the container should run as. | 1000 |
APP_NAME | false | Used to define the application's name in the dashboard and in notifications. | |
APP_KEY | true | Key used to encrypt and decrypt data. See the install docs to generate a key. | |
ADMIN_NAME | false | Name of the initial admin user. Note: Only effective during initial setup. | Admin |
ADMIN_EMAIL | false | Email of the initial admin user. Note: Only effective during initial setup. | admin@example.com |
ADMIN_PASSWORD | false | Password of the initial admin user. Note: Only effective during initial setup. | password |
ALLOWED_IPS | false | Block requests to the application unless from the allowed addresses. | 127.0.0.1,127.0.0.2 |
APP_URL | false | URL used for links in emails and notifications. | https://speedtest.example.com |
ASSET_URL | false | URL used for assets, needed when using a reverse proxy. | https://speedtest.example.com |
APP_LOCALE | false | Change the default langugage. | |
APP_TIMEZONE | false | Application timezone should be set if your database does not use UTC as its default timezone. | Europe/London |
APPRISE_URL | false | URL of the Apprise sidecar container for notifications. | http://192.168.1.5:8000 |
CHART_BEGIN_AT_ZERO | false | Begin the dashboard axis charts at zero. - Default: true | true or false |
CHART_DATETIME_FORMAT | false | Set 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_FORMAT | false | Set 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_TIMEZONE | false | Display timestamps in your local time. | America/New_York |
CONTENT_WIDTH | false | Width of the content section of each page. Can be set to any value found in the Filament docs. - Default: 7xl | |
PUBLIC_DASHBOARD | false | Enables the public dashboard for guest (unauthenticated) users. - Default: false | |
DEFAULT_CHART_RANGE | false | Set the default time range for the dashboards - Default: 24h- Values: 24h, week, month | week |
| Name | Required | Description | Example |
|---|---|---|---|
API_RATE_LIMIT | false | Number of requests per minute to the API. - Default: 60 | 100 |
API_MAX_RESULTS | false | Sets the maximum number of results returned by API. - Default 500 | 500 |
| Name | Required | Description | Example |
|---|---|---|---|
API_RATE_LIMIT | false | Number of requests per minute to the API. - Default: 60 | 100 |
API_MAX_RESULTS | false | Sets the maximum number of results returned by API. - Default 500 | 500 |

Apprise settings

Apprise Settings
| Name | Description |
|---|---|
| URL | This is the URL of your running Apprise API instance |
| Service URL | This 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. |
| 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. |