You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -492,21 +492,23 @@ minio:
492
492
|`keep_last`|`int`|`false`| Optional (default: `0`), if exporter can delete older archives in minio.<br>- set to `1+` if you want to retain a certain number of archives<br>- `0` will result in no action done |
493
493
494
494
## Notifications
495
-
It is possible to also send notifications when an export run fails. Currently, the only supported notification service is [apprise](https://github.com/caronc/apprise).
495
+
It is possible to send notifications when an export run fails. Currently, the only supported notification service is [apprise](https://github.com/caronc/apprise). Apprise is a general purpose notification service and has a variety of integrations and includes generic HTTP POST.
496
496
497
497
### apprise
498
498
The apprise configuration is a part of the configuration yaml file and can be modified under `notifications.apprise`.
499
499
500
-
| Item | Type |Required |Description |
501
-
| ---- | ---- | --------| ----------- |
502
-
|`apprise.service_urls`|`List<str>`| Provide the apprise urls for apprise to send notifications to |
500
+
| Item | Type | Description |
501
+
| ---- | ---- | ----------- |
502
+
|`apprise.service_urls`|`List<str>`| Provide the apprise urls for apprise to send notifications to. Can also be provided as environment variable: `APPRISE_URLS`, see example further below.|
503
503
|`apprise.config_path`|`str`| If specified, overrides `apprise.service_urls`. Can specify the path to an apprise configuration file |
504
504
|`apprise.plugin_paths`|`List<str>`| Provide the plugin paths for apprise to use |
505
505
|`apprise.storage_path`|`str`| For persistent storage, specify a path for apprise to use |
506
506
|`apprise.custom_title`|`str`| Replace the default message title for apprise notifications |
507
507
|`apprise.custom_attachment_path`|`str`| To include a custom attachment to the apprise notification, specify the path to a file |
508
508
509
-
`apprise.service_urls` can contain sensitive information and can be specified as an environment variable instead, example: `export APPRISE='["json://localhost:8080/notify"]'`.
509
+
`apprise.service_urls` can contain sensitive information and can be specified as an environment variable instead as a string list, example: `export APPRISE_URLS='["json://localhost:8080/notify"]'`.
510
+
511
+
**If using apprise for notifications, one of `apprise.service_urls` or `apprise.config_path` should be specified.**
510
512
511
513
## Potential Breaking Upgrades
512
514
Below are versions that have major changes to the way configuration or exporter runs.
0 commit comments