alerta-contrib/plugins/debug/README.md
2020-11-20 22:39:32 +01:00

48 lines
987 B
Markdown

Debug Plugin
============
Used for debugging only.
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/debug
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 `debug` 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 = ['debug']
```
**Example Configuration**
```python
DEBUG = True
```
References
----------
n/a
License
-------
Copyright (c) 2019 Nick Satterly. Available under the MIT License.