docs/README

   1 Ninja - Nagios is Now Just Awesome is a modern web gui for Nagios
   2
   3 Requirements
   4 ------------
   5 Ninja requires the following system software to be installed:
   6
   7 php, php-mysql and php-cli 5.3+ (php-process)
   8 MySQL 5+ (4 might also work but is not tested)
   9
  10 Further, generating stylesheets require:
  11 ruby
  12 rubygems (gem install compass) or:
  13   rubygems-sass
  14   rubygems-compass
  15
  16
  17 It also requires the following software, which you can find on git.op5.org:
  18
  19 Nagios 4.0+ (needs to run on the same server)
  20 Merlin
  21 op5's livestatus
  22 op5lib
  23
  24 Installation
  25 ------------
  26 Ninja is a web application mainly written in php so in short words the
  27 installation goes something like this
  28
  29 1. download op5lib, which is found in a seperate repository
  30 2. run "make install" in op5lib
  31 3. download, untar and put ninja in some nice place on your server
  32 4. run make
  33 5. configure your webserver
  34 6. configure ninja with basic info such as where it's installed and where
  35    the database is located.
  36 7. configure op5lib, such as livestatus socket connection (/etc/op5/*.yml)
  37 done :)
  38
  39 Here is a longer and a bit more exact version on how to install it
  40
  41 1. Download op5lib from http://git.op5.org/
  42
  43 2. Run "make install", within the op5lib, which installs libraries used by
  44    ninja, both for compilation and in runtime
  45
  46 3. Make sure that all Ninja requirements are installed. Make sure op5lib is
  47    located in the global PHP path, and that both the merlin and the livestatus
  48    broker modules are loaded by nagios.
  49
  50 4. Download ninja from http://git.op5.org/
  51
  52 5. Within ninja directory, type "make". In case of depenceny issues with gems
  53    and compass, follow the instructions in the terminal.
  54
  55 6. Copy the ninja dir to a suitable location. Will vary between installations.
  56 mkdir /usr/local/nagios/addons/
  57 cp -a ninja /usr/local/nagios/addons/
  58
  59 7. Configure your webserver. We provide an example config file for apache
  60    located at ninja/op5build/ninja.httpd-conf. The example below works for
  61    CentOS and RedHat.
  62 vim ninja/op5build/ninja.httpd-conf
  63 cp ninja/op5build/ninja.httpd-conf /etc/httpd/conf.d/ninja-httpd.conf
  64 service httpd restart
  65
  66 8. Configure Ninja.
  67
  68    Edit the database connection settings and livestatus path in
  69    ninja/application/config/database.php
  70    There are more configuration files located in ninja/application/config/ but
  71    you should normally not require to edit them, the same goes for
  72    ninja/index.php which contains config regarding error reporting and general
  73    paths to Ninja's files.
  74
  75    if you want to use ninja over http instead of https you should copy
  76    ninja/application/config/cookie.php to ninja/application/config/custom/
  77    and change $config['secure'] = true; to false
  78
  79 9. Setup the db tables required for Ninja by executing
  80
  81 ninja/install_scripts/ninja_db_init.sh
  82
  83    This script will also try to import any existing htpasswd users from your
  84    Nagios config.
  85
  86 10.Configure /etc/op5/*.yml files; livestatus.yml should point to your
  87    livestatus socket. Look at the other files so they match your system.
  88
  89 12.Point your browser to https://yourip/ninja and try your installation with
  90    default user "monitor" and password "monitor"
  91
  92 13.Use "op5-manage-users" to manage additional user accounts.
  93
  94 Congratulations! You now (hopefully) have a working Ninja installation
  95
  96 Questions, feedback, patches etc are best sent to op5-users@lists.op5.com
  97 A subscription (http://lists.op5.com/mailman/listinfo/op5-users) is needed
  98 to post. Check out www.op5.org for more info about Ninja.