README

   1 Nagios Plugins
   2 ==============
   3
   4 * For instructions on installing these plugins for use with Nagios,
   5   see below.  In addition, generic instructions for the GNU toolchain can be
   6   found in the `INSTALL` file.
   7
   8 * For major changes between releases, read the `NEWS` file.
   9
  10 * For information on detailed changes that have been made or plugins
  11   that have been added, read the `ChangeLog` file.
  12
  13 * Some plugins require that you have additional programs and/or
  14   libraries installed on your system before they can be used.  Plugins that
  15   are dependent on other programs/libraries that are missing are usually not
  16   compiled.  Read the `REQUIREMENTS` file for more information.
  17
  18 * Individual plugins are self-documenting.  All plugins that comply with
  19   the basic guidelines for development will provide detailed help when
  20   invoked with the `-h` or `--help` options.
  21
  22 You can check for the latest plugins at:
  23
  24 * <https://www.nagios-plugins.org/>
  25
  26 Send an email to <nagiosplug-help@lists.sourceforge.net> for assistance.
  27 Please include the OS type and version that you are using.  Also, run the
  28 plugin with the `-vvv` option and provide the resulting version information.
  29 Of course, there may be additional diagnostic information required as well.
  30 Use good judgment.
  31
  32 Send an email to <nagiosplug-devel@lists.sourceforge.net> for developer
  33 discussions.
  34
  35 For patch submissions and bug reports, please use the appropriate resources
  36 at <https://github.com/nagios-plugins/nagios-plugins>.
  37
  38
  39 Installation Instructions
  40 -------------------------
  41
  42 1.  If you are using the Git tree, you will need m4, gettext, automake, and
  43     autoconf.  To start out, run:
  44
  45         ./tools/setup
  46
  47     For more detail, see the developer guidelines at
  48     <https://www.nagios-plugins.org/doc/guidelines.html>.
  49
  50 2.  Run the configure script to initialize variables and create a Makefile,
  51     etc.
  52
  53         ./configure --prefix=BASEDIRECTORY --with-cgiurl=SOMEURL
  54
  55     Replace `BASEDIRECTORY` with the path of the directory under which Nagios
  56     is installed (default is `/usr/local/nagios`), and replace `SOMEURL` with
  57     the path used to access the Nagios CGIs with a web browser (default is
  58     `/nagios/cgi-bin`).
  59
  60 3.  Compile the plugins with the following command:
  61
  62         make
  63
  64 4.  Install the compiled plugins and plugin scripts with the following
  65     command:
  66
  67         make install
  68
  69     The installation procedure will attempt to place the plugins in a
  70     `libexec/` subdirectory in the base directory you specified with the
  71     `--prefix` argument to the configure script.
  72
  73 5.  There are some plugins that require setuid.  If you run make install as
  74     a non-root user, they will not be installed.  To install, switch to root
  75     and run:
  76
  77         make install-root
  78
  79 That's it!  If you have any problems or questions, feel free to send an
  80 email to <nagiosplug-help@lists.sourceforge.net>.
  81
  82
  83 License Stuff
  84 -------------
  85
  86 This software is released under the GNU General Public License, Version 3,
  87 with the additional exemption that compiling, linking and/or using OpenSSL
  88 is allowed.
  89
  90 See the `COPYING` file for the complete GPLv3 text.