mirror of
https://github.com/alerta/alerta-contrib.git
synced 2025-03-17 14:02:38 +00:00
dacc85890d
* fix * comments * forward plugin: [fix] ability to configure via env + refactor via @satterly comment
43 lines
1.1 KiB
Markdown
43 lines
1.1 KiB
Markdown
Forward Plugin
|
|
========================
|
|
|
|
This is an plugin that forward alert from one server to another.
|
|
|
|
For help, join [](https://gitter.im/alerta/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/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.
|