summaryrefslogtreecommitdiffstats
path: root/health/notifications/email/metadata.yaml
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-05 11:19:16 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-05 12:07:37 +0000
commitb485aab7e71c1625cfc27e0f92c9509f42378458 (patch)
treeae9abe108601079d1679194de237c9a435ae5b55 /health/notifications/email/metadata.yaml
parentAdding upstream version 1.44.3. (diff)
downloadnetdata-upstream.tar.xz
netdata-upstream.zip
Adding upstream version 1.45.3+dfsg.upstream/1.45.3+dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'health/notifications/email/metadata.yaml')
-rw-r--r--health/notifications/email/metadata.yaml73
1 files changed, 0 insertions, 73 deletions
diff --git a/health/notifications/email/metadata.yaml b/health/notifications/email/metadata.yaml
deleted file mode 100644
index f0d4a62a9..000000000
--- a/health/notifications/email/metadata.yaml
+++ /dev/null
@@ -1,73 +0,0 @@
-# yamllint disable rule:line-length
----
-- id: 'notify-email'
- meta:
- name: 'Email'
- link: ''
- categories:
- - notify.agent
- icon_filename: 'email.png'
- keywords:
- - email
- overview:
- notification_description: |
- Send notifications via Email using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more.
- notification_limitations: ''
- setup:
- prerequisites:
- list:
- - title: ''
- description: |
- - A working sendmail command is required for email alerts to work. Almost all MTAs provide a sendmail interface. Netdata sends all emails as user netdata, so make sure your sendmail works for local users.
- - 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: 'EMAIL_SENDER'
- default_value: 'netdata'
- description: "You can change `EMAIL_SENDER` to the email address sending the notifications."
- required: false
- - name: 'SEND_EMAIL'
- default_value: 'YES'
- description: "Set `SEND_EMAIL` to YES"
- required: true
- - name: 'DEFAULT_RECIPIENT_EMAIL'
- default_value: 'root'
- description: "Set `DEFAULT_RECIPIENT_EMAIL` to the email address you want the email to be sent by default. You can define multiple email addresses like this: `alarms@example.com` `systems@example.com`."
- required: true
- detailed_description: |
- All roles will default to this variable if left unconfigured.
- The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file:
- ```conf
- role_recipients_email[sysadmin]="systems@example.com"
- role_recipients_email[domainadmin]="domains@example.com"
- role_recipients_email[dba]="databases@example.com systems@example.com"
- role_recipients_email[webmaster]="marketing@example.com development@example.com"
- role_recipients_email[proxyadmin]="proxy-admin@example.com"
- role_recipients_email[sitemgr]="sites@example.com"
- ```
- examples:
- folding:
- enabled: true
- title: ''
- list:
- - name: 'Basic Configuration'
- folding:
- enabled: false
- description: ''
- config: |
- #------------------------------------------------------------------------------
- # email global notification options
-
- EMAIL_SENDER="example@domain.com"
- SEND_EMAIL="YES"
- DEFAULT_RECIPIENT_EMAIL="recipient@example.com"
- troubleshooting:
- problems:
- list: []