README 3.0 KB

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