README

   1
   2
   3    OMD - the Open Monitoring Distribution
   4       <http://omdistro.org/>
   5
   6
   7 For installing Nagios you have a choice: compiling the necessary packages from
   8 source by yourself. Or you use the precompiled packages from your distribution.
   9 Self compiling and installing means you have some manual work to do. If you will
  10 use the packages from your distribution Nagios and other packages may not always
  11 be up to date.
  12
  13 This is what OMD tries to solve: more current software releases but not all the
  14 manual work of self compiling. And last but not least: you get the same
  15 installation paths and directories on all platforms. The plan is to release
  16 more often than normal linux distribution do. We try to integrate vital patches
  17 in order to close the gap between releasing the patch and including it in the
  18 mainstream source.
  19
  20 What OMD contains
  21 -----------------
  22
  23 OMD is no new Linux distribution. It is a collection of different software
  24 packages round about Nagios:
  25
  26   * nagios
  27   * NagVis
  28   * PNP4Nagios
  29   * rrdtool including rrdcached
  30   * nagios-plugins
  31   * Check_MK
  32   * Check_MK Multisite
  33   * MK Livestatus
  34   * dokuwiki
  35   * NSCA
  36   * check_nrpe
  37   * Thruk
  38   * check_oracle_health
  39   * check_mysql_health
  40   * check_multi
  41   * check_webinject
  42   * Shinken (still experimental)
  43   * MOD Gearman
  44   * jmx4perl
  45   * others...
  46
  47 Features
  48 --------
  49
  50 * More than one instance per host
  51
  52   OMD supports multiple but separated Nagios instances on the same machine,
  53   i.e. for one production usage and one test environment.
  54
  55 * Separate omd user per instance
  56
  57   Each instance has its own user.
  58
  59 * Script based tarball building
  60
  61   If you decide to compile omd for yourself, you get a single tarball with all
  62   necessary paths and binaries. Installing this tarball on hosts is as simple
  63   as extracting a common tar file.
  64
  65 * Simple creation of new sites
  66
  67   OMD create mysite create the site and omd start starts all stuff.
  68
  69 * Supporting different omd version at the same time
  70
  71   You can install different versions in parallel, i.e. running your production
  72   instance with the last hard rock version and using the most current version
  73   in your test environment. There is an omd upgrade available, but at this time
  74   don't rely on it, it is experimental!
  75
  76 * Platform independent paths
  77
  78   OMD installs to /opt/omd on all platforms. If you don't like this, you can
  79   symlink omd to every location you want.
  80
  81 Licensing
  82 ---------
  83 OMD is available under the terms of the GNU General Public License of
  84 version 2.  You find those terms in the file COPYING. Please note, that that
  85 license only applies to OMD itself (its scripts, patches, configuration files,
  86 etc.). The licenses of the packages it ships may differ. Please checkout
  87 those packages for details on their licensing.
  88
  89 Further information
  90 -------------------
  91 Visit the OMD homepage at http://omdistro.org for online documentation,
  92 new releases, information on the mailing lists, etc.
  93
  94 Some german documentation is available under http://mathias-kettner.de/omd.html.
  95