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

   1 # Installing Icinga 2
   2
   3 The recommended way of installing Icinga 2 is to use packages. The Icinga
   4 project provides both release and development packages for a number
   5 of operating systems.
   6
   7 Please check the documentation in the [doc/](doc/) directory for a current list
   8 of available packages and detailed installation instructions.
   9
  10 There are a number of known caveats when installing from source such as
  11 incorrect directory and file permissions. So even if you're planning to
  12 not use the official packages it is advisable to build your own Debian
  13 or RPM packages.
  14
  15 ## Build Requirements
  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 on Debian)
  25 * Boost library and header files (boost-devel on RHEL, libboost-all-dev on Debian)
  26 * GNU bison (bison)
  27 * GNU flex (flex) >= 2.5.35
  28 * recommended: libexecinfo on FreeBSD (automatically used when Icinga 2 is
  29                installed via port or package)
  30 * optional: MySQL (mysql-devel on RHEL, libmysqlclient-dev on Debian); set CMake
  31              variable `ICINGA2_WITH_MYSQL` to `OFF` to disable this module
  32 * optional: PostgreSQL (postgresql-devel on RHEL, libpq-dev on Debian); set CMake
  33             variable `ICINGA2_WITH_PGSQL` to `OFF` to disable this module
  34 * optional: YAJL (yajl-devel on RHEL, libyajl-dev on Debian)
  35 * optional: libedit (libedit-devel on RHEL, libedit-dev on Debian)
  36 * optional: Termcap (libtermcap-devel on RHEL, not necessary on Debian) - only
  37             required if libedit doesn't already link against termcap/ncurses
  38
  39 Note: RHEL5 ships an ancient flex version. Updated packages are available for
  40 example from the repoforge buildtools repository.
  41
  42 * x86: http://mirror.hs-esslingen.de/repoforge/redhat/el5/en/i386/buildtools/
  43 * x86\_64: http://mirror.hs-esslingen.de/repoforge/redhat/el5/en/x86_64/buildtools/
  44
  45 ### User Requirements
  46
  47 By default Icinga will run as user 'icinga' and group 'icinga'. Additionally the
  48 external command pipe and livestatus features require a dedicated command group
  49 'icingacmd'. You can choose your own user/group names and pass them to CMake
  50 using the `ICINGA2_USER`, `ICINGA2_GROUP` and `ICINGA2_COMMAND_GROUP` variables.
  51
  52     # groupadd icinga
  53     # groupadd icingacmd
  54     # useradd -c "icinga" -s /sbin/nologin -G icingacmd -g icinga icinga
  55
  56 Add the web server user to the icingacmd group in order to grant it write
  57 permissions to the external command pipe and livestatus socket:
  58
  59     # usermod -a -G icingacmd www-data
  60
  61 Make sure to replace "www-data" with the name of the user your web server
  62 is running as.
  63
  64 ## Building Icinga 2
  65
  66 Once you have installed all the necessary build requirements you can build
  67 Icinga 2 using the following commands:
  68
  69     $ mkdir build && cd build
  70     $ cmake ..
  71     $ make
  72     $ make install
  73
  74 You can specify an alternative installation prefix using `-DCMAKE_INSTALL_PREFIX`:
  75
  76     $ cmake .. -DCMAKE_INSTALL_PREFIX=/tmp/icinga2
  77
  78 In addition to `CMAKE_INSTALL_PREFIX` the following Icinga-specific cmake
  79 variables are supported:
  80
  81 - `ICINGA2_USER`: The user Icinga 2 should run as; defaults to `icinga`
  82 - `ICINGA2_GROUP`: The group Icinga 2 should run as; defaults to `icinga`
  83 - `ICINGA2_GIT_VERSION_INFO`: Whether to use Git to determine the version number; defaults to `ON`
  84 - `ICINGA2_COMMAND_GROUP`: The command group Icinga 2 should use; defaults to `icingacmd`
  85 - `ICINGA2_UNITY_BUILD`: Whether to perform a unity build; defaults to `ON`
  86 - `ICINGA2_LTO_BUILD`: Whether to use link time optimization (LTO); defaults to `OFF`
  87 - `ICINGA2_PLUGINDIR`: The path for the Monitoring Plugins project binaries; defaults to `/usr/lib/nagios/plugins`
  88 - `ICINGA2_RUNDIR`: The location of the "run" directory; defaults to `CMAKE_INSTALL_LOCALSTATEDIR/run`
  89 - `CMAKE_INSTALL_SYSCONFDIR`: The configuration directory; defaults to `CMAKE_INSTALL_PREFIX/etc`
  90 - `ICINGA2_SYSCONFIGFILE`: Where to put the config file the initscript/systemd pulls it's dirs from;
  91 defaults to `CMAKE_INSTALL_PREFIX/etc/sysconfig/icinga2`
  92 - `CMAKE_INSTALL_LOCALSTATEDIR`: The state directory; defaults to `CMAKE_INSTALL_PREFIX/var`
  93 - `USE_SYSTEMD=ON|OFF`: Use systemd or a classic SysV initscript; defaults to `OFF`
  94 - `INSTALL_SYSTEMD_SERVICE_AND_INITSCRIPT=ON|OFF` Force install both the systemd service definition file
  95 and the SysV initscript in parallel, regardless of how `USE_SYSTEMD` is set.
  96 Only use this for special packaging purposes and if you know what you are doing.
  97 Defaults to `OFF`.
  98 - `ICINGA2_WITH_MYSQL`: Determines whether the MySQL IDO module is built; defaults to `ON`
  99 - `ICINGA2_WITH_PGSQL`: Determines whether the PostgreSQL IDO module is built; defaults to `ON`
 100 - `ICINGA2_WITH_CHECKER`: Determines whether the checker module is built; defaults to `ON`
 101 - `ICINGA2_WITH_COMPAT`: Determines whether the compat module is built; defaults to `ON`
 102 - `ICINGA2_WITH_DEMO`: Determines whether the demo module is built; defaults to `OFF`
 103 - `ICINGA2_WITH_HELLO`: Determines whether the hello module is built; defaults to `OFF`
 104 - `ICINGA2_WITH_LIVESTATUS`: Determines whether the Livestatus module is built; defaults to `ON`
 105 - `ICINGA2_WITH_NOTIFICATION`: Determines whether the notification module is built; defaults to `ON`
 106 - `ICINGA2_WITH_PERFDATA`: Determines whether the perfdata module is built; defaults to `ON`
 107
 108 CMake determines the Icinga 2 version number using `git describe` if the
 109 source directory is contained in a Git repository. Otherwise the version number
 110 is extracted from the [icinga2.spec](icinga2.spec) file. This behavior can be
 111 overridden by creating a file called `icinga-version.h.force` in the source
 112 directory. Alternatively the `-DICINGA2_GIT_VERSION_INFO=OFF` option for CMake
 113 can be used to disable the usage of `git describe`.
 114
 115 ### Building Icinga 2 RPMs
 116
 117 Setup your build environment on RHEL/SUSE and copy the generated tarball from your git
 118 repository to `rpmbuild/SOURCES`.
 119
 120 Copy the icinga2.spec file to `rpmbuild/SPEC` and then run this command:
 121
 122     $ rpmbuild -ba SPEC/icinga2.spec
 123
 124 ### Building Icinga 2 Debs
 125
 126 Setup your build environment on Debian/Ubuntu, copy the 'debian' directory from
 127 the Debian packaging Git repository (https://anonscm.debian.org/cgit/pkg-nagios/pkg-icinga2.git)
 128 into your source tree and run the following command:
 129
 130     $ dpkg-buildpackage -uc -us
 131
 132 ## Running Icinga 2
 133
 134 Icinga 2 comes with a single binary that takes care of loading all the relevant
 135 components (e.g. for check execution, notifications, etc.):
 136
 137     # /usr/sbin/icinga2 daemon
 138     [2015-03-12 13:25:56 +0100] information/cli: Icinga application loader (version: v2.3.0-20-ga4d3713; debug)
 139     [2015-03-12 13:25:56 +0100] information/cli: Loading application type: icinga/IcingaApplication
 140     [2015-03-12 13:25:56 +0100] information/Utility: Loading library 'libicinga.dylib'
 141     [2015-03-12 13:25:56 +0100] information/ConfigCompiler: Compiling config file: /Users/gunnar/i2/etc/icinga2/icinga2.conf
 142     [2015-03-12 13:25:56 +0100] information/ConfigCompiler: Compiling config file: /Users/gunnar/i2/etc/icinga2/constants.conf
 143     ...
 144
 145 Icinga 2 can be started as a daemon using the provided init script:
 146
 147     # /etc/init.d/icinga2
 148     Usage: /etc/init.d/icinga2 {start|stop|restart|reload|checkconfig|status}
 149
 150 Or if your distribution uses systemd:
 151
 152     # systemctl {start|stop|reload|status|enable|disable} icinga2
 153
 154 Icinga 2 reads a single configuration file which is used to specify all
 155 configuration settings (global settings, hosts, services, etc.). The
 156 configuration format is explained in detail in the [doc/](doc/) directory.
 157
 158 By default `make install` installs example configuration files in
 159 `/usr/local/etc/icinga2` unless you have specified a different prefix or
 160 sysconfdir.