README

   1
   2 == Presentation Of the Shinken project ==
   3 Hi,
   4
   5 Welcome in the Shinken project.
   6
   7 Shinken is a new, Nagios compatible monitoring tool, 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. It’s as simple as in all the marketing “cloud computing” slides, but here, it’s real!
   8
   9 Shinken is backwards-compatible with the Nagios configuration standard and plugins. It works on any operating system and architecture that supports Python, which includes Windows and GNU/Linux.
  10
  11
  12 == How to install it ==
  13
  14 You just need to add a shinken user (in the shinken group) on your system :
  15 $adduser shinken
  16
  17 === First way : all in a directory (ugly but quick way ;) )===
  18 Then move the shinken directory and give it to the shinken user :
  19 mv shinken /usr/local
  20 chown -R shinken:shinken /usr/local/shinken
  21
  22 === Second way : district directory (clean way) ===
  23 You can install really the application by using the setup.py script. It
  24 will install the shinken librairy in the python path, create the
  25 /etc/shinken and /var/lib/shinken directory (you can change them
  26 in the setup_parameters.cfg file before launching setup.py).
  27 You will need the python-setuptools package for it.
  28 Then just run :
  29 sudo python setup.py install --install-scripts=/usr/bin/
  30
  31 For the compilation part in both way it's easy : there is no compilation part!
  32
  33 == Dependancies ==
  34 The only dependancies are Python >= 2.4 and the Pyro module.
  35
  36 For 2.4 and 2.5 python version, you will need an additionnal packages :
  37 *multiprocessing from http://pypi.python.org/pypi/multiprocessing/
  38 *for livestatus only: simplejson : http://pypi.python.org/pypi/simplejson/ and pysqlite http://code.google.com/p/pysqlite/
  39
  40 Just untar and launch python setup.py install (and be sure to have installed the python-devel package too).
  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 None we know :)
  81
  82 If you find one, please psot it in our trac site : https://sourceforge.net/apps/trac/shinken/report/2