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