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