shinken-monitoring · tarak666 · Mar 26, 2014 · Mar 26, 2014 · Mar 26, 2014 · Mar 30, 2014
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,22 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+*.sln    merge=union
+*.csproj merge=union
+*.vbproj merge=union
+*.fsproj merge=union
+*.dbproj merge=union
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain
diff --git a/.gitignore b/.gitignore
@@ -45,6 +45,7 @@ nosetests.xml
 # OS generated files
 *.pyc
 *.DS_Store*
+*.db
 
 # backup file
 *.py~
diff --git a/.travis.yml b/.travis.yml
@@ -9,7 +9,7 @@ install:
   - "pip install -r requirements.txt"
   - "pip install coveralls"
 
-script: nosetests -vx --with-coverage --cover-package=module
+script: cd test && nosetests -vx --with-coverage --cover-package=module
 
 after_success:
   coveralls

diff --git a/README.md b/README.md
@@ -3,6 +3,36 @@
 ###Description
 Shinken main Web interface
 
+###Installation
+
+* Install the webui module from shinken.io
+```
+$ shinken install webui
+```
+* Add it into the modules of the broker configuration :
+```
+$ cat /etc/shinken/brokers/broker-master.cfg
+[...]
+modules     webui
+[...]
+```
+* Install an authentication module. For instance 
+```
+$ shinken install auth-cfg-password
+```
+
+* Declare it on the WebUI configuration :
+```
+$ cat /etc/shinken/modules/webui.cfg
+[...]
+modules             auth-cfg-password
+[...]
+```
+* Restart shinken and connect to the WebUI that will be available on the 7767 port.
+```
+root@system# /etc/init.d/shinken restart
+```
+
 ###Screenshots
 
 Host Detail
@@ -13,9 +43,6 @@ System
 
 ###Dependencies
 
-###Installation
-
-*$ shinken install webui*
 
 ###Report a bug
 * A helpful title - use descriptive keywords in the title and body so others can find your bug (avoiding duplicates).

diff --git a/doc/user/Capture00.JPG b/doc/user/Capture00.JPG
diff --git a/doc/user/Capture01.JPG b/doc/user/Capture01.JPG
diff --git a/doc/user/Capture02.JPG b/doc/user/Capture02.JPG
diff --git a/doc/user/Capture03.JPG b/doc/user/Capture03.JPG
diff --git a/doc/user/Capture04.JPG b/doc/user/Capture04.JPG
diff --git a/doc/user/Capture05.JPG b/doc/user/Capture05.JPG
diff --git a/doc/user/Capture06.JPG b/doc/user/Capture06.JPG
diff --git a/doc/user/Capture07.JPG b/doc/user/Capture07.JPG
diff --git a/doc/user/Capture08.JPG b/doc/user/Capture08.JPG
diff --git a/doc/user/Capture10.JPG b/doc/user/Capture10.JPG
diff --git a/doc/user/Capture11.JPG b/doc/user/Capture11.JPG
diff --git a/doc/user/configuration.md b/doc/user/configuration.md
@@ -0,0 +1,22 @@
+# Configuration
+
+
+## Company logo
+------------------------------------
+
+If company logo is configured in the *webui.cfg* file, the company logo is displayed on the login page. If not found, a default logo is used.
+
+![Default company logo](../../module/htdocs/images/default_logo.png "Default company logo")
+
+
+## User picture
+------------------------------------
+
+If gravatar is configured in the *webui.cfg* file, the Web UI tries to find a Gravatar image to use for the logged in user.
+
+If gravatar is not configured in the *webui.cfg* file, the Web UI tries to find an image username.png to use for the logged in user.
+
+If none found, a default image is used.
+
+![Default user logo](../../module/htdocs/images/default_user.png "Default user logo")
+
diff --git a/doc/user/host_view.md b/doc/user/host_view.md
@@ -0,0 +1,137 @@
+# Host view
+====================================
+When an host is selected, the host element view displays all information known about this host.
+
+Two tabs menu are available on this page. A _vertical tabs menu_ on the left side allows to display information about the host and send commands.  An _horizontal tabs menu_ allows to display more information about the host monitoring status.
+
+In this chapter, some more explanations about each available tab.
+
+![Host view](./Capture10.JPG "Host view")
+
+
+## Vertical tabs menu
+------------------------------------
+
+### Information 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The host information pane contains information about : 
+
+ - host current status : Up, Unreachable, Down
+   Host is Up if it communicates with the monitoring server.
+   Host is unreachable if the monitoring server does not known how to contact (host is behind a router that is down)
+   Host is down if it does not communicate with the monitoring server, or its check command answers Down
+
+ - host status flapping 
+   Host status is flapping between two states (Up, Down, Up, Down, ...)
+
+ - host downtime 
+   Host is a downtime period
+
+ - last host check: 
+   When the last host check occured and what was the result: check output, performance data, latency and duration.
+
+   When the state changed for the last time and when the next check is programmed.
+
+
+![Host information](./host01.JPG "Host information")
+
+
+### Additional information 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The host additional information pane contains information about : 
+
+ - host check configuration : 
+   The host is *actively* or *passively* checked. If passively, the *freshness check and threshold* indicates wether and when the *check command* is executed.
+   The host *check period* defines in which timeperiod the host is checked with the check *command*, and how many *retry* at which *interval*. 
+
+
+ - flapping detection parameters
+   See http://nagios.sourceforge.net/docs/3_0/flapping.html
+
+ - notifications parameters 
+   See http://nagios.sourceforge.net/docs/3_0/notifications.html
+
+   If notifications are enabled, during the *notification period*, the declared *contacts* will receive the configured notifications at each each notification *interval*.
+   The configured possible notifications are:
+      host is switching from / to a problem state
+      host is entering / exiting a downtime period
+      a downtime period is programmed / cancelled
+      host is starting / stopping flapping
+
+
+![Host additional information](./host02.JPG "Host additional information")
+
+
+### Commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The host commands pane contains information about : 
+
+ - commands that can be sent to the host : 
+   add a comment:
+      allows the user to add a persistent text message in the host comments
+
+   try to fix
+      if event handlers are enabled and an event handler is defined for the host, it may be started to try to fix the problem.
+
+   add an acknowledgement
+      allow the user to add an acknowledgement for the current problem
+
+   recheck now
+      allows to launch the check command for the host
+
+   submit a check result
+      allows to change the current host state and check output
+
+   change a custom variable
+      allows to change an host custom variable
+
+   schedule a downtime
+      allows to schedule a downtime period for the host
+
+
+ - current host commands state (set per-host configuration and not modifiable): 
+   active checks enabled / disabled
+   passive checks enabled / disabled
+   freshness check enabled / disabled
+   notifications enabled / disabled
+   event handlers enabled / disabled
+   flapping detection enabled / disabled
+
+![Host commands](./host03.JPG "Host commands")
+
+
+### Configuration 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+![Host configuration](./host04.JPG "Host configuration")
+
+
+
+## Horizontal tabs menu
+------------------------------------
+
+### Graphical status
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+- view graphical status of the host (note that all hosts do not have such a view)
+
+### Host services status
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+- view host services status (Services tab) 
+
+### Comments
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+- view comments and acknowledges (Comments tab) for the host. Comments are texts sent when an host status is acknowledged with the Acknowledge command.
+
+### Graphs
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+- view graphs (Graphs tab) for the host. Graphs are performance data sent with the host check (heartbeat)
+
+### Impact graph
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+- view impact graph (Impact graph tab) for the host. 
+
+### Logs
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+- view logs (Logs graph tab) for the host. Overall system logs are filtered for the current host (last 100 logs)
+
+