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

improved documentation

Browse Source
This commit is contained in:
Massimo Candela
2019-09-26 03:40:42 +02:00
parent f9e3602e5e
commit f2b178966e
2 changed files with 56 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -27,18 +27,10 @@ If you enable email reporting, download also the directory `reports/email_templa
## More information for users
Below thre are some basic topics, more information will be soon [in the wiki](https://github.com/nttgin/BGPalerter/wiki).
### Auto generate prefixes.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.
To exclude prefixes from being monitored, add to the command `-e prefix1,prefix2`.
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`.
- [Monitored prefixes List](docs/prefixes/#prefixes)
- [Auto-generate](docs/prefixes/#generate)
- [Fields and meaning](docs/prefixes/#prefixes-fields)
### Composition