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

added documentation about default parameters

Browse Source
This commit is contained in:
Massimo Candela
2020-06-10 23:24:36 +02:00
parent bda942e0b8
commit ca5f4ad794
2 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/installation.md
View File

@@ -119,3 +119,15 @@ docker run -i --name bgpalerter \
> This option does NOT replace [proper monitoring](process-monitors.md).
Just restarting the container will not assure you that the monitoring is working properly or that it will work again. You should always investigate failures and fix possible misconfiguration.
## BGPalerter parameters
The execution of BGPalerter supports some parameters
| Parameter | Description |
|---|---|
| -v | Show version number |
| -h | Show help |
| -c | To specify the config file to load (default `./config.yml`) |
| -d | To specify a directory where configuration and data is persisted (see [volume](configuration.md)). |
You can also use the same parameters with npm (if you are running the source code), in the following format `npm run serve -- --h` (replace `h` with the parameter you need).