]> granicus.if.org Git - icinga2/blobdiff - INSTALL.md
Improve error reporting for the import keyword
[icinga2] / INSTALL.md
index 1fad5b71c5dcbd02a07f2ba6a6d1b3404795215b..f043bd80058b24f26d97ad6829c341240a2ab6e3 100644 (file)
@@ -27,10 +27,12 @@ parentheses):
 * GNU flex (flex) >= 2.5.35
 * recommended: libexecinfo on FreeBSD (automatically used when Icinga 2 is
                installed via port or package)
-* optional: MySQL (mysql-devel on RHEL, libmysqlclient-dev on Debian) set CMake
-             variable `ICINGA2_WITH_MYSQL` to enable
-* optional: PostgreSQL (postgresql-devel on RHEL, libpq-dev on Debian) set CMake
-            variable `ICINGA2_WITH_PGSQL` to enable
+* recommended: GNU readline (readline-devel on RHEL, libreadline-dev on Debian)
+* recommended: ncurses (ncurses-devel on RHEL, libncurses-dev on Debian)
+* optional: MySQL (mysql-devel on RHEL, libmysqlclient-dev on Debian); set CMake
+             variable `ICINGA2_WITH_MYSQL` to disable this module
+* optional: PostgreSQL (postgresql-devel on RHEL, libpq-dev on Debian); set CMake
+            variable `ICINGA2_WITH_PGSQL` to disable this module
 * optional: YAJL (yajl-devel on RHEL, libyajl-dev on Debian)
 
 Note: RHEL5 ships an ancient flex version. Updated packages are available for
@@ -94,11 +96,11 @@ Push the tag.
 
     $ git push --tags
     
-Merge the "master" branch into the "support/2.1" branch (using --ff-only).
+Merge the "master" branch into the "support/2.2" branch (using --ff-only).
 
-    $ git checkout support/2.1
+    $ git checkout support/2.2
     $ git merge --ff-only master
-    $ git push origin support/2.1
+    $ git push origin support/2.2
 
 Note: CMake determines the Icinga 2 version number using `git describe` if the
 source directory is contained in a Git repository. Otherwise the version number
@@ -111,12 +113,12 @@ disable the usage of `git describe`.
 
 Use `git archive` to build the release tarball:
 
-    $ VERSION=2.1.0
+    $ VERSION=2.2.2
     $ git archive --format=tar --prefix=icinga2-$VERSION/ tags/v$VERSION | gzip >icinga2-$VERSION.tar.gz
 
 Finally you should verify that the tarball only contains the files it should contain:
 
-    $ VERSION=2.1.0
+    $ VERSION=2.2.2
     $ tar ztf icinga2-$VERSION.tar.gz | less
 
 
@@ -153,6 +155,15 @@ defaults to `CMAKE_INSTALL_PREFIX/etc/sysconfig/icinga2`
 and the SysV initscript in parallel, regardless of how `USE_SYSTEMD` is set. 
 Only use this for special packaging purposes and if you know what you are doing.
 Defaults to `OFF`.
+- `ICINGA2_WITH_MYSQL`: Determines whether the MySQL IDO module is built; defaults to `ON`
+- `ICINGA2_WITH_PGSQL`: Determines whether the PostgreSQL IDO module is built; defaults to `ON`
+- `ICINGA2_WITH_CHECKER`: Determines whether the checker module is built; defaults to `ON`
+- `ICINGA2_WITH_COMPAT`: Determines whether the compat module is built; defaults to `ON`
+- `ICINGA2_WITH_DEMO`: Determines whether the demo module is built; defaults to `OFF`
+- `ICINGA2_WITH_HELLO`: Determines whether the hello module is built; defaults to `OFF`
+- `ICINGA2_WITH_LIVESTATUS`: Determines whether the Livestatus module is built; defaults to `ON`
+- `ICINGA2_WITH_NOTIFICATION`: Determines whether the notification module is built; defaults to `ON`
+- `ICINGA2_WITH_PERFDATA`: Determines whether the perfdata module is built; defaults to `ON`
 
 ### Building Icinga 2 RPMs
 
@@ -174,12 +185,13 @@ the git repository checkout:
 Icinga 2 comes with a single binary that takes care of loading all the relevant
 components (e.g. for check execution, notifications, etc.):
 
-    # /usr/sbin/icinga2
-    [2014-06-13 15:29:16 +0200] information/icinga-app: Icinga application loader (version: v2.0.0-beta2-17-gd9289ad)
-    [2014-06-13 15:29:16 +0200] information/icinga-app: Loading application type: icinga/IcingaApplication
-    [2014-06-13 15:29:16 +0200] information/Utility: Loading library 'libicinga.so'
-    [2014-06-13 15:29:16 +0200] information/ConfigCompiler: Adding include search dir: /usr/share/icinga2/include
-    [2014-06-13 15:29:16 +0200] critical/icinga-app: You need to specify at least one config file (using the --config option).
+    # /usr/sbin/icinga2 daemon
+    [2014-12-18 10:20:49 +0100] information/cli: Icinga application loader (version: v2.2.2)
+    [2014-12-18 10:20:49 +0100] information/cli: Loading application type: icinga/IcingaApplication
+    [2014-12-18 10:20:49 +0100] information/Utility: Loading library 'libicinga.so'
+    [2014-12-18 10:20:49 +0100] information/ConfigCompiler: Compiling config file: /home/gbeutner/i2/etc/icinga2/icinga2.conf
+    [2014-12-18 10:20:49 +0100] information/ConfigCompiler: Compiling config file: /home/gbeutner/i2/etc/icinga2/constants.conf
+    ...
 
 Icinga 2 can be started as daemon using the provided init script: