alerta_alerta-contrib/plugins/forward/README.md

44 lines
1.1 KiB
Markdown

Forward Plugin
========================
This is an plugin that forward alert from one server to another.
For help, join [![Slack chat](https://img.shields.io/badge/chat-on%20slack-blue?logo=slack)](https://slack.alerta.dev)
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/forward
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 `forward` 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.
```python
PLUGINS = ['forward']
```
**Example**
```python
PLUGINS = ['enhance', 'forward']
FORWARD_URL = 'http://www.example.com/api'
FORWARD_API_KEY = 'client_api_key'
FORWARD_MAX_LENGTH = 3 # cycle detector
```
Copyright (c) 2018 SKob. Available under the MIT License.