mirror/nttgin-BGPalerter
1
0
Fork 0
mirror of https://github.com/nttgin/BGPalerter.git synced 2024-05-19 06:50:08 +00:00
Code Issues Releases Wiki Activity

Merge branch 'master' into dev

Browse Source
This commit is contained in:
Massimo Candela
2020-02-03 18:50:11 +01:00
parent c6f3719fe9 e37501af0c
commit f5259a0d21
2 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -14,7 +14,7 @@ It can deliver alerts on files, by email, on slack, and more.
## TL;DR
> This section is useful if you don't care about the source code but you just want to run the monitor.
If you want to know more about the source code (which is completely open) please see the following sections.
Instead, if you want to run the source code (which is completely open) or develop, please read directly the documentation.
1. Download the binary [here](https://github.com/nttgin/BGPalerter/releases) (be sure to select the one for your OS)
@@ -27,7 +27,9 @@ If you want to know more about the source code (which is completely open) please
5. See the alerts in `logs/reports-YYYY-MM-DD.log` (e.g. `tail -f logs/reports*`)
In `config.yml.example` you can find other reporting mechanisms (e.g. email and slack) in addition to logging to files.
Please uncomment the related section and configure according to your needs.
Please uncomment the related section and configure according to your needs.
Read the documentation below for more options.
## Documentation

1
docs/configuration.md
View File

@@ -297,6 +297,7 @@ Parameters for this report module:
|Parameter| Description|
|---|---|
|colors| A dictionary having as key the event channel and as value a hex color (string). These colors will be used to make messages in Slack distinguishable. |
|showPaths| Amount of AS_PATHs to report in the alert (0 to disable). |
|hooks| A dictionary containing Slack WebHooks grouped by user group (key: group, value: WebHook).|
|hooks.default| The WebHook (URL) of the default user group.|