summaryrefslogtreecommitdiffstats
path: root/health/notifications/twilio/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'health/notifications/twilio/README.md')
-rw-r--r--health/notifications/twilio/README.md118
1 files changed, 0 insertions, 118 deletions
diff --git a/health/notifications/twilio/README.md b/health/notifications/twilio/README.md
deleted file mode 100644
index c125a967f..000000000
--- a/health/notifications/twilio/README.md
+++ /dev/null
@@ -1,118 +0,0 @@
-<!--startmeta
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/twilio/README.md"
-meta_yaml: "https://github.com/netdata/netdata/edit/master/health/notifications/twilio/metadata.yaml"
-sidebar_label: "Twilio"
-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-->
-
-# Twilio
-
-
-<img src="https://netdata.cloud/img/twilio.png" width="150"/>
-
-
-Send notifications to Twilio 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
-
-####
-
-- Get your SID, and Token from https://www.twilio.com/console
-- Terminal access to the Agent you wish to configure
-
-
-
-### 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_TWILIO | Set `SEND_TWILIO` to YES | YES | yes |
-| TWILIO_ACCOUNT_SID | set `TWILIO_ACCOUNT_SID` to your account SID. | | yes |
-| TWILIO_ACCOUNT_TOKEN | Set `TWILIO_ACCOUNT_TOKEN` to your account token. | | yes |
-| TWILIO_NUMBER | Set `TWILIO_NUMBER` to your account's number. | | yes |
-| DEFAULT_RECIPIENT_TWILIO | Set DEFAULT_RECIPIENT_TWILIO to the number you want the alert notifications to be sent to. You can define multiple numbers like this: +15555555555 +17777777777. | | yes |
-
-##### DEFAULT_RECIPIENT_TWILIO
-
-You can then have different recipients per role, by editing DEFAULT_RECIPIENT_TWILIO with the recipient's number you want, in the following entries at the bottom of the same file:
-
-```conf
-role_recipients_twilio[sysadmin]="+15555555555"
-role_recipients_twilio[domainadmin]="+15555555556"
-role_recipients_twilio[dba]="+15555555557"
-role_recipients_twilio[webmaster]="+15555555558"
-role_recipients_twilio[proxyadmin]="+15555555559"
-role_recipients_twilio[sitemgr]="+15555555550"
-```
-
-
-</details>
-
-#### Examples
-
-##### Basic Configuration
-
-
-
-```yaml
-#------------------------------------------------------------------------------
-# Twilio (twilio.com) SMS options
-
-SEND_TWILIO="YES"
-TWILIO_ACCOUNT_SID="xxxxxxxxx"
-TWILIO_ACCOUNT_TOKEN="xxxxxxxxxx"
-TWILIO_NUMBER="xxxxxxxxxxx"
-DEFAULT_RECIPIENT_TWILIO="+15555555555"
-
-```
-
-
-## 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.
-
-