archive/alerta_alerta-contrib
0
0
Fork 0
mirror of https://github.com/alerta/alerta-contrib.git synced 2025-03-17 05:52:38 +00:00
Code Issues Projects Releases Wiki Activity
alerta_alerta-contrib/plugins/twilio
History
Nick Satterly b272a24848 Update READMEs for pd, twilio and sns
2016-12-04 20:41:15 +00:00
..
alerta_twilio_sms.py Set useful logger name for plugins 2016-09-15 10:18:03 +01:00
README.md Update READMEs for pd, twilio and sns 2016-12-04 20:41:15 +00:00
setup.py Set useful logger name for plugins 2016-09-15 10:18:03 +01:00

README.md

Twilio SMS Plugin

Send SMS messages for new alerts using Twilio.

For help, join Gitter chat

Installation

Clone the GitHub repo and run:

$ python setup.py install

Or, to install remotely from GitHub run:

$ pip install git+https://github.com/alerta/alerta-contrib.git#subdirectory=plugins/twilio

Note: If Alerta is installed in a python virtual environment then plugins need to be installed into the same environment for Alerta to dynamically discover them.

Configuration

Add twilio_sms to the list of enabled PLUGINS in alertad.conf server configuration file and set plugin-specific variables either in the server configuration file or as environment variables.

PLUGINS = ['twilio_sms']
TWILIO_ACCOUNT_SID = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
TWILIO_AUTH_TOKEN = ''

TWILIO_TO_NUMBER = ''
TWILIO_FROM_NUMBER = ''

Troubleshooting

Restart Alerta API and confirm that the plugin has been loaded and enabled.

References

License

Copyright (c) 2016 Nick Satterly. Available under the MIT License.