Skip to content

Commit f6f4929

Browse files
committed
new notification feature description updates
1 parent b813252 commit f6f4929

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ Table of Contents
1717
- [Modify Markdown Files](#modify-markdown-files)
1818
- [Object Storage](#object-storage)
1919
- [Minio Backups](#minio-backups)
20+
- [Notifications](#notifications)
21+
- [apprise](#apprise)
2022
- [Potential Breaking Upgrades](#potential-breaking-upgrades)
2123
- [Future Items](#future-items)
2224

@@ -251,6 +253,15 @@ assets:
251253
export_meta: false
252254
keep_last: 5
253255
run_interval: 0
256+
notifications:
257+
apprise:
258+
service_urls:
259+
- "json://localhost:8080/notify"
260+
config_path: ""
261+
plugin_paths: []
262+
storage_path: ""
263+
custom_title: ""
264+
custom_attachment_path: ""
254265
```
255266

256267
#### Options and Descriptions
@@ -480,6 +491,23 @@ minio:
480491
| `path` | `str` | `false` | Optional, path of the backup to use. Will use root bucket path if not set. `<bucket_name>:/<path>/bookstack-<timestamp>.tgz` |
481492
| `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 |
482493

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).
496+
497+
### apprise
498+
The apprise configuration is a part of the configuration yaml file and can be modified under `notifications.apprise`.
499+
500+
| Item | Type | Required | Description |
501+
| ---- | ---- | -------- | ----------- |
502+
| `apprise.service_urls` | `List<str>` | Provide the apprise urls for apprise to send notifications to |
503+
| `apprise.config_path` | `str` | If specified, overrides `apprise.service_urls`. Can specify the path to an apprise configuration file |
504+
| `apprise.plugin_paths` | `List<str>` | Provide the plugin paths for apprise to use |
505+
| `apprise.storage_path` | `str` | For persistent storage, specify a path for apprise to use |
506+
| `apprise.custom_title` | `str` | Replace the default message title for apprise notifications |
507+
| `apprise.custom_attachment_path` | `str` | To include a custom attachment to the apprise notification, specify the path to a file |
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"]'`.
510+
483511
## Potential Breaking Upgrades
484512
Below are versions that have major changes to the way configuration or exporter runs.
485513

0 commit comments

Comments
 (0)