.. _gettingstarted/installations/shinken-installation:

=====================================
10 Minutes Shinken Installation Guide 
=====================================


Summary 
=======

By following this tutorial, in 10 minutes you will have the core monitoring system for your network.

The very first step is to verify that your server meets the :ref:`requirements <gettingstarted/installations/shinken-installation#requirements>`, the installation script will try to meet all requirements automatically.
   
You can get familiar with the :ref:`Shinken Architecture <architecture/the-shinken-architecture>` now, or after the installation. This will explain the software components and how they fit together.

  * Installation : :ref:`GNU/Linux & Unix <gettingstarted/installations/shinken-installation#gnu_linux_unix>`
  * Installation : :ref:`Windows <gettingstarted/installations/shinken-installation#windows_installation>`

Ready? Let's go!


.. _gettingstarted/installations/shinken-installation#requirements:

Requirements
============

Mandatory Requirements
----------------------

* `Python`_ 2.6 or higher (2.7 will get higher performance)
* `python-pycurl`_ Python package for Shinken daemon communication
* `setuptools`_ or `distribute` Python package for installation


Conditional Requirements
------------------------

* `Python`_ 2.7 is required for developers to run the test suite, shinken/test/
* `python-cherrypy3`_ (recommended) enhanceddaemons communications, especially in HTTPS mode
* `Monitoring Plugins`_ (recommended) provides a set of plugins to monitor host (Shinken uses check_icmp by default install).
  Monitoring plugins are available on most linux distributions (nagios-plugins package)


.. _gettingstarted/installations/shinken-installation#gnu_linux_unix:

.. warning::  Do not mix installation methods! If you wish to change method, use the uninstaller from the chosen method THEN install using the alternate method.


GNU/Linux & Unix Installation 
=============================

Method 1: Pip
-------------

Shinken 2.4 is available on Pypi : https://pypi.python.org/pypi/Shinken/2.4
You can download the tarball and execute the setup.py or just use the pip command to install it automatically.


::

  apt-get install python-pip python-pycurl
  adduser shinken
  pip install shinken


Method 2: Packages 
-------------------

For now the 2.4 packages are not available, but the community is working hard for it! Packages are simple, easy to update and clean.
Packages should be available on Debian/Ubuntu and Fedora/RH/CentOS soon (basically  *.deb* and  *.rpm*).


Method 3: Installation from sources 
------------------------------------

Download last stable `Shinken tarball`_ archive (or get the latest `git snapshot`_) and extract it somewhere:

::

  adduser shinken
  wget http://www.shinken-monitoring.org/pub/shinken-2.4.tar.gz
  tar -xvzf shinken-2.4.tar.gz
  cd shinken-2.4
  python setup.py install


Shinken 2.X uses LSB path. If you want to stick to one directory installation you can of course.
Default paths are the following:

 * **/etc/shinken** for configuration files
 * **/var/lib/shinken** for shinken modules, retention files...
 * **/var/log/shinken** for log files
 * **/var/run/shinken** for pid files


.. _gettingstarted/installations/shinken-installation#windows_installation:


Windows Installation 
====================

For 2.X+ the executable installer may not be provided. Consequently, installing Shinken on a Windows may be manual with setup.py.
Steps are basically the same as on Linux (Python install etc.) but in windows environment it's always a bit tricky.


.. _Python: http://www.python.org/download/
.. _python-cherrypy3: http://www.cherrypy.org/
.. _Monitoring Plugins: https://www.monitoring-plugins.org/
.. _python-pycurl: http://pycurl.sourceforge.net/
.. _setuptools: http://pypi.python.org/pypi/setuptools/
.. _git snapshot: https://github.com/naparuba/shinken/tarball/master
.. _Shinken tarball: http://www.shinken-monitoring.org/pub/shinken-2.4.tar.gz
.. _install.d/README: https://github.com/naparuba/shinken/blob/master/install.d/README