granicus.if.org Git - icinga2/blob - INSTALL

   1 Installing Icinga 2
   2 ===================
   3
   4 Please note that the current version of Icinga 2 isn't much more than a tech
   5 demo. Expect some rough edges when installing and running Icinga 2.
   6
   7 For the "finished" version we're planning to release packages for the most
   8 common Linux distributions as well as for Windows - or at least co-operate
   9 with the package maintainers.
  10
  11 Please check the documentation in the doc/ directory for a current list
  12 of available packages.
  13
  14 Build Requirements
  15 ------------------
  16
  17 The following requirements need to be fulfilled in order to build the
  18 application using a dist tarball (package names for RHEL and Debian in
  19 parentheses):
  20
  21 * cmake
  22 * GNU make (make)
  23 * C++ compiler (gcc-c++ on RHEL, build-essential on Debian)
  24 * OpenSSL library and header files (openssl-devel on RHEL, libssl-dev
  25                                     on Debian)
  26 * Boost library and header files (boost-devel on RHEL, libboost-all-dev
  27                                   on Debian)
  28 * GNU bison (bison)
  29 * GNU flex (flex)
  30 * optional: Doxygen (doxygen)
  31 * optional: MySQL (mysql-devel on RHEL, libmysqlclient-dev on Debian)
  32 * optional: Python (python-devel on RHEL, python-dev on Debian)
  33
  34 User Requirements
  35 -----------------
  36
  37 By default Icinga will run as user 'icinga' and group 'icinga'. Additionally the
  38 external command pipe and livestatus features require a dedicated command group
  39 'icingacmd'. You can choose your own user/group names and pass them to the
  40 configure script using the --with-icinga-user, --with-icinga-group,
  41 --with-icingacmd-user and --with-icingacmd-group options.
  42
  43 # groupadd icinga
  44 # groupadd icingacmd
  45 # useradd -c "icinga" -s /sbin/nologin -G icingacmd -g icinga
  46
  47 Add the web server user to the icingacmd group in order to grant it write
  48 permissions to the external command pipe and livestatus socket:
  49
  50 # usermod -a -G icingacmd www-data
  51
  52 Make sure to replace "www-data" with the name of the user your web server
  53 is running as.
  54
  55 Building Icinga 2
  56 -----------------
  57
  58 Once you have installed all the necessary build requirements you can build
  59 Icinga 2 using the following commands:
  60
  61 $ mkdir build && cd build
  62 $ cmake ..
  63 $ make
  64 $ make install
  65
  66 You can specify an alternative installation prefix using -DCMAKE_INSTALL_PREFIX:
  67
  68 $ cmake .. -DCMAKE_INSTALL_PREFIX=/tmp/icinga2
  69
  70 In addition to CMAKE_INSTALL_PREFIX the following Icinga-specific cmake
  71 variables are supported:
  72
  73 - ICINGA2_USER: The user Icinga 2 should run as; defaults to "icinga"
  74 - ICINGA2_GROUP: The group Icinga 2 should run as; defaults to "icinga"
  75 - ICINGA2_COMMAND_USER: The command user Icinga 2 should use; defaults to "icinga"
  76 - ICINGA2_COMMAND_GROUP: The command group Icinga 2 should use; default to "icingacmd"
  77 - CMAKE_INSTALL_SYSCONFDIR: The configuration directory; defaults to CMAKE_INSTALL_PREFIX/etc
  78 - CMAKE_INSTALL_LOCALSTATEDIR: The state directory; defaults to CMAKE_INSTALL_PREFIX/var
  79
  80 Running Icinga 2
  81 ----------------
  82
  83 Icinga 2 comes with a single binary that takes care of loading all the relevant
  84 components (e.g. for check execution, notifications, etc.):
  85
  86 # /usr/bin/icinga2
  87 [2013-10-22 13:06:22 +0200] <Main Thread> information/icinga-app: Icinga application loader (version: 0.0.3, git branch master, commit 07d9a59f + changes)
  88 [2013-10-22 13:06:22 +0200] <Main Thread> information/base: Adding library search dir: /usr/lib/icinga2
  89 [2013-10-22 13:06:22 +0200] <Main Thread> information/base: Loading library 'libicinga.la'
  90 [2013-10-22 13:06:22 +0200] <Main Thread> information/config: Adding include search dir: /usr/share/icinga2
  91 [2013-10-22 13:06:22 +0200] <Main Thread> critical/icinga-app: You need to specify at least one config file (using the --config option).
  92
  93 Icinga 2 can be started as daemon using the provided init script:
  94
  95 # /etc/init.d/icinga2
  96 Usage: /etc/init.d/icinga2 {start|stop|restart|reload|checkconfig|status}
  97
  98 Icinga 2 reads a single configuration file which is used to specify all
  99 configuration settings (global settings, hosts, services, etc.). The
 100 configuration format is explained in detail in the doc/ directory.
 101
 102 By default "make install" installs example configuration files in
 103 /usr/local/etc/icinga2 unless you have specified a different prefix or
 104 sysconfdir.