diff options
Diffstat (limited to 'health/notifications/gotify')
-rw-r--r-- | health/notifications/gotify/Makefile.inc | 11 | ||||
-rw-r--r-- | health/notifications/gotify/README.md | 98 | ||||
-rw-r--r-- | health/notifications/gotify/metadata.yaml | 60 |
3 files changed, 0 insertions, 169 deletions
diff --git a/health/notifications/gotify/Makefile.inc b/health/notifications/gotify/Makefile.inc deleted file mode 100644 index 782559125..000000000 --- a/health/notifications/gotify/Makefile.inc +++ /dev/null @@ -1,11 +0,0 @@ -# SPDX-License-Identifier: GPL-3.0-or-later - -# THIS IS NOT A COMPLETE Makefile -# IT IS INCLUDED BY ITS PARENT'S Makefile.am -# IT IS REQUIRED TO REFERENCE ALL FILES RELATIVE TO THE PARENT - -# install these files -dist_noinst_DATA += \ - gotify/README.md \ - gotify/Makefile.inc \ - $(NULL) 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 @@ -<!--startmeta -custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/gotify/README.md" -meta_yaml: "https://github.com/netdata/netdata/edit/master/health/notifications/gotify/metadata.yaml" -sidebar_label: "Gotify" -learn_status: "Published" -learn_rel_path: "Alerting/Notifications/Agent Dispatched Notifications" -message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE" -endmeta--> - -# Gotify - - -<img src="https://netdata.cloud/img/gotify.png" width="150"/> - - -[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. - - - -<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> - -## 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 - -<details><summary>Config Options</summary> - -| 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 | - -</details> - -#### 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. - - diff --git a/health/notifications/gotify/metadata.yaml b/health/notifications/gotify/metadata.yaml deleted file mode 100644 index 4552de1c4..000000000 --- a/health/notifications/gotify/metadata.yaml +++ /dev/null @@ -1,60 +0,0 @@ -# yamllint disable rule:line-length ---- -- id: 'notify-gotify' - meta: - name: 'Gotify' - link: 'https://gotify.net/' - categories: - - notify.agent - icon_filename: 'gotify.png' - keywords: - - gotify - overview: - notification_description: | - [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. - notification_limitations: '' - setup: - prerequisites: - list: - - title: '' - description: | - - 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: - 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_GOTIFY' - default_value: 'YES' - description: "Set `SEND_GOTIFY` to YES" - required: true - - name: 'GOTIFY_APP_TOKEN' - default_value: '' - description: "set `GOTIFY_APP_TOKEN` to the app token you generated." - required: true - - name: 'GOTIFY_APP_URL' - default_value: '' - description: "Set `GOTIFY_APP_URL` to point to your Gotify instance, for example `https://push.example.domain/`" - required: true - examples: - folding: - enabled: true - title: '' - list: - - name: 'Basic Configuration' - folding: - enabled: false - description: '' - config: | - SEND_GOTIFY="YES" - GOTIFY_APP_TOKEN="XXXXXXXXXXXXXXX" - GOTIFY_APP_URL="https://push.example.domain/" - troubleshooting: - problems: - list: [] |