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