| 1 | # yamllint disable rule:line-length |
| 2 | --- |
| 3 | - id: 'notify-pushover' |
| 4 | meta: |
| 5 | name: 'PushOver' |
| 6 | link: 'https://pushover.net/' |
| 7 | categories: |
| 8 | - notify.agent |
| 9 | icon_filename: 'pushover.png' |
| 10 | keywords: |
| 11 | - PushOver |
| 12 | overview: |
| 13 | notification_description: | |
| 14 | Send notification to Pushover using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more. |
| 15 | - Netdata will send warning messages with priority 0 and critical messages with priority 1. |
| 16 | - Pushover allows you to select do-not-disturb hours. The way this is configured, critical notifications will ring and vibrate your phone, even during the do-not-disturb-hours. |
| 17 | - All other notifications will be delivered silently. |
| 18 | notification_limitations: '' |
| 19 | setup: |
| 20 | prerequisites: |
| 21 | list: |
| 22 | - title: '' |
| 23 | description: | |
| 24 | - An Application token. You can use the same on all your Netdata servers. |
| 25 | - A User token for each user you are going to send notifications to. This is the actual recipient of the notification. |
| 26 | - Access to the terminal where Netdata Agent is running |
| 27 | configuration: |
| 28 | file: |
| 29 | name: 'health_alarm_notify.conf' |
| 30 | options: |
| 31 | description: 'The following options can be defined for this notification' |
| 32 | folding: |
| 33 | title: 'Config Options' |
| 34 | enabled: true |
| 35 | list: |
| 36 | - name: 'SEND_PUSHOVER' |
| 37 | default_value: 'YES' |
| 38 | description: "Set `SEND_PUSHOVER` to YES" |
| 39 | required: true |
| 40 | - name: 'PUSHOVER_WEBHOOK_URL' |
| 41 | default_value: '' |
| 42 | description: "set `PUSHOVER_WEBHOOK_URL` to your Pushover Application token." |
| 43 | required: true |
| 44 | - name: 'DEFAULT_RECIPIENT_PUSHOVER' |
| 45 | default_value: '' |
| 46 | description: "Set `DEFAULT_RECIPIENT_PUSHOVER` the Pushover User token you want the alert notifications to be sent to. You can define multiple User tokens like this: `USERTOKEN1` `USERTOKEN2`." |
| 47 | required: true |
| 48 | detailed_description: | |
| 49 | All roles will default to this variable if left unconfigured. |
| 50 | |
| 51 | The `DEFAULT_RECIPIENT_PUSHOVER` can be edited in the following entries at the bottom of the same file: |
| 52 | ```text |
| 53 | role_recipients_pushover[sysadmin]="USERTOKEN1" |
| 54 | role_recipients_pushover[domainadmin]="USERTOKEN2" |
| 55 | role_recipients_pushover[dba]="USERTOKEN3 USERTOKEN4" |
| 56 | role_recipients_pushover[webmaster]="USERTOKEN5" |
| 57 | role_recipients_pushover[proxyadmin]="USERTOKEN6" |
| 58 | role_recipients_pushover[sitemgr]="USERTOKEN7" |
| 59 | ``` |
| 60 | examples: |
| 61 | folding: |
| 62 | enabled: true |
| 63 | title: '' |
| 64 | list: |
| 65 | - name: 'Basic Configuration' |
| 66 | folding: |
| 67 | enabled: false |
| 68 | description: '' |
| 69 | config: | |
| 70 | #------------------------------------------------------------------------------ |
| 71 | # pushover (pushover.net) global notification options |
| 72 | |
| 73 | SEND_PUSHOVER="YES" |
| 74 | PUSHOVER_APP_TOKEN="XXXXXXXXX" |
| 75 | DEFAULT_RECIPIENT_PUSHOVER="USERTOKEN" |
| 76 | troubleshooting: |
| 77 | problems: |
| 78 | list: [] |