| 1 | <!--startmeta |
| 2 | custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/health/notifications/gotify/README.md" |
| 3 | meta_yaml: "https://github.com/netdata/netdata/edit/master/src/health/notifications/gotify/metadata.yaml" |
| 4 | sidebar_label: "Gotify" |
| 5 | learn_status: "Published" |
| 6 | learn_rel_path: "Alerts & Notifications/Notifications/Agent Dispatched Notifications" |
| 7 | keywords: ['gotify'] |
| 8 | message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE" |
| 9 | endmeta--> |
| 10 | |
| 11 | # Gotify |
| 12 | |
| 13 | |
| 14 | <img src="https://netdata.cloud/img/gotify.png" width="150"/> |
| 15 | |
| 16 | |
| 17 | [Gotify](https://gotify.net/) is a self-hosted push notification service created for sending and receiving messages in real time. |
| 18 | You can send alerts to your Gotify instance using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more. |
| 19 | |
| 20 | |
| 21 | <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> |
| 22 | |
| 23 | ## Setup |
| 24 | |
| 25 | |
| 26 | ### Prerequisites |
| 27 | |
| 28 | #### |
| 29 | |
| 30 | - An application token. You can generate a new token in the Gotify Web UI. |
| 31 | - Access to the terminal where Netdata Agent is running |
| 32 | |
| 33 | |
| 34 | |
| 35 | ### Configuration |
| 36 | |
| 37 | #### Options |
| 38 | |
| 39 | The following options can be defined for this notification |
| 40 | |
| 41 | <details open><summary>Config Options</summary> |
| 42 | |
| 43 | |
| 44 | |
| 45 | | Option | Description | Default | Required | |
| 46 | |:-----|:------------|:--------|:---------:| |
| 47 | | SEND_GOTIFY | Set `SEND_GOTIFY` to YES | YES | yes | |
| 48 | | GOTIFY_APP_TOKEN | set `GOTIFY_APP_TOKEN` to the app token you generated. | | yes | |
| 49 | | GOTIFY_APP_URL | Set `GOTIFY_APP_URL` to point to your Gotify instance, for example `https://push.example.domain/` | | yes | |
| 50 | |
| 51 | |
| 52 | </details> |
| 53 | |
| 54 | |
| 55 | |
| 56 | #### via File |
| 57 | |
| 58 | The configuration file name for this integration is `health_alarm_notify.conf`. |
| 59 | |
| 60 | |
| 61 | You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the |
| 62 | Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory). |
| 63 | |
| 64 | ```bash |
| 65 | cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata |
| 66 | sudo ./edit-config health_alarm_notify.conf |
| 67 | ``` |
| 68 | |
| 69 | ##### Examples |
| 70 | |
| 71 | ###### Basic Configuration |
| 72 | |
| 73 | |
| 74 | |
| 75 | ```yaml |
| 76 | SEND_GOTIFY="YES" |
| 77 | GOTIFY_APP_TOKEN="XXXXXXXXXXXXXXX" |
| 78 | GOTIFY_APP_URL="https://push.example.domain/" |
| 79 | |
| 80 | ``` |
| 81 | |
| 82 | |
| 83 | ## Troubleshooting |
| 84 | |
| 85 | ### Test Notification |
| 86 | |
| 87 | You can run the following command by hand, to test alerts configuration: |
| 88 | |
| 89 | ```bash |
| 90 | # become user netdata |
| 91 | sudo su -s /bin/bash netdata |
| 92 | |
| 93 | # enable debugging info on the console |
| 94 | export NETDATA_ALARM_NOTIFY_DEBUG=1 |
| 95 | |
| 96 | # send test alarms to sysadmin |
| 97 | /usr/libexec/netdata/plugins.d/alarm-notify.sh test |
| 98 | |
| 99 | # send test alarms to any role |
| 100 | /usr/libexec/netdata/plugins.d/alarm-notify.sh test "ROLE" |
| 101 | ``` |
| 102 | |
| 103 | Note that this will test _all_ alert mechanisms for the selected role. |
| 104 | |
| 105 |