Browse Source

Add links in documentation for ntfy monitoring hook (#543).

Dan Helfman 3 years ago
parent
commit
0e90a80680
4 changed files with 14 additions and 9 deletions
  1. 2 0
      NEWS
  2. 1 0
      README.md
  3. 11 9
      docs/how-to/monitor-your-backups.md
  4. BIN
      docs/static/ntfy.png

+ 2 - 0
NEWS

@@ -3,6 +3,8 @@
    for hunting down that file you accidentally deleted so you can extract it. See the documentation
    for hunting down that file you accidentally deleted so you can extract it. See the documentation
    for more information:
    for more information:
    https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/#searching-for-a-file
    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)
  * Deprecate "borgmatic list --successful" flag, as listing only non-checkpoint (successful)
    archives is now the default in newer versions of Borg.
    archives is now the default in newer versions of Borg.
 
 

+ 1 - 0
README.md

@@ -71,6 +71,7 @@ borgmatic is powered by [Borg Backup](https://www.borgbackup.org/).
 <a href="https://cronitor.io/"><img src="docs/static/cronitor.png" alt="Cronitor" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 <a href="https://cronitor.io/"><img src="docs/static/cronitor.png" alt="Cronitor" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 <a href="https://cronhub.io/"><img src="docs/static/cronhub.png" alt="Cronhub" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 <a href="https://cronhub.io/"><img src="docs/static/cronhub.png" alt="Cronhub" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 <a href="https://www.pagerduty.com/"><img src="docs/static/pagerduty.png" alt="PagerDuty" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 <a href="https://www.pagerduty.com/"><img src="docs/static/pagerduty.png" alt="PagerDuty" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+<a href="https://ntfy.sh/"><img src="docs/static/ntfy.png" alt="ntfy" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 <a href="https://www.borgbase.com/?utm_source=borgmatic"><img src="docs/static/borgbase.png" alt="BorgBase" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 <a href="https://www.borgbase.com/?utm_source=borgmatic"><img src="docs/static/borgbase.png" alt="BorgBase" height="60px" style="margin-bottom:20px;"></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
 
 
 

+ 11 - 9
docs/how-to/monitor-your-backups.md

@@ -38,17 +38,19 @@ below for how to configure this.
 
 
 borgmatic integrates with monitoring services like
 borgmatic integrates with monitoring services like
 [Healthchecks](https://healthchecks.io/), [Cronitor](https://cronitor.io),
 [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),
 hook](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#healthchecks-hook),
 [Cronitor
 [Cronitor
 hook](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#cronitor-hook),
 hook](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#cronitor-hook),
 [Cronhub
 [Cronhub
 hook](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#cronhub-hook),
 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.
 below for how to configure this.
 
 
 While these services offer different features, you probably only need to use
 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).
 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
 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)
 [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).
 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.
 this hook only fires on any errors by default in order to instantly alert you to issues.
 The `states` list can override this.
 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
 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
 on your risk assessment. Each `state` can have its own custom messages, priorities and tags
 or, if none are provided, will use the default.
 or, if none are provided, will use the default.

BIN
docs/static/ntfy.png