README

   1
   2 == Presentation Of the Shinken project ==
   3 Hi,
   4
   5 Welcome in the Shinken project.
   6
   7 Shinken is a new implementation of Nagios in AGPLv3 written in Python. The main goal of Shinken is to allow users to have a fully flexible architecture for their monitoring system that can easily scale to large environments. Shinken is backward compatible with the Nagios configuration standard and plugins. It works on any operative system and architecture that supports Python, which includes Windows and Mac OS X/Darwin.
   8
   9
  10 == How to install it ==
  11
  12 You just need to add a shinken user (in the shinken group) on your system :
  13 $adduser shinken
  14
  15 === First way : all in a directory (ugly but quick way ;) )===
  16 Then move the shinken directory and give it to the shinken user :
  17 mv shinken /usr/local
  18 chown -R shinken:shinken /usr/local/shinken
  19
  20 === Second way : district directory (clean way) ===
  21 You can install really the application by using the setup.py script. It
  22 will install the shinken librairy in the python path, create the
  23 /etc/shinken and /var/lib/shinken directory (you can change them
  24 in the setup_parameters.cfg file before launching setup.py).
  25 You will need the python-setuptools package for it.
  26 Then just run :
  27 sudo python setup.py install --install-scripts=/usr/bin/
  28
  29 For the compilation part in both way it's easy : there is no compilation part!
  30
  31 == Dependancies ==
  32 The only dependancies are Python >= 2.4 and the Pyro module.
  33
  34 For 2.4 and 2.5 python version, you will need an additionnal packages :
  35 *multiprocessing from http://pypi.python.org/pypi/multiprocessing/
  36 *for livestatus only: simplejson : http://pypi.python.org/pypi/simplejson/ and pysqlite http://code.google.com/p/pysqlite/
  37
  38 Just untar and launch python setup.py install (and be sure to have installed the python-devel package too).
  39
  40 Beware : Python 2.4 and 2.5 users should not be able to use the livestatus broker module. We are working on this issue.
  41
  42 For Python, it should be ok with nearly all distribution.
  43
  44 Under ubuntu, you can grag the Pyro module with :
  45 $ sudo apt-get install pyro
  46
  47 Under other distributions, you can search for it :
  48 $ yum search pyro
  49 And if you do not find it, you can install it from Pypi :
  50 $ easy_install pyro
  51
  52 And that all folks :)
  53
  54
  55 == Where is the configuration ? ==
  56 The configuration is where you put the etc directory (in /usr/local/shinken/etc for a quick and dirty install, /etc/shinken for a clean one).
  57
  58 The nagios.cfg, commons files are like Nagios. All Shinken specific objects (like link to daemons or realms) are in
  59 the shinken-specific.cfg file.
  60
  61 == I need to change the configuration ? ==
  62
  63 Nothing unless somenews hosts and services.
  64
  65 == How to run it ==
  66 ===Quick and dirty way ===
  67 It's easy, there is a already launch script for you :
  68 $ /usr/local/shinken/bin/launch_all.sh
  69
  70 ===Clean way==
  71 The setup.py give you some init.d scripts, let use them :)
  72 $ /etc/init.d/shinken-scheduler start
  73 $ /etc/init.d/shinken-poller start
  74 $ /etc/init.d/shinken-reactionner start
  75 $ /etc/init.d/shinken-broker start
  76 $ /etc/init.d/shinken-arbiter start
  77
  78
  79 == Known bugs ==
  80 *The only know bug not already 'fix ok' is in the status.dat module. In fact the objects.dat file is 'shrink' after a conf reload. If so, just restart the broker too (and we take debug message if you got it of course :) ). Thanks a lot.