Clarify Apprise states configuration.

2024-04-20 08:26:06 -07:00 · 2024-04-20 08:26:06 -07:00 · 54facdc391
parent cb2fd7c5e8
commit 54facdc391
1 changed files with 6 additions and 1 deletions
--- a/docs/how-to/monitor-your-backups.md
+++ b/docs/how-to/monitor-your-backups.md
@ -435,11 +435,16 @@ apprise:
          label: gotify
        - url: mastodons://access_key@hostname/@user
          label: mastodon
+    states:
+        - start
+        - finish
+        - fail
 ```

 With this configuration, borgmatic pings each of the configured Apprise
 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
 these services: