summaryrefslogtreecommitdiffstats
path: root/health/notifications/ntfy
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-08-10 09:18:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-08-10 09:18:49 +0000
commitdd814a7c1a8de056a79f7238578b09236edd5506 (patch)
tree429e7eed5a634a4efe9a6877ce66da8e64aa1782 /health/notifications/ntfy
parentAdding upstream version 1.41.0. (diff)
downloadnetdata-dd814a7c1a8de056a79f7238578b09236edd5506.tar.xz
netdata-dd814a7c1a8de056a79f7238578b09236edd5506.zip
Adding upstream version 1.42.0.upstream/1.42.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'health/notifications/ntfy')
-rw-r--r--health/notifications/ntfy/metadata.yaml70
1 files changed, 70 insertions, 0 deletions
diff --git a/health/notifications/ntfy/metadata.yaml b/health/notifications/ntfy/metadata.yaml
new file mode 100644
index 000000000..cde57fd4d
--- /dev/null
+++ b/health/notifications/ntfy/metadata.yaml
@@ -0,0 +1,70 @@
+# yamllint disable rule:line-length
+---
+- id: 'notify-ntfy'
+ meta:
+ name: 'ntfy'
+ link: 'https://ntfy.sh/'
+ categories:
+ - notify.agent
+ icon_filename: 'ntfy.svg'
+ keywords:
+ - ntfy
+ overview:
+ notification_description: |
+ [ntfy](https://ntfy.sh/) (pronounce: notify) is a simple HTTP-based [pub-sub](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern) notification service. It allows you to send notifications to your phone or desktop via scripts from any computer, entirely without signup, cost or setup. It's also [open source](https://github.com/binwiederhier/ntfy) if you want to run your own server.
+ You can send alerts to an ntfy server using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more.
+ notification_limitations: ''
+ setup:
+ prerequisites:
+ list:
+ - title: ''
+ description: |
+ - (Optional) A [self-hosted ntfy server](https://docs.ntfy.sh/faq/#can-i-self-host-it), in case you don't want to use https://ntfy.sh
+ - A new [topic](https://ntfy.sh/#subscribe) for the notifications to be published to
+ - Access to the terminal where Netdata Agent is running
+ configuration:
+ file:
+ name: 'health_alarm_notify.conf'
+ options:
+ description: 'The following options can be defined for this notification'
+ folding:
+ title: 'Config Options'
+ enabled: true
+ list:
+ - name: 'SEND_NTFY'
+ default_value: 'YES'
+ description: "Set `SEND_NTFY` to YES"
+ required: true
+ - name: 'DEFAULT_RECIPIENT_NTFY'
+ default_value: ''
+ description: "URL formed by the server-topic combination you want the alert notifications to be sent to. Unless hosting your own server, the server should always be set to https://ntfy.sh."
+ required: true
+ detailed_description: |
+ You can define multiple recipient URLs like this: `https://SERVER1/TOPIC1` `https://SERVER2/TOPIC2`
+
+ All roles will default to this variable if left unconfigured.
+
+ You can then have different servers and/or topics per role, by editing DEFAULT_RECIPIENT_NTFY with the server-topic combination you want, in the following entries at the bottom of the same file:
+ ```conf
+ role_recipients_ntfy[sysadmin]="https://SERVER1/TOPIC1"
+ role_recipients_ntfy[domainadmin]="https://SERVER2/TOPIC2"
+ role_recipients_ntfy[dba]="https://SERVER3/TOPIC3"
+ role_recipients_ntfy[webmaster]="https://SERVER4/TOPIC4"
+ role_recipients_ntfy[proxyadmin]="https://SERVER5/TOPIC5"
+ role_recipients_ntfy[sitemgr]="https://SERVER6/TOPIC6"
+ ```
+ examples:
+ folding:
+ enabled: true
+ title: ''
+ list:
+ - name: 'Basic Configuration'
+ folding:
+ enabled: false
+ description: ''
+ config: |
+ SEND_NTFY="YES"
+ DEFAULT_RECIPIENT_NTFY="https://ntfy.sh/netdata-X7seHg7d3Tw9zGOk https://ntfy.sh/netdata-oIPm4IK1IlUtlA30"
+ troubleshooting:
+ problems:
+ list: []