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
  29 * optional: MySQL (mysql-devel on RHEL, libmysqlclient-dev on Debian)
  30 * optional: PostgreSQL (postgresql-devel on RHEL, libpq-dev on Debian)
  31 * optional: YAJL (yajl-devel on RHEL, libyajl-dev on Debian)
  32
  33 Note: RHEL5 ships an ancient flex version. Updated packages are available for
  34 example from the repoforge buildtools repository.
  35
  36 * x86: http://mirror.hs-esslingen.de/repoforge/redhat/el5/en/i386/buildtools/
  37 * x86\_64: http://mirror.hs-esslingen.de/repoforge/redhat/el5/en/x86_64/buildtools/
  38
  39 ### User Requirements
  40
  41 By default Icinga will run as user 'icinga' and group 'icinga'. Additionally the
  42 external command pipe and livestatus features require a dedicated command group
  43 'icingacmd'. You can choose your own user/group names and pass them to CMake
  44 using the `ICINGA2_USER`, `ICINGA2_GROUP` and `ICINGA2_COMMAND_GROUP` variables.
  45
  46     # groupadd icinga
  47     # groupadd icingacmd
  48     # useradd -c "icinga" -s /sbin/nologin -G icingacmd -g icinga icinga
  49
  50 Add the web server user to the icingacmd group in order to grant it write
  51 permissions to the external command pipe and livestatus socket:
  52
  53     # usermod -a -G icingacmd www-data
  54
  55 Make sure to replace "www-data" with the name of the user your web server
  56 is running as.
  57
  58
  59 ## Building Release Tarballs
  60
  61 In order to build a release tarball you should first check out the Git repository
  62 in a new directory. If you're using an existing check-out you should make sure
  63 that there are no local modifications:
  64
  65     $ git status
  66
  67 ### Release Checklist
  68
  69 Here's a short check-list for releases:
  70
  71 Update the [.mailmap](.mailmap) and [AUTHORS](AUTHORS) files
  72
  73     $ git log --use-mailmap | grep ^Author: | cut -f2- -d' ' | sort | uniq > AUTHORS
  74
  75 Bump the version in icinga2.spec.
  76 Update the [ChangeLog](ChangeLog) and [doc/1-about.md](doc/1-about.md) files.
  77 Commit these changes to the "master" branch.
  78
  79     $ git commit -v -a -m "Release version <VERSION>"
  80
  81 Create a signed tag (tags/v<VERSION>).
  82
  83 GB:
  84
  85     $ git tag -u EE8E0720 -m "Version <VERSION>" v<VERSION>
  86 MF:
  87
  88     $ git tag -u D14A1F16 -m "Version <VERSION>" v<VERSION>
  89
  90 Push the tag.
  91
  92     $ git push --tags
  93
  94 Merge the "master" branch into the "support/2.1" branch (using --ff-only).
  95
  96     $ git checkout support/2.1
  97     $ git merge --ff-only master
  98     $ git push origin support/2.1
  99
 100 Note: CMake determines the Icinga 2 version number using `git describe` if the
 101 source directory is contained in a Git repository. Otherwise the version number
 102 is extracted from the [icinga2.spec](icinga2.spec) file. This behavior can be overridden by
 103 creating a file called `icinga-version.h.force` in the source directory.
 104 Alternatively the `-DICINGA2_GIT_VERSION_INFO=ON option` for CMake can be used to
 105 disable the usage of `git describe`.
 106
 107 ### Build Tarball
 108
 109 Use `git archive` to build the release tarball:
 110
 111     $ VERSION=2.1.0
 112     $ git archive --format=tar --prefix=icinga2-$VERSION/ tags/v$VERSION | gzip >icinga2-$VERSION.tar.gz
 113
 114 Finally you should verify that the tarball only contains the files it should contain:
 115
 116     $ VERSION=2.1.0
 117     $ tar ztf icinga2-$VERSION.tar.gz | less
 118
 119
 120 ## Building Icinga 2
 121
 122 Once you have installed all the necessary build requirements you can build
 123 Icinga 2 using the following commands:
 124
 125     $ mkdir build && cd build
 126     $ cmake ..
 127     $ make
 128     $ make install
 129
 130 You can specify an alternative installation prefix using `-DCMAKE_INSTALL_PREFIX`:
 131
 132     $ cmake .. -DCMAKE_INSTALL_PREFIX=/tmp/icinga2
 133
 134 In addition to `CMAKE_INSTALL_PREFIX` the following Icinga-specific cmake
 135 variables are supported:
 136
 137 - `ICINGA2_USER`: The user Icinga 2 should run as; defaults to `icinga`
 138 - `ICINGA2_GROUP`: The group Icinga 2 should run as; defaults to `icinga`
 139 - `ICINGA2_GIT_VERSION_INFO`: Whether to use Git to determine the version number; defaults to `ON`
 140 - `ICINGA2_COMMAND_GROUP`: The command group Icinga 2 should use; defaults to `icingacmd`
 141 - `ICINGA2_UNITY_BUILD`: Whether to perform a unity build
 142 - `ICINGA2_PLUGINDIR`: The path for the Monitoring Plugins project binaries; defaults to `/usr/lib/nagios/plugins`
 143 - `ICINGA2_RUNDIR`: The location of the "run" directory; defaults to `CMAKE_INSTALL_LOCALSTATEDIR/run`
 144 - `CMAKE_INSTALL_SYSCONFDIR`: The configuration directory; defaults to `CMAKE_INSTALL_PREFIX/etc`
 145 - `ICINGA2_SYSCONFIGFILE`: Where to put the config file the initscript/systemd pulls it's dirs from;
 146 defaults to `CMAKE_INSTALL_PREFIX/etc/sysconfig/icinga2`
 147 - `CMAKE_INSTALL_LOCALSTATEDIR`: The state directory; defaults to `CMAKE_INSTALL_PREFIX/var`
 148 - `USE_SYSTEMD=ON|OFF`: Use systemd or a classic SysV initscript; defaults to `OFF`
 149 - `INSTALL_SYSTEMD_SERVICE_AND_INITSCRIPT=ON|OFF` Force install both the systemd service definition file
 150 and the SysV initscript in parallel, regardless of how `USE_SYSTEMD` is set.
 151 Only use this for special packaging purposes and if you know what you are doing.
 152 Defaults to `OFF`.
 153
 154 ### Building Icinga 2 RPMs
 155
 156 Setup your build environment on RHEL/SUSE and copy the generated tarball from your git
 157 repository to `rpmbuild/SOURCES`.
 158 Copy the icinga2.spec file to `rpmbuild/SPEC` and then invoke
 159
 160     $ rpmbuild -ba SPEC/icinga2.spec
 161
 162 ### Building Icinga 2 Debs
 163
 164 Setup your build environment on Debian/Ubuntu and run the following command straight from
 165 the git repository checkout:
 166
 167     $ ./debian/updateversion && dpkg-buildpackage -uc -us
 168
 169 ## Running Icinga 2
 170
 171 Icinga 2 comes with a single binary that takes care of loading all the relevant
 172 components (e.g. for check execution, notifications, etc.):
 173
 174     # /usr/sbin/icinga2
 175     [2014-06-13 15:29:16 +0200] information/icinga-app: Icinga application loader (version: v2.0.0-beta2-17-gd9289ad)
 176     [2014-06-13 15:29:16 +0200] information/icinga-app: Loading application type: icinga/IcingaApplication
 177     [2014-06-13 15:29:16 +0200] information/Utility: Loading library 'libicinga.so'
 178     [2014-06-13 15:29:16 +0200] information/ConfigCompiler: Adding include search dir: /usr/share/icinga2/include
 179     [2014-06-13 15:29:16 +0200] critical/icinga-app: You need to specify at least one config file (using the --config option).
 180
 181 Icinga 2 can be started as daemon using the provided init script:
 182
 183     # /etc/init.d/icinga2
 184     Usage: /etc/init.d/icinga2 {start|stop|restart|reload|checkconfig|status}
 185
 186 Or if your distribution uses systemd:
 187
 188     # systemctl {start|stop|reload|status|enable|disable} icinga2.service
 189
 190 Icinga 2 reads a single configuration file which is used to specify all
 191 configuration settings (global settings, hosts, services, etc.). The
 192 configuration format is explained in detail in the [doc/](doc/) directory.
 193
 194 By default `make install` installs example configuration files in
 195 `/usr/local/etc/icinga2` unless you have specified a different prefix or
 196 sysconfdir.