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