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