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 in parenthesis):
  16
  17 * GNU make (make on RHEL and Debian)
  18 * C++ compiler (gcc-c++ on RHEL, build-essential on Debian)
  19 * OpenSSL library and header files (openssl-devel on RHEL, libssl-dev
  20                                     on Debian)
  21 * Boost library and header files (boost-devel on RHEL, libboost-all-dev
  22                                   on Debian)
  23 * optional: Doxygen (doxygen on RHEL and Debian)
  24
  25 Packaging Requirements
  26 ----------------------
  27
  28 In order to build a dist tarball for the application the following external
  29 software components need to be installed in addition to the build requirements
  30 mentioned above:
  31
  32 * GNU Automake (automake on RHEL and Debian)
  33 * GNU Autoconf (autoconf on RHEL and Debian)
  34 * GNU Libtool (libtool and libtool-ltdl-devel on RHEL, libtool and
  35                libltdl-dev on Debian)
  36 * GNU bison (bison on RHEL and Debian)
  37 * GNU flex (flex on RHEL and Debian)
  38
  39 Debian Packages
  40 ---------------
  41
  42 This program comes with its own Debian packaging scripts which may or may not
  43 fully comply with the official Debian packaging requirements. These scripts can
  44 be found in the 'debian' sub-directory. Binary packages can be built using
  45 'dpkg-buildpackage'.
  46
  47 Building Icinga 2
  48 -----------------
  49
  50 Once you have installed all the necessary build requirements you can build
  51 Icinga 2 using the following commands:
  52
  53 $ ./configure
  54 $ make
  55 $ make install
  56
  57 The configure script supports all the usual parameters one comes to expect
  58 from autoconf. In particular you may want to use --prefix to specify an
  59 alternative installation prefix.
  60
  61 Note: The Git repository does not contain any auto-generated Autotools files,
  62 i.e. there is no 'configure' script. In this case you will need to regenerate
  63 the 'configure' script by running 'autogen.sh'. However, as an end-user you
  64 should reconsider whether you really want to use the code from the Git
  65 repository. In general it is advisable to use one of the dist tarballs instead.
  66
  67 Running Icinga 2
  68 ----------------
  69
  70 Icinga 2 comes with a single binary that takes care of loading all the relevant
  71 components (e.g. for check execution, notifications, etc.):
  72
  73 $ /tmp/i2/bin/icinga
  74 [2012/09/14 10:36:12] information/icinga: Icinga application loader (version:
  75                       2.0, git branch master, commit 8e4bdf38 + changes)
  76 [2012/09/14 10:36:12] information/base: Syntax: ./bin/icinga -c <config-file> ...
  77
  78 Icinga 2 reads a single configuration file which is used to specify all
  79 configuration settings (global settings, hosts, services, etc.). The
  80 configuration format is explained in detail in the docs/icinga2-config.txt
  81 file.
  82
  83 By default "make install" installs example configuration files to /etc/icinga2
  84 unless you have specified a different prefix or sysconfdir.