paths in docs

patrickpr · Jan 24, 2019 · f6d1513 · f6d1513
1 parent 87fa60c
commit f6d1513
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@ Projet features :
 Project status : Beta release
 
 - Module has been installed and tested on CentOS 7 and Ubuntu 18.04 (Bionic)
-- All base project feature are working on thoses systems.	 
+- All base project feature are working on those systems.	 
 
 Help wanted : 
 

diff --git a/docs/01-install.md b/docs/01-install.md
@@ -12,7 +12,7 @@ Requirements
 Better with
 ---------------
 
-* Director : to set up services, templates (not implement right now).
+* Director : to set up services, templates (only one template for now).
 
 
 Install files
@@ -57,9 +57,8 @@ The options are
 * Prefix : the prefix for all database tables
 * IDO Database : the IDO database set up with IcingaWeb2
 * Icingaweb2 config dir : configuration directory in case of uncommon installation of icingaweb2
-* snmptranslate binary : default should be OK
-* Path for mibs : must include net-snmp standard mibs (in /usr/share/snmp/mibs by default) and local mibs (in /usr/share/icingaweb2/modules/trapdirector/mibs)
-The value by default should be OK)
+* snmptranslate binary : default should be OK, test in in mib&status page.
+* Path for mibs : local mibs (default /usr/share/icingaweb2/modules/trapdirector/mibs). You can add directories with ':' separators : the mib upload will then be in the first one 
 * icingacmd path : default should be OK
 
 Create schema
@@ -166,7 +165,7 @@ Now all traps received by the system will be redirected to the trapdirector modu
 Set up mibs : 
 ------------------------
 
-The system mibs should be in `/usr/share/net-snmp/mibs` directory : change the path in configuration if needed.
+The system mibs should be set by net-snmp package. Check the defaults mibs are set by testing `snmptranslate 1.3.6.1.2.1.1.1` -> `SNMPv2-MIB::sysDescr` 
 
 Mib you can upload will be in (default) `/usr/share/icingaweb2/module/trapdirector/mibs` : you must check the directory is writable by the user of the web server.
 For example (as root) : 
@@ -183,5 +182,5 @@ icingacli trapdirector mib update
 
 Ready to go !
 
-Now have a look at the doc : ![Traps](docs/02-userguide.md)
+Now have a look at the doc : ![Traps](02-userguide.md)
 
diff --git a/docs/02-userguide.md b/docs/02-userguide.md
@@ -1,12 +1,10 @@
 User Guide
 ===============
 
-* User guide : ![Traps](docs/02-userguide.md)
+* Create rule from existing trapd : ![Here](05-traps.md)
 
-* Create rule from existing trapd : ![Here](docs/05-traps.md)
+* Create a rule from scratch : ![Here](10-createrule.md)
 
-* Create a rule from scratch : ![Here](docs/10-createrule.md)
+* Mib management : ![Here](15-mib.md)
 
-* Mib management : ![Here](docs/15-mib.md)
-
-* Trap receiver logic : ![Basic schema](docs/20-receiver-logic.md)
+* Trap receiver logic : ![Basic schema](20-receiver-logic.md)
diff --git a/docs/05-traps.md b/docs/05-traps.md
@@ -157,5 +157,5 @@ Testing a rule
 Not currently implemented
 
 
-Go back to user guide : ![Traps](docs/02-userguide.md)
+Go back to user guide : ![Traps](02-userguide.md)
 
diff --git a/docs/10-createrule.md b/docs/10-createrule.md
@@ -12,9 +12,9 @@ Goto Handlers menu and click 'Add a trap handler'
 
 You can choose between hosts or hostgroups :
 - When selecting a host, the trap receiver will take it's source IP 
-- When selection a hostgroup, the trap receiver will take all IP of all host in this hostgroup (! performance issues maybe )
+- When selecting a hostgroup, the trap receiver will take all IP of all host in this hostgroup (! performance issues (maybe) ! )
 
-On both case, you must have a service attached to the host or hostgroup that accepts passive check (see ![Here](docs/15-mib.md) about it)
+On both case, you must have a service attached to the host or hostgroup that accepts passive check (see ![Here](15-mib.md) about it)
 
 Now first, (1) select host/group name (autocompletion provided)
 
@@ -31,19 +31,19 @@ In the second case, the "Add objects" will be enabled : this will add all object
 
 The "Revert OK" is the time after which the service will be reseted to OK. To do this, you have to set up a specific service on the icinga host (DOC TODO).
 
-Automatic reset can also be done with icinga freshness check / active checks see ![Here](docs/15-mib.md) about it).
+Automatic reset can also be done with icinga freshness check / active checks see ![Here](15-mib.md) about it).
 
 ![trap-3](img/create-rule-3.jpg)
 
 
 Objects, rule & display
 ---------------
 
-All of it is described ![Here](docs/05-traps.md)
+All of it is described ![Here](05-traps.md)
 
 
 Then click create : rule is created and applied directly.
 
 
 
-back to user guide : ![user guide](docs/02-userguide.md)
+back to user guide : ![user guide](02-userguide.md)
diff --git a/docs/15-mib.md b/docs/15-mib.md
@@ -21,9 +21,12 @@ To drop some traps immediatly, you can change the number of days and click "Drop
 Log destination
 ---------------
 
-Here is where the trap receiver 
+Here is where the trap receiver will log info about what he's doing - or not doing -.
+
+Note : 'display' is for debug only and can ruin your web page.
+
+Be careful, in trace mode the db passwords & communities can be shown.
 
-The easy way to create rule is with an existing trap, but you also can create a rule before receiving any traps.
 
 Mib Management
 ===============
@@ -70,4 +73,4 @@ Here is some details about it :
 ![trap-1](img/mib-status-10.jpg)
 
 
-back to user guide : ![user guide](docs/02-userguide.md)
+back to user guide : ![user guide](02-userguide.md)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -157,5 +157,5 @@ Testing a rule
		Not currently implemented


		Go back to user guide : ![Traps](docs/02-userguide.md)
		Go back to user guide : ![Traps](02-userguide.md)