From b5f8ee61a7f7e9bd291dd26b0585d03eb686c941 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 5 May 2024 13:19:16 +0200 Subject: Adding upstream version 1.46.3. Signed-off-by: Daniel Baumann --- health/notifications/gotify/README.md | 98 ----------------------------------- 1 file changed, 98 deletions(-) delete mode 100644 health/notifications/gotify/README.md (limited to 'health/notifications/gotify/README.md') diff --git a/health/notifications/gotify/README.md b/health/notifications/gotify/README.md deleted file mode 100644 index 404de4d80..000000000 --- a/health/notifications/gotify/README.md +++ /dev/null @@ -1,98 +0,0 @@ - - -# Gotify - - - - - -[Gotify](https://gotify.net/) is a self-hosted push notification service created for sending and receiving messages in real time. -You can send alerts to your Gotify instance using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more. - - - - - -## Setup - -### Prerequisites - -#### - -- An application token. You can generate a new token in the Gotify Web UI. -- Access to the terminal where Netdata Agent is running - - - -### Configuration - -#### File - -The configuration file name for this integration is `health_alarm_notify.conf`. - - -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory). - -```bash -cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata -sudo ./edit-config health_alarm_notify.conf -``` -#### Options - -The following options can be defined for this notification - -
Config Options - -| Name | Description | Default | Required | -|:----|:-----------|:-------|:--------:| -| SEND_GOTIFY | Set `SEND_GOTIFY` to YES | YES | yes | -| GOTIFY_APP_TOKEN | set `GOTIFY_APP_TOKEN` to the app token you generated. | | yes | -| GOTIFY_APP_URL | Set `GOTIFY_APP_URL` to point to your Gotify instance, for example `https://push.example.domain/` | | yes | - -
- -#### Examples - -##### Basic Configuration - - - -```yaml -SEND_GOTIFY="YES" -GOTIFY_APP_TOKEN="XXXXXXXXXXXXXXX" -GOTIFY_APP_URL="https://push.example.domain/" - -``` - - -## Troubleshooting - -### Test Notification - -You can run the following command by hand, to test alerts configuration: - -```bash -# become user netdata -sudo su -s /bin/bash netdata - -# enable debugging info on the console -export NETDATA_ALARM_NOTIFY_DEBUG=1 - -# send test alarms to sysadmin -/usr/libexec/netdata/plugins.d/alarm-notify.sh test - -# send test alarms to any role -/usr/libexec/netdata/plugins.d/alarm-notify.sh test "ROLE" -``` - -Note that this will test _all_ alert mechanisms for the selected role. - - -- cgit v1.2.3