granicus.if.org Git - icinga2/blob - INSTALL

   1 Installing Icinga 2
   2 ===================
   3
   4 The recommended way of installing Icinga 2 is to use packages. The Icinga
   5 project provides both release and development packages for a number
   6 of operating systems.
   7
   8 Please check the documentation in the doc/ directory for a current list
   9 of available packages and detailed installation instructions.
  10
  11 There are a number of known caveats when installing from source such as
  12 incorrect directory and file permissions. So even if you're planning to
  13 not use the official packages it is advisable to build your own Debian
  14 or RPM packages.
  15
  16 Build Requirements
  17 ------------------
  18
  19 The following requirements need to be fulfilled in order to build the
  20 application using a dist tarball (package names for RHEL and Debian in
  21 parentheses):
  22
  23 * cmake
  24 * GNU make (make)
  25 * C++ compiler (gcc-c++ on RHEL, build-essential on Debian)
  26 * OpenSSL library and header files (openssl-devel on RHEL, libssl-dev
  27                                     on Debian)
  28 * Boost library and header files (boost-devel on RHEL, libboost-all-dev
  29                                   on Debian)
  30 * GNU bison (bison)
  31 * GNU flex (flex) >= 2.5.35
  32 * recommended: libexecinfo on FreeBSD
  33 * optional: MySQL (mysql-devel on RHEL, libmysqlclient-dev on Debian)
  34 * optional: Python (python-devel on RHEL, python-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 http://mirror.hs-esslingen.de/repoforge/redhat/el5/en/{i386,x86_64}/buildtools/
  40
  41 User Requirements
  42 -----------------
  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 the
  47 configure script using the --with-icinga-user, --with-icinga-group,
  48 --with-icingacmd-user and --with-icingacmd-group options.
  49
  50 # groupadd icinga
  51 # groupadd icingacmd
  52 # useradd -c "icinga" -s /sbin/nologin -G icingacmd -g icinga icinga
  53
  54 Add the web server user to the icingacmd group in order to grant it write
  55 permissions to the external command pipe and livestatus socket:
  56
  57 # usermod -a -G icingacmd www-data
  58
  59 Make sure to replace "www-data" with the name of the user your web server
  60 is running as.
  61
  62 Building Release Tarballs
  63 -------------------------
  64
  65 In order to build a release tarball you should first check out the Git repository
  66 in a new directory. If you're using an existing check-out you should make sure
  67 that there are no local modifications:
  68
  69 $ git status
  70
  71 Here's a short check-list for releases:
  72
  73 * Update the .mailmap and AUTHORS files
  74     $ git log --use-mailmap | grep ^Author: | cut -f2- -d' ' | sort | uniq > AUTHORS
  75 * Bump the version in icinga2.spec.
  76 * Update the ChangeLog and doc/1-about.md files.
  77 * Commit these changes to the "next" branch and create a signed tag (tags/v<VERSION>).
  78     $ git commit -v -a -m "Release version <VERSION>."
  79     $ git tag -u EE8E0720 -m "Version <VERSION>" v<VERSION>
  80     $ git push --tags
  81 * Merge the "next" branch into the "master" branch (using --ff-only).
  82     $ git checkout master
  83     $ git merge --ff-only next
  84     $ git push origin master
  85 * Bump the version to "v<NEXT-VERSION>-dev" and commit this change to the "next" branch.
  86
  87 Note: CMake determines the Icinga 2 version number using "git describe" if the
  88 source directory is contained in a Git repository. Otherwise the version number
  89 is extracted from the icinga2.spec file. This behavior can be overridden by
  90 creating a file called "icinga-version.h.force" in the source directory.
  91 Alternatively the -DICINGA2_GIT_VERSION_INFO=ON option for CMake can be used to
  92 disable the usage of "git describe".
  93
  94 Use "git archive" to build the release tarball:
  95
  96 $ git archive --format=tgz --prefix=icinga2-<VERSION>/ tags/v<VERSION>
  97
  98 Finally you should verify that the tarball only contains the files it should contain:
  99
 100 $ tar ztf icinga2-<VERSION>.tar.gz | less
 101
 102 Building Icinga 2
 103 -----------------
 104
 105 Once you have installed all the necessary build requirements you can build
 106 Icinga 2 using the following commands:
 107
 108 $ mkdir build && cd build
 109 $ cmake ..
 110 $ make
 111 $ make install
 112
 113 You can specify an alternative installation prefix using -DCMAKE_INSTALL_PREFIX:
 114
 115 $ cmake .. -DCMAKE_INSTALL_PREFIX=/tmp/icinga2
 116
 117 In addition to CMAKE_INSTALL_PREFIX the following Icinga-specific cmake
 118 variables are supported:
 119
 120 - ICINGA2_USER: The user Icinga 2 should run as; defaults to "icinga"
 121 - ICINGA2_GROUP: The group Icinga 2 should run as; defaults to "icinga"
 122 - ICINGA2_COMMAND_USER: The command user Icinga 2 should use; defaults to "icinga"
 123 - ICINGA2_GIT_VERSION_INFO: Whether to use Git to determine the version number; defaults to "ON"
 124 - ICINGA2_COMMAND_GROUP: The command group Icinga 2 should use; default to "icingacmd"
 125 - CMAKE_INSTALL_SYSCONFDIR: The configuration directory; defaults to CMAKE_INSTALL_PREFIX/etc
 126 - CMAKE_INSTALL_LOCALSTATEDIR: The state directory; defaults to CMAKE_INSTALL_PREFIX/var
 127
 128 Running Icinga 2
 129 ----------------
 130
 131 Icinga 2 comes with a single binary that takes care of loading all the relevant
 132 components (e.g. for check execution, notifications, etc.):
 133
 134 # /usr/bin/icinga2
 135 [2013-10-22 13:06:22 +0200] <Main Thread> information/icinga-app: Icinga application loader (version: 0.0.3, git branch master, commit 07d9a59f + changes)
 136 [2013-10-22 13:06:22 +0200] <Main Thread> information/base: Adding library search dir: /usr/lib/icinga2
 137 [2013-10-22 13:06:22 +0200] <Main Thread> information/base: Loading library 'libicinga.la'
 138 [2013-10-22 13:06:22 +0200] <Main Thread> information/config: Adding include search dir: /usr/share/icinga2
 139 [2013-10-22 13:06:22 +0200] <Main Thread> critical/icinga-app: You need to specify at least one config file (using the --config option).
 140
 141 Icinga 2 can be started as daemon using the provided init script:
 142
 143 # /etc/init.d/icinga2
 144 Usage: /etc/init.d/icinga2 {start|stop|restart|reload|checkconfig|status}
 145
 146 Icinga 2 reads a single configuration file which is used to specify all
 147 configuration settings (global settings, hosts, services, etc.). The
 148 configuration format is explained in detail in the doc/ directory.
 149
 150 By default "make install" installs example configuration files in
 151 /usr/local/etc/icinga2 unless you have specified a different prefix or
 152 sysconfdir.