Clarify Apprise states configuration.
All checks were successful
build / test (push) Successful in 6m2s
build / docs (push) Successful in 1m29s

This commit is contained in:
Dan Helfman 2024-04-20 08:26:06 -07:00
parent cb2fd7c5e8
commit 54facdc391

View File

@ -435,11 +435,16 @@ apprise:
label: gotify label: gotify
- url: mastodons://access_key@hostname/@user - url: mastodons://access_key@hostname/@user
label: mastodon label: mastodon
states:
- start
- finish
- fail
``` ```
With this configuration, borgmatic pings each of the configured Apprise With this configuration, borgmatic pings each of the configured Apprise
services when a backup begins, ends, or errors, but only when any of the services when a backup begins, ends, or errors, but only when any of the
`prune`, `compact`, `create`, or `check` actions are run. `prune`, `compact`, `create`, or `check` actions are run. (By default, if
`states` is not specified, Apprise services are only pinged on error.)
You can optionally customize the contents of the default messages sent to You can optionally customize the contents of the default messages sent to
these services: these services: