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

Update README.md

Browse Source
This commit is contained in:
Massimo Candela
2019-09-15 21:00:25 +02:00
committed by GitHub
parent 29f07e354d
commit e0f0f46e3f
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -7,7 +7,7 @@ If you want to know more about the source code (which is completely open) please
1. Download the executable from [`bin/`](https://github.com/nttgin/BGPalerter/tree/master/bin) (be sure to select the one for your OS)
2. Download [`config.yml`](https://raw.githubusercontent.com/nttgin/BGPalerter/master/config.yml) and [`prefixes.yml`](https://raw.githubusercontent.com/nttgin/BGPalerter/master/prefixes.yml) and place them in the same directory of the executable
2. Download [`config.yml`](https://raw.githubusercontent.com/nttgin/BGPalerter/master/config.yml) and [`prefixes.yml`](https://raw.githubusercontent.com/nttgin/BGPalerter/master/prefixes.yml) and place them in the same directory of the executable (if you skip this step, some default configuration files will be generated during the first execution)
3. Modify `prefixes.yml` and add the prefixes you want to monitor (or see below how to auto generate this file)
@@ -24,11 +24,13 @@ If you enable email reporting, download also the directory `reports/email_templa
## More information for users
### Auto generate prefixes.yml
To auto generate the monitored prefixes file (by default called `prefixes.yml`) execute `npm run generate-prefixes ASN(S) OUTPUT_FILE` (e.g. `npm run generate-prefixes 2914 nttprefixes.yml`).
To auto generate the monitored prefixes file (by default called `prefixes.yml`) execute:
* If you are using the binary `./bgpalerter-linux-x64 generate -a ASN(S) -o OUTPUT_FILE` (e.g. `./bgpalerter-linux-x64 generate -a 2914 -o test.yml`).
* If you are using the source code `npm run generate-prefixes -a ASN(S) -o OUTPUT_FILE` (e.g. `npm run generate-prefixes -a 2914 -o nttprefixes.yml`).
The script will download the currently announced prefixes of the selected AS (according to RIPEstat data). A warning will be triggered in case of not valid RPKI prefixes.
Multiple ASns can be moniotred in the same file e.g.`npm run generate-prefixes 2914,4713 nttprefixes.yml` (see comma-separated ASns). Additionally, multiple files can be monitored by adding them under `monitoredPrefixesFiles` in `config.yml`.
Multiple ASns can be moniotred in the same file e.g.`npm run generate-prefixes -a 2914,4713 -o nttprefixes.yml` (see comma-separated ASns). Additionally, multiple files can be monitored by adding them under `monitoredPrefixesFiles` in `config.yml`.
### Composition