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

   1 Installing Icinga 2
   2 ===================
   3
   4 Please note that the current version of Icinga 2 isn't much more than a tech
   5 demo. Expect some rough edges when installing and running Icinga 2.
   6
   7 For the "finished" version we're planning to release packages for the most
   8 common Linux distributions as well as for Windows - or at least co-operate
   9 with the package maintainers.
  10
  11 Build Requirements
  12 ------------------
  13
  14 The following requirements need to be fulfilled in order to build the
  15 application using a dist tarball (package names for RHEL and Debian in
  16 parentheses):
  17
  18 * GNU make (make)
  19 * C++ compiler (gcc-c++ on RHEL, build-essential on Debian)
  20 * OpenSSL library and header files (openssl-devel on RHEL, libssl-dev
  21                                     on Debian)
  22 * Boost library and header files (boost-devel on RHEL, libboost-all-dev
  23                                   on Debian)
  24 * optional: Doxygen (doxygen)
  25 * optional: MySQL (mysql-devel on RHEL, libmysqlclient-dev on Debian)
  26 * optional: Python (python-devel on RHEL, python-dev on Debian)
  27
  28 Packaging Requirements
  29 ----------------------
  30
  31 In order to build a dist tarball for the application the following external
  32 software components need to be installed in addition to the build requirements
  33 mentioned above:
  34
  35 * GNU Automake (automake)
  36 * GNU Autoconf (autoconf)
  37 * GNU Libtool (libtool and libtool-ltdl-devel on RHEL, libtool and
  38                libltdl-dev on Debian)
  39 * GNU bison (bison)
  40 * GNU flex (flex)
  41
  42 In order to build the dist tarball (using "make dist") you need sufficiently
  43 recent versions of the packages listed above.
  44
  45 User Requirements
  46 -----------------
  47
  48 By default Icinga will run as user 'icinga' and group 'icinga'. Additionally the
  49 external command pipe and livestatus features require a dedicated command group
  50 'icingacmd'. You can choose your own user/group names and pass them to the
  51 configure script using the --with-icinga-user, --with-icinga-group,
  52 --with-icingacmd-user and --with-icingacmd-group options.
  53
  54 # groupadd icinga
  55 # groupadd icingacmd
  56 # useradd -c "icinga" -s /sbin/nologin -G icingacmd -g icinga
  57
  58 Add the web server user to the icingacmd group in order to grant it write
  59 permissions to the external command pipe and livestatus socket:
  60
  61 # usermod -a -G icingacmd www-data
  62
  63 Make sure to replace "www-data" with the name of the user your web server
  64 is running as.
  65
  66 Building Icinga 2
  67 -----------------
  68
  69 Once you have installed all the necessary build requirements you can build
  70 Icinga 2 using the following commands:
  71
  72 $ ./configure
  73 $ make
  74 $ make install
  75
  76 The configure script supports all the usual parameters one comes to expect
  77 from autoconf. In particular you may want to use --prefix to specify an
  78 alternative installation prefix.
  79
  80 Note: The Git repository does not contain any auto-generated Autotools files,
  81 i.e. there is no 'configure' script. In this case you will need to regenerate
  82 the 'configure' script by running 'autogen.sh'. However, as an end-user you
  83 should reconsider whether you really want to use the code from the Git
  84 repository. In general it is advisable to use one of the dist tarballs instead.
  85
  86 Running Icinga 2
  87 ----------------
  88
  89 Icinga 2 comes with a single binary that takes care of loading all the relevant
  90 components (e.g. for check execution, notifications, etc.):
  91
  92 $ icinga2
  93 [2012/09/14 10:36:12] information/icinga: Icinga application loader (version:
  94                       2.0, git branch master, commit 8e4bdf38 + changes)
  95 [2012/09/14 10:36:12] information/base: Syntax: icinga2 -c <config-file> ...
  96
  97 Icinga 2 reads a single configuration file which is used to specify all
  98 configuration settings (global settings, hosts, services, etc.). The
  99 configuration format is explained in detail in the docs/icinga2-config.txt
 100 file.
 101
 102 By default "make install" installs example configuration files in
 103 /usr/local/etc/icinga2 unless you have specified a different prefix or
 104 sysconfdir.