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
7 Please check the documentation in the [doc/](doc/) directory for a current list
8 of available packages and detailed installation instructions.
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
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
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)
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 disable this module
32 * optional: PostgreSQL (postgresql-devel on RHEL, libpq-dev on Debian); set CMake
33 variable `ICINGA2_WITH_PGSQL` to disable this module
34 * optional: YAJL (yajl-devel on RHEL, libyajl-dev on Debian)
36 Note: RHEL5 ships an ancient flex version. Updated packages are available for
37 example from the repoforge buildtools repository.
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/
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.
51 # useradd -c "icinga" -s /sbin/nologin -G icingacmd -g icinga icinga
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:
56 # usermod -a -G icingacmd www-data
58 Make sure to replace "www-data" with the name of the user your web server
62 ## Building Release Tarballs
64 In order to build a release tarball you should first check out the Git repository
65 in a new directory. If you're using an existing check-out you should make sure
66 that there are no local modifications:
72 Here's a short check-list for releases:
74 Update the [.mailmap](.mailmap) and [AUTHORS](AUTHORS) files
76 $ git log --use-mailmap | grep ^Author: | cut -f2- -d' ' | sort | uniq > AUTHORS
78 Bump the version in icinga2.spec.
79 Update the [ChangeLog](ChangeLog), [doc/1-about.md](doc/1-about.md) and [INSTALL.md](INSTALL.md)
80 files using the changelog.py script.
81 Commit these changes to the "master" branch.
83 $ git commit -v -a -m "Release version <VERSION>"
85 Create a signed tag (tags/v<VERSION>).
89 $ git tag -u EE8E0720 -m "Version <VERSION>" v<VERSION>
92 $ git tag -u D14A1F16 -m "Version <VERSION>" v<VERSION>
98 Merge the "master" branch into the "support/2.3" branch (using --ff-only).
100 $ git checkout support/2.3
101 $ git merge --ff-only master
102 $ git push origin support/2.3
104 Note: CMake determines the Icinga 2 version number using `git describe` if the
105 source directory is contained in a Git repository. Otherwise the version number
106 is extracted from the [icinga2.spec](icinga2.spec) file. This behavior can be overridden by
107 creating a file called `icinga-version.h.force` in the source directory.
108 Alternatively the `-DICINGA2_GIT_VERSION_INFO=OFF` option for CMake can be used to
109 disable the usage of `git describe`.
113 Use `git archive` to build the release tarball:
116 $ git archive --format=tar --prefix=icinga2-$VERSION/ tags/v$VERSION | gzip >icinga2-$VERSION.tar.gz
118 Finally you should verify that the tarball only contains the files it should contain:
121 $ tar ztf icinga2-$VERSION.tar.gz | less
126 Once you have installed all the necessary build requirements you can build
127 Icinga 2 using the following commands:
129 $ mkdir build && cd build
134 You can specify an alternative installation prefix using `-DCMAKE_INSTALL_PREFIX`:
136 $ cmake .. -DCMAKE_INSTALL_PREFIX=/tmp/icinga2
138 In addition to `CMAKE_INSTALL_PREFIX` the following Icinga-specific cmake
139 variables are supported:
141 - `ICINGA2_USER`: The user Icinga 2 should run as; defaults to `icinga`
142 - `ICINGA2_GROUP`: The group Icinga 2 should run as; defaults to `icinga`
143 - `ICINGA2_GIT_VERSION_INFO`: Whether to use Git to determine the version number; defaults to `ON`
144 - `ICINGA2_COMMAND_GROUP`: The command group Icinga 2 should use; defaults to `icingacmd`
145 - `ICINGA2_UNITY_BUILD`: Whether to perform a unity build; defaults to `ON`
146 - `ICINGA2_LTO_BUILD`: Whether to use link time optimization (LTO); defaults to `OFF`
147 - `ICINGA2_PLUGINDIR`: The path for the Monitoring Plugins project binaries; defaults to `/usr/lib/nagios/plugins`
148 - `ICINGA2_RUNDIR`: The location of the "run" directory; defaults to `CMAKE_INSTALL_LOCALSTATEDIR/run`
149 - `CMAKE_INSTALL_SYSCONFDIR`: The configuration directory; defaults to `CMAKE_INSTALL_PREFIX/etc`
150 - `ICINGA2_SYSCONFIGFILE`: Where to put the config file the initscript/systemd pulls it's dirs from;
151 defaults to `CMAKE_INSTALL_PREFIX/etc/sysconfig/icinga2`
152 - `CMAKE_INSTALL_LOCALSTATEDIR`: The state directory; defaults to `CMAKE_INSTALL_PREFIX/var`
153 - `USE_SYSTEMD=ON|OFF`: Use systemd or a classic SysV initscript; defaults to `OFF`
154 - `INSTALL_SYSTEMD_SERVICE_AND_INITSCRIPT=ON|OFF` Force install both the systemd service definition file
155 and the SysV initscript in parallel, regardless of how `USE_SYSTEMD` is set.
156 Only use this for special packaging purposes and if you know what you are doing.
158 - `ICINGA2_WITH_MYSQL`: Determines whether the MySQL IDO module is built; defaults to `ON`
159 - `ICINGA2_WITH_PGSQL`: Determines whether the PostgreSQL IDO module is built; defaults to `ON`
160 - `ICINGA2_WITH_CHECKER`: Determines whether the checker module is built; defaults to `ON`
161 - `ICINGA2_WITH_COMPAT`: Determines whether the compat module is built; defaults to `ON`
162 - `ICINGA2_WITH_DEMO`: Determines whether the demo module is built; defaults to `OFF`
163 - `ICINGA2_WITH_HELLO`: Determines whether the hello module is built; defaults to `OFF`
164 - `ICINGA2_WITH_LIVESTATUS`: Determines whether the Livestatus module is built; defaults to `ON`
165 - `ICINGA2_WITH_NOTIFICATION`: Determines whether the notification module is built; defaults to `ON`
166 - `ICINGA2_WITH_PERFDATA`: Determines whether the perfdata module is built; defaults to `ON`
168 ### Building Icinga 2 RPMs
170 Setup your build environment on RHEL/SUSE and copy the generated tarball from your git
171 repository to `rpmbuild/SOURCES`.
172 Copy the icinga2.spec file to `rpmbuild/SPEC` and then invoke
174 $ rpmbuild -ba SPEC/icinga2.spec
176 ### Building Icinga 2 Debs
178 Setup your build environment on Debian/Ubuntu and run the following command straight from
179 the git repository checkout:
181 $ ./debian/updateversion && dpkg-buildpackage -uc -us
185 Icinga 2 comes with a single binary that takes care of loading all the relevant
186 components (e.g. for check execution, notifications, etc.):
188 # /usr/sbin/icinga2 daemon
189 [2015-03-12 13:25:56 +0100] information/cli: Icinga application loader (version: v2.3.0-20-ga4d3713; debug)
190 [2015-03-12 13:25:56 +0100] information/cli: Loading application type: icinga/IcingaApplication
191 [2015-03-12 13:25:56 +0100] information/Utility: Loading library 'libicinga.dylib'
192 [2015-03-12 13:25:56 +0100] information/ConfigCompiler: Compiling config file: /Users/gunnar/i2/etc/icinga2/icinga2.conf
193 [2015-03-12 13:25:56 +0100] information/ConfigCompiler: Compiling config file: /Users/gunnar/i2/etc/icinga2/constants.conf
196 Icinga 2 can be started as daemon using the provided init script:
198 # /etc/init.d/icinga2
199 Usage: /etc/init.d/icinga2 {start|stop|restart|reload|checkconfig|status}
201 Or if your distribution uses systemd:
203 # systemctl {start|stop|reload|status|enable|disable} icinga2.service
205 Icinga 2 reads a single configuration file which is used to specify all
206 configuration settings (global settings, hosts, services, etc.). The
207 configuration format is explained in detail in the [doc/](doc/) directory.
209 By default `make install` installs example configuration files in
210 `/usr/local/etc/icinga2` unless you have specified a different prefix or