README

   1 Welcome to NSCA-ng!
   2 ===================
   3
   4 The NSCA-ng package provides a client-server pair which makes the `Nagios
   5 command file' accessible from remote systems.  This allows for submitting
   6 passive check results, downtimes, and many other commands to Nagios (or
   7 compatible monitoring solutions).  See
   8
   9         <http://www.nagios.org/developerinfo/externalcommands/>
  10
  11 for the full list of available commands.
  12
  13 NSCA-ng supports TLS encryption and shared-secret authentication with
  14 client-specific passwords (based on RFC 4279), as well as fine-grained
  15 authorization control.
  16
  17 Prerequisites
  18 -------------
  19
  20 OpenSSL 1.0.0 or newer is required for building NSCA-ng (as older releases
  21 don't support pre-shared key authentication).  OpenSSL can be obtained from:
  22
  23         <http://www.openssl.org/>
  24
  25 This is the only hard dependency of the NSCA-ng client.  If the OpenSSL
  26 version provided by your operating system vendor is too old, you might want
  27 to build a private copy of OpenSSL and embed it into NSCA-ng.  This can
  28 easily be done by running the `./build-aux/make-openssl' script, which
  29 downloads the most recent OpenSSL version and installs it into the NSCA-ng
  30 source tree.  The `./configure' script (see below) will then pick that up
  31 automatically.
  32
  33 In addition to OpenSSL, the NSCA-ng server requires libConfuse 2.6 or newer,
  34 as available from:
  35
  36         <http://www.nongnu.org/confuse/>
  37
  38 In order to embed a private copy of libConfuse into NSCA-ng, you could run
  39 the `./build-aux/make-confuse' script before calling `./configure'.
  40
  41 Also, if libev 4.00 or newer is pre-installed and found by the `./configure'
  42 script, NSCA-ng will use it (by default).  Otherwise, a bundled copy of
  43 libev is embedded into NSCA-ng (by default), so this dependency is optional.
  44 The libev library can be downloaded from:
  45
  46         <http://libev.schmorp.de/>
  47
  48 Installation
  49 ------------
  50
  51 If only the client should be built, issuing the following three commands in
  52 NSCA-ng's source directory should do the trick:
  53
  54         ./configure
  55         make
  56         su root -c 'make install'
  57
  58 This installs the NSCA-ng client into appropriate subdirectories of
  59 `/usr/local'.
  60
  61 The installation process can be customized by setting environment variables
  62 and/or passing options to the `./configure' script.  Some of the more
  63 frequently used `./configure' options include:
  64
  65   --enable-server
  66         Build and install the NSCA-ng server (in addition to the client,
  67         unless `--disable-client' is specified).
  68
  69   --disable-client
  70         Don't build and install the NSCA-ng client.
  71
  72   --disable-posix-aio
  73         Don't use the POSIX AIO API.  By default, the NSCA-ng server will
  74         use the POSIX AIO API if available.
  75
  76   --prefix=PATH
  77         Install NSCA-ng into subdirectories of `PATH' instead of
  78         `/usr/local'.
  79
  80   --with-confuse=PATH
  81         Search for the libConfuse header files in `PATH'/include, and search
  82         for the libConfuse library files in `PATH'/lib.  If this option
  83         isn't specified, `./configure' will look for libConfuse in a few
  84         typical locations.
  85
  86   --with-ev=PATH
  87         Search for the libev header files in `PATH'/include, and search for
  88         the libev library files in `PATH'/lib.  If this option isn't
  89         specified, `./configure' will look for libev in a few typical
  90         locations; and if no usable version is found, a bundled copy of
  91         libev will be embedded into NSCA-ng.  In order to force usage of the
  92         included copy, `--with-ev=embedded' can be specified; while
  93         `--with-ev=external' would disallow falling back to the bundled
  94         libev code.
  95
  96   --with-openssl=PATH
  97         Search for the OpenSSL header files in `PATH'/include, and search
  98         for the OpenSSL library files in `PATH'/lib.  If this option isn't
  99         specified, `./configure' will look for OpenSSL in a few typical
 100         locations.
 101
 102 For a full list of available options and environment variables, run
 103 `./configure --help'.  See the file `INSTALL' for detailed installation
 104 instructions.
 105
 106 Configuration
 107 -------------
 108
 109 The NSCA-ng client is configured using the send_nsca.cfg(5) file, the
 110 NSCA-ng server uses the nsca-ng.cfg(5) file.  Examples of these files are
 111 installed if they don't already exist.
 112
 113         IMPORTANT:  Please set the permissions of the configuration
 114         files appropriately to make sure that only authorized users
 115         can access them.
 116
 117 A script such as `nsca-ng.init' (as provided in the `contrib' directory of
 118 this package) could be used to start and stop the NSCA-ng server.
 119
 120 Usage
 121 -----
 122
 123 Please see the scripts in the `contrib' directory for various usage
 124 examples.
 125
 126 Documentation
 127 -------------
 128
 129 Detailed information regarding the build and installation process can be
 130 found in the file `INSTALL'.
 131
 132 The NSCA-ng usage and configuration is documented in the nsca-ng(8),
 133 send_nsca(8), nsca-ng.cfg(5), and send_nsca.cfg(5) manual pages.  The
 134 commands `nsca-ng -h' and `send_nsca -h' spit out short summaries of the
 135 available command line options.
 136
 137 For each release, noteworthy changes are listed in the file `NEWS'.  Feature
 138 additions which are planned for future releases are added to the `TODO'
 139 file.
 140
 141 For copyright and license information, see the file `COPYING'.
 142
 143 Feedback
 144 --------
 145
 146 Please send any feedback to Holger Weiss <holger@weiss.in-berlin.de>.
 147
 148 # vim:set textwidth=76 joinspaces: