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