diff --git a/NEWS b/NEWS index fd584908c..c640d134b 100644 --- a/NEWS +++ b/NEWS @@ -3,6 +3,8 @@ for hunting down that file you accidentally deleted so you can extract it. See the documentation for more information: https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/#searching-for-a-file + * #543: Add a monitoring hook for sending push notifications via ntfy. See the documentation for + more information: https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#ntfy-hook * Deprecate "borgmatic list --successful" flag, as listing only non-checkpoint (successful) archives is now the default in newer versions of Borg. diff --git a/README.md b/README.md index 24a132404..310d23af8 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,7 @@ borgmatic is powered by [Borg Backup](https://www.borgbackup.org/). Cronitor      Cronhub      PagerDuty      +ntfy      BorgBase      diff --git a/docs/how-to/monitor-your-backups.md b/docs/how-to/monitor-your-backups.md index ea9f0016d..615a5a8f3 100644 --- a/docs/how-to/monitor-your-backups.md +++ b/docs/how-to/monitor-your-backups.md @@ -38,17 +38,19 @@ below for how to configure this. borgmatic integrates with monitoring services like [Healthchecks](https://healthchecks.io/), [Cronitor](https://cronitor.io), -[Cronhub](https://cronhub.io), and [PagerDuty](https://www.pagerduty.com/) and -pings these services whenever borgmatic runs. That way, you'll receive an -alert when something goes wrong or (for certain hooks) the service doesn't -hear from borgmatic for a configured interval. See [Healthchecks +[Cronhub](https://cronhub.io), [PagerDuty](https://www.pagerduty.com/), and +[ntfy](https://ntfy.sh/) and pings these services whenever borgmatic runs. +That way, you'll receive an alert when something goes wrong or (for certain +hooks) the service doesn't hear from borgmatic for a configured interval. See +[Healthchecks hook](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#healthchecks-hook), [Cronitor hook](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#cronitor-hook), [Cronhub hook](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#cronhub-hook), -and [PagerDuty -hook](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#pagerduty-hook) +[PagerDuty +hook](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#pagerduty-hook), +and [ntfy hook](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#ntfy-hook) below for how to configure this. While these services offer different features, you probably only need to use @@ -270,9 +272,9 @@ If you have any issues with the integration, [please contact us](https://torsion.org/borgmatic/#support-and-contributing). -## Ntfy hook +## ntfy hook -[Ntfy](https://ntfy.sh) is a free, simple, service (either hosted or self-hosted) +[ntfy](https://ntfy.sh) is a free, simple, service (either hosted or self-hosted) which offers simple pub/sub push notifications to multiple platforms including [web](https://ntfy.sh/stats), [Android](https://play.google.com/store/apps/details?id=io.heckel.ntfy) and [iOS](https://apps.apple.com/us/app/ntfy/id1625396347). @@ -281,7 +283,7 @@ Since push notifications for regular events might soon become quite annoying, this hook only fires on any errors by default in order to instantly alert you to issues. The `states` list can override this. -As Ntfy is unauthenticated, it isn't a suitable channel for any private information +As ntfy is unauthenticated, it isn't a suitable channel for any private information so the default messages are intentionally generic. These can be overridden, depending on your risk assessment. Each `state` can have its own custom messages, priorities and tags or, if none are provided, will use the default. diff --git a/docs/static/ntfy.png b/docs/static/ntfy.png new file mode 100644 index 000000000..641ccfdfc Binary files /dev/null and b/docs/static/ntfy.png differ