From ca5f4ad7944dbd5ec316308140f073d1578d7fa0 Mon Sep 17 00:00:00 2001 From: Massimo Candela Date: Wed, 10 Jun 2020 23:24:36 +0200 Subject: [PATCH] added documentation about default parameters --- docs/configuration.md | 1 + docs/installation.md | 12 ++++++++++++ 2 files changed, 13 insertions(+) diff --git a/docs/configuration.md b/docs/configuration.md index e7777bb..b1f875b 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -17,6 +17,7 @@ The following are common parameters which it is possible to specify in the confi |checkForUpdatesAtBoot| Indicates if at each booth the application should check for updates. If an update is available, a notification will be sent to the default group. If you restart the process often (e.g. debugging, experimenting etc.) set this to false to avoid notifications. Anyway, BGPalerter checks for updates every 10 days.| A boolean | true | Yes | |processMonitors| A list of modules allowing various ways to check for the status of BGPalerter (e.g. API, heartbeat). See [here](process-monitors.md) for more information. | | | No | |httpProxy| Defines the HTTP/HTTPS proxy server to be used by BGPalerter and its submodules (reporters/connectors/monitors). See [here](http-proxy.md) for more information. | A string | http://username:password@proxy.example.org:8080 | No | +|volume| Defines a directory that will contain the data that needs persistence. For example, configuration files and logs will be created in such directory (default to "./"). | A string | /home/bgpalerter/volume/ | No | The following are advanced parameters, please don't touch them if you are not doing research/experiments. diff --git a/docs/installation.md b/docs/installation.md index 5915744..964b2bf 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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).