1
0
mirror of https://github.com/nttgin/BGPalerter.git synced 2024-05-19 06:50:08 +00:00

minor fixes to the doc

This commit is contained in:
Massimo Candela
2020-12-11 04:41:10 +01:00
parent 6511057f23
commit d3802c54e4

View File

@@ -11,13 +11,13 @@ Self-configuring BGP monitoring tool, which allows you to monitor in **real-time
* ROAs covering your prefixes are no longer reachable (e.g., TA malfunction);
* a ROA involving any of your prefixes or ASes was deleted/added/edited;
* your AS is announcing a new prefix that was never announced before;
* one of the AS path used to reach your prefix matches a specific condition defined by you.
* one of the AS paths used to reach your prefix matches a specific condition defined by you.
You just run it. You don't need to provide any data source or connect it to anything in your network since it connects to [public repos](docs/datasets.md).
It can deliver alerts on files, by email, on slack, and more.
It can deliver alerts on files, email, kafka, slack, and more.
![BGPalerter](https://massimocandela.com/img/bgpalerter_github_image.png)
![BGPalerter](http://massimocandela.com/img/bgpalerter_github_image.png)
> BGPalerter connects to public BGP data repos (not managed by NTT), and the entire monitoring is done directly in the application (there are no NTT servers involved).
@@ -31,8 +31,8 @@ Instead, if you want to run the source code (which is completely open) or develo
The first time you run it, the auto-configuration will start.
If something happens (e.g. a hijack) you will see the alerts in `logs/reports.log`.
In `config.yml` you can find other reporting mechanisms (e.g. email, Slack, Kafka) in addition to logging on files.
If something happens (e.g., a hijack) you will see the alerts in `logs/reports.log`.
In `config.yml` you can find other reporting mechanisms (e.g., email, Slack, Kafka) in addition to logging on files.
Please uncomment the related section and configure according to your needs.
If the installation doesn't go smoothly, read [here](docs/installation.md).