nttgin-BGPalerter/README.md

[![Build Status](https://github.com/nttgin/BGPalerter/workflows/Main/badge.svg)](https://github.com/nttgin/BGPalerter/actions?query=workflow%3AMain)
[![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)

# BGPalerter
Self-configuring BGP monitoring tool, which allows you to monitor in **real-time** if:
* any of your prefixes loses visibility;
* any of your prefixes is hijacked;
* your AS is announcing RPKI invalid prefixes (e.g., not matching prefix length);
* your AS is announcing prefixes not covered by ROAs;
* any of your ROAs is expiring;
* ROAs covering your prefixes are no longer reachable;
* RPKI Trust Anchors malfunctions;
* 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;
* an unexpected upstream (left-side) AS appears in an AS path;
* an unexpected downstream (right-side) AS appears in an AS path;
* 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, email, kafka, slack, and more.

![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). 
 
## TL;DR (1 minute setup)
> This section is useful if you don't care about the source code but you just want to run the monitor.
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)

2. Execute the binary (e.g., `chmod +x bgpalerter-linux-x64 && ./bgpalerter-linux-x64`)  
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. 
Please uncomment the related section and configure according to your needs. 

If the installation doesn't go smoothly, read [here](docs/installation.md).  
Read the documentation below for more options.

## Documentation

- [Installation](docs/installation.md)
    - [Run from binary](docs/installation.md#running-bgpalerter-from-binaries)
    - [Run from source code](docs/installation.md#running-bgpalerter-from-the-source-code)
    - [Run in Docker](docs/installation.md#running-bgpalerter-in-docker)
    - [Run as a Linux service](docs/linux-service.md)
    - [Command line options](docs/installation.md#bgpalerter-parameters)
- [Monitored prefixes list](docs/prefixes.md#prefixes)
    - [Generate prefix list](docs/prefixes.md#generate)
    - [Prefix attributes description](docs/prefixes.md#prefixes-fields)
- [Configuration](docs/configuration.md)
    - [Composition](docs/configuration.md#composition)
    - [Monitor for](docs/configuration.md#monitors)
        - [Hijacks](docs/configuration.md#monitorhijack)
        - [Path neighbors (downstream/upstream peers)](docs/path-neighbors.md)
        - [Visibility loss](docs/configuration.md#monitorvisibility)
        - [RPKI invalid announcements](docs/configuration.md#monitorrpki)
        - [RPKI ROAs diffs, ROAs expirations, and TA malfunctions](docs/configuration.md#monitorroas)
        - [Announcements of more specifics](docs/configuration.md#monitornewprefix)
        - [Announcements of new prefixes](docs/configuration.md#monitoras)
        - [Path matching](docs/configuration.md#monitorpath)
    - [Send alerts to](docs/reports.md#reports)
        - [File](docs/reports.md#reportfile)
        - [E-mail](docs/reports.md#reportemail)
        - [Slack](docs/reports.md#reportslack)
        - [Kafka](docs/reports.md#reportkafka)
        - [Syslog](docs/reports.md#reportsyslog)
        - [Alerta dashboard](docs/reports.md#reportalerta)
        - [Webex](docs/reports.md#reportwebex)
        - [HTTP URL (push)](docs/reports.md#reporthttp)
        - [Telegram](docs/reports.md#reporttelegram)
        - [Mattermost](docs/reports.md#mattermost)
        - [Pushover](docs/report-http.md#pushover)
        - [Microsoft Teams](docs/report-http.md#ms-teams)
        - [REST API (pull)](docs/reports.md#reportpullapi)
    - [Test report configuration](docs/installation.md#bgpalerter-parameters)
    - [Process/Uptime monitoring](docs/process-monitors.md)
    - [Notification user groups](docs/usergroups.md)
    - [RPKI configuration](docs/rpki.md)
        - [Staging/testing ROAs](docs/rpki.md#stagingtesting-roas)
    - [HTTP/HTTPS proxy](docs/http-proxy.md)
- [Update to latest version](docs/update.md)
- [More information for developers](docs/develop.md)
    - [All npm commands](docs/develop.md#all-npm-commands)
    - [Reports/alerts templates](docs/context.md)
    - [Release process and Git flow](docs/release-process.md)
- [BGPalerter for researchers](docs/research.md)



If you are using BGPalerter, feel free to sign here: [Who is using BGPalerter](docs/friends.md)