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 The online documentation is available on [icinga.com/docs](https://www.icinga.com/docs/)
11 and will guide you step by step.
13 There are a number of known caveats when installing from source such as
14 incorrect directory and file permissions. So even if you're planning to
15 not use the official packages it is advisable to build your own Debian
20 This information is intended for developers and packagers. It might be incomplete or unclear
21 in some cases. Make also sure to check our [packaging scripts on GitHub](https://github.com/Icinga/icinga-packaging)!
25 The following requirements need to be fulfilled in order to build the
26 application using a dist tarball (including notes for distributions):
29 * GNU make (make) or ninja-build
30 * C++ compiler which supports C++11
31 - RHEL/Fedora/SUSE: gcc-c++ >= 4.7 (extra Developer Tools on RHEL5/6 see below)
32 - Debian/Ubuntu: build-essential
34 - you can also use clang++
36 * OpenSSL library and header files >= 1.0.1
37 - RHEL/Fedora: openssl-devel
38 - SUSE: libopenssl-devel (for SLES 11: libopenssl1-devel)
39 - Debian/Ubuntu: libssl-dev
40 - Alpine: libressl-dev
41 * Boost library and header files >= 1.48.0
42 - RHEL/Fedora: boost148-devel
43 - Debian/Ubuntu: libboost-all-dev
46 * GNU flex (flex) >= 2.5.35
50 * MySQL (disable with CMake variable `ICINGA2_WITH_MYSQL` to `OFF`)
51 - RHEL/Fedora: mysql-devel
52 - SUSE: libmysqlclient-devel
53 - Debian/Ubuntu: default-libmysqlclient-dev | libmysqlclient-dev
55 * PostgreSQL (disable with CMake variable `ICINGA2_WITH_PGSQL` to `OFF`)
56 - RHEL/Fedora: postgresql-devel
57 - Debian/Ubuntu: libpq-dev
58 - postgresql-dev on Alpine
59 * YAJL (Faster JSON library)
60 - RHEL/Fedora: yajl-devel
63 * libedit (CLI console)
64 - RHEL/Fedora: libedit-devel on CentOS (RHEL requires rhel-7-server-optional-rpms)
65 - Debian/Ubuntu/Alpine: libedit-dev
66 * Termcap (only required if libedit doesn't already link against termcap/ncurses)
67 - RHEL/Fedora: libtermcap-devel
68 - Debian/Ubuntu: (not necessary)
69 * wxWidgets (only required when building the Icinga 2 Studio)
70 - Fedora: wxGTK-devel and wxBase
71 - Debian/Ubuntu: libwxgtk2.8-dev
73 ## Special requirements
75 **FreeBSD**: libexecinfo (automatically used when Icinga 2 is installed via port or package)
77 **RHEL5** ships an ancient flex version. Updated packages are available for
78 example from the repoforge buildtools repository.
80 * x86: https://mirror.hs-esslingen.de/repoforge/redhat/el5/en/i386/buildtools/
81 * x86\_64: https://mirror.hs-esslingen.de/repoforge/redhat/el5/en/x86\_64/buildtools/
83 ## Runtime user environment
85 By default Icinga will run as user 'icinga' and group 'icinga'. Additionally the
86 external command pipe and livestatus features require a dedicated command group
87 'icingacmd'. You can choose your own user/group names and pass them to CMake
88 using the `ICINGA2_USER`, `ICINGA2_GROUP` and `ICINGA2_COMMAND_GROUP` variables.
92 # useradd -c "icinga" -s /sbin/nologin -G icingacmd -g icinga icinga
95 On Alpine (which uses ash busybox) you can run:
98 # addgroup -S icingacmd
99 # adduser -S -D -H -h /var/spool/icinga2 -s /sbin/nologin -G icinga -g icinga icinga
100 # adduser icinga icingacmd
103 Add the web server user to the icingacmd group in order to grant it write
104 permissions to the external command pipe and livestatus socket:
106 # usermod -a -G icingacmd www-data
109 Make sure to replace "www-data" with the name of the user your web server
114 Once you have installed all the necessary build requirements you can build
115 Icinga 2 using the following commands:
117 $ mkdir build && cd build
123 You can specify an alternative installation prefix using `-DCMAKE_INSTALL_PREFIX`:
125 $ cmake .. -DCMAKE_INSTALL_PREFIX=/tmp/icinga2
130 In addition to `CMAKE_INSTALL_PREFIX` here are most of the supported Icinga-specific cmake variables.
132 **System Environment**
133 - `ICINGA2_GIT_VERSION_INFO`: Whether to use Git to determine the version number; defaults to `ON`
134 - `ICINGA2_USER`: The user Icinga 2 should run as; defaults to `icinga`
135 - `ICINGA2_GROUP`: The group Icinga 2 should run as; defaults to `icinga`
136 - `ICINGA2_COMMAND_GROUP`: The command group Icinga 2 should use; defaults to `icingacmd`
137 - `ICINGA2_RUNDIR`: The location of the "run" directory; defaults to `CMAKE_INSTALL_LOCALSTATEDIR/run`
138 - `CMAKE_INSTALL_SYSCONFDIR`: The configuration directory; defaults to `CMAKE_INSTALL_PREFIX/etc`
139 - `ICINGA2_SYSCONFIGFILE`: Where to put the config file the initscript/systemd pulls it's dirs from;
140 defaults to `CMAKE_INSTALL_PREFIX/etc/sysconfig/icinga2`
141 - `CMAKE_INSTALL_LOCALSTATEDIR`: The state directory; defaults to `CMAKE_INSTALL_PREFIX/var`
142 - `ICINGA2_PLUGINDIR`: The path for the Monitoring Plugins project binaries; defaults to `/usr/lib/nagios/plugins`
144 **Build Optimization**
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`
149 - `USE_SYSTEMD=ON|OFF`: Use systemd or a classic SysV initscript; defaults to `OFF`
150 - `INSTALL_SYSTEMD_SERVICE_AND_INITSCRIPT=ON|OFF` Force install both the systemd service definition file
151 and the SysV initscript in parallel, regardless of how `USE_SYSTEMD` is set.
152 Only use this for special packaging purposes and if you know what you are doing.
156 - `ICINGA2_WITH_CHECKER`: Determines whether the checker module is built; defaults to `ON`
157 - `ICINGA2_WITH_COMPAT`: Determines whether the compat module is built; defaults to `ON`
158 - `ICINGA2_WITH_DEMO`: Determines whether the demo module is built; defaults to `OFF`
159 - `ICINGA2_WITH_HELLO`: Determines whether the hello module is built; defaults to `OFF`
160 - `ICINGA2_WITH_LIVESTATUS`: Determines whether the Livestatus module is built; defaults to `ON`
161 - `ICINGA2_WITH_NOTIFICATION`: Determines whether the notification module is built; defaults to `ON`
162 - `ICINGA2_WITH_PERFDATA`: Determines whether the perfdata module is built; defaults to `ON`
163 - `ICINGA2_WITH_STUDIO`: Determines whether the Icinga Studio application is built; defaults to `OFF`
164 - `ICINGA2_WITH_TESTS`: Determines whether the unit tests are built; defaults to `ON`
166 **MySQL or MariaDB:**
168 The following settings can be tuned for the MySQL / MariaDB IDO feature.
170 - `ICINGA2_WITH_MYSQL`: Determines whether the MySQL IDO module is built; defaults to `ON`
171 - `MYSQL_CLIENT_LIBS`: Client implementation used (mysqlclient / mariadbclient); defaults searches for `mysqlclient` and `mariadbclient`
172 - `MYSQL_INCLUDE_DIR`: Directory containing include files for the mysqlclient; default empty -
173 checking multiple paths like `/usr/include/mysql`
175 See [FindMySQL.cmake](third-party/cmake/FindMySQL.cmake) for the implementation.
179 The following settings can be tuned for the PostgreSQL IDO feature.
181 - `ICINGA2_WITH_PGSQL`: Determines whether the PostgreSQL IDO module is built; defaults to `ON`
182 - `PostgreSQL_INCLUDE_DIR`: Top-level directory containing the PostgreSQL include directories
183 - `PostgreSQL_LIBRARY_DIR`: Top-level directory containing the PostgreSQL libraries
185 See [FindMySQL.cmake](third-party/cmake/FindPostgreSQL.cmake) for the implementation.
187 **Version detection:**
189 CMake determines the Icinga 2 version number using `git describe` if the
190 source directory is contained in a Git repository. Otherwise the version number
191 is extracted from the [icinga2.spec](icinga2.spec) file. This behavior can be
192 overridden by creating a file called `icinga-version.h.force` in the source
193 directory. Alternatively the `-DICINGA2_GIT_VERSION_INFO=OFF` option for CMake
194 can be used to disable the usage of `git describe`.
198 > **WARNING:** Some of this information is outdated!
202 ### Build Environment on RHEL, CentOS, Fedora, Amazon Linux
204 Setup your build environment:
206 yum -y install rpmdevtools
209 ### Build Environment on SuSE/SLES
213 zypper addrepo http://download.opensuse.org/repositories/devel:tools/SLE_12_SP2/devel:tools.repo
215 zypper install rpmdevtools spectool
220 zypper addrepo http://download.opensuse.org/repositories/devel:tools/openSUSE_Leap_42.3/devel:tools.repo
222 zypper install rpmdevtools spectool
227 Prepare the rpmbuild directory tree:
233 Copy the icinga2.spec file to `rpmbuild/SPEC` or fetch the latest version:
235 curl https://raw.githubusercontent.com/Icinga/icinga2/master/icinga2.spec -o $HOME/rpmbuild/SPECS/icinga2.spec
238 Copy the tarball to `rpmbuild/SOURCES` e.g. by using the `spectool` binary
239 provided with `rpmdevtools`:
241 cd $HOME/rpmbuild/SOURCES
242 spectool -g ../SPECS/icinga2.spec
247 Install the build dependencies. Example for CentOS 7:
249 yum -y install libedit-devel ncurses-devel gcc-c++ libstdc++-devel openssl-devel \
250 cmake flex bison boost-devel systemd mysql-devel postgresql-devel httpd \
251 selinux-policy-devel checkpolicy selinux-policy selinux-policy-doc
254 Note: If you are using Amazon Linux, systemd is not required.
256 A shorter way is available using the `yum-builddep` command on RHEL based systems:
258 yum-builddep SPECS/icinga2.spec
263 rpmbuild -ba SPECS/icinga2.spec
268 #### SELinux policy module
270 The following packages are required to build the SELinux policy module:
273 * selinux-policy (selinux-policy on CentOS 6, selinux-policy-devel on CentOS 7)
276 #### RHEL/CentOS 5 and 6
278 The RedHat Developer Toolset is required for building Icinga 2 beforehand.
279 This contains a modern version of flex and a C++ compiler which supports
282 cat >/etc/yum.repos.d/devtools-2.repo <<REPO
283 [testing-devtools-2-centos-\$releasever]
284 name=testing 2 devtools for CentOS $releasever
285 baseurl=https://people.centos.org/tru/devtools-2/\$releasever/\$basearch/RPMS
290 Dependencies to devtools-2 are used in the RPM SPEC, so the correct tools
291 should be used for building.
293 As an alternative, you can use newer Boost packages provided on
294 [packages.icinga.com](https://packages.icinga.com/epel).
296 cat >$HOME/.rpmmacros <<MACROS
303 If you prefer to build packages offline, a suitable Vagrant box is located
304 [here](https://atlas.hashicorp.com/mvbcoding/boxes/awslinux/).
308 The Icinga repository provides the required boost package version and must be
309 added before building.
311 ## Build Debian/Ubuntu packages
313 > **WARNING:** This information is outdated!
315 Setup your build environment on Debian/Ubuntu, copy the 'debian' directory from
316 the Debian packaging Git repository (https://github.com/Icinga/pkg-icinga2-debian)
317 into your source tree and run the following command:
319 $ dpkg-buildpackage -uc -us
322 ## Build Alpine Linux packages
324 A simple way to setup a build environment is installing Alpine in a chroot.
325 In this way, you can set up an Alpine build environment in a chroot under a
326 different Linux distro.
327 There is a script that simplifies these steps with just two commands, and
328 can be found [here](https://github.com/alpinelinux/alpine-chroot-install).
330 Once the build environment is installed, you can setup the system to build
331 the packages by following [this document](https://wiki.alpinelinux.org/wiki/Creating_an_Alpine_package).
333 # Build Post Install Tasks
335 After building Icinga 2 yourself, your package build system should at least run the following post
336 install requirements:
338 * enable the `checker`, `notification` and `mainlog` feature by default
339 * run 'icinga2 api setup' in order to enable the `api` feature and generate SSL certificates for the node
343 Icinga 2 comes with a binary that takes care of loading all the relevant
344 components (e.g. for check execution, notifications, etc.):
347 [2016-12-08 16:44:24 +0100] information/cli: Icinga application loader (version: v2.5.4-231-gb10a6b7; debug)
348 [2016-12-08 16:44:24 +0100] information/cli: Loading configuration file(s).
349 [2016-12-08 16:44:25 +0100] information/ConfigItem: Committing config item(s).
355 Icinga 2 can be started as a daemon using the provided init script:
357 # /etc/init.d/icinga2
358 Usage: /etc/init.d/icinga2 {start|stop|restart|reload|checkconfig|status}
363 If your distribution uses Systemd:
365 # systemctl {start|stop|reload|status|enable|disable} icinga2
368 In case the distribution is running Systemd >227, you'll also
369 need to package and install the `etc/initsystem/icinga2.service.limits.conf`
370 file into `/etc/systemd/system/icinga2.service.d`.
374 Or if your distribution uses openrc (like Alpine):
377 Usage: /etc/init.d/icinga2 {start|stop|restart|reload|checkconfig|status}
380 Note: the openrc's init.d is not shipped by default.
381 A working init.d with openrc can be found here: (https://git.alpinelinux.org/cgit/aports/plain/community/icinga2/icinga2.initd). If you have customized some path, edit the file and adjust it according with your setup.
382 Those few steps can be followed:
384 # wget https://git.alpinelinux.org/cgit/aports/plain/community/icinga2/icinga2.initd
385 # mv icinga2.initd /etc/init.d/icinga2
386 # chmod +x /etc/init.d/icinga2
389 Icinga 2 reads a single configuration file which is used to specify all
390 configuration settings (global settings, hosts, services, etc.). The
391 configuration format is explained in detail in the [doc/](doc/) directory.
393 By default `make install` installs example configuration files in
394 `/usr/local/etc/icinga2` unless you have specified a different prefix or