From 1866fe1202e30187962f99401632869cef43ea42 Mon Sep 17 00:00:00 2001
From: Massimo Candela <massimo@us.ntt.net>
Date: Sat, 25 Jul 2020 16:26:10 +0200
Subject: [PATCH] added documentation for the -t option

---
 docs/configuration.md | 5 ++++-
 docs/installation.md  | 9 +++++----
 2 files changed, 9 insertions(+), 5 deletions(-)

diff --git a/docs/configuration.md b/docs/configuration.md
index 4e7870a..fbcde79 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -333,6 +333,9 @@ Parameters for this monitor module:
 
 Reports send/store the alerts, e.g. by email or to a file. Reports can also provide the data triggering such alerts.
 
+> After configuring a report module, you can run the BGPalerter binary with the option `-t` to test the configuration. 
+> This will generate fake alerts. [Read more here](installation.md#bgpalerter-parameters).
+
 Possible reports are:
 
 #### reportFile
@@ -363,7 +366,7 @@ Parameters for this report module:
 |notifiedEmails| A dictionary containing email addresses grouped by user groups.  (key: group, value: list of emails)| 
 |notifiedEmails.default| The default user group. Each user group is a [list](prefixes.md#array) of emails. This group should contain at least the admin. | 
 
-
+After configuring this module, [test the configuration](installation.md#bgpalerter-parameters) (`-t` option) to be sure everything will work once in production.
 
 #### reportSlack
 
diff --git a/docs/installation.md b/docs/installation.md
index 964b2bf..c739dc4 100644
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -125,9 +125,10 @@ 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)). |
+| -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)). |
+| -t | To test the configuration by generating fake BGP updates. This will start sending alerts on all the reports listening the `hijack` channel. |
 
 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).