1 Nagios Plugins README
2 ---------------------
4 * For instructions on installing these plugins for use with Nagios,
5 see below. In addition, generic instructions for the GNU toolchain
6 can be found in the INSTALL file.
8 * For major changes between releases, read the CHANGES file.
10 * For information on detailed changes that have been made or plugins
11 that have been added, read the Changelog file.
13 * Some plugins require that you have additional programs and/or
14 libraries installed on your system before they can be used. Plugins
15 that are dependent on other programs/libraries that are missing are
16 usually not compiled. Read the REQUIREMENTS file for more information.
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.
22 * The file command.cfg contains example configurations for many of the
23 plugins
25 * The win32 subdir contains plugins specific to the Win32 platform.
26 These are scripts or binaries.
28 You can check for the latest plugins at:
29 ftp://download.sourceforge.net/pub/sourceforge/nagiosplug
30 http://sourceforge.net/projects/nagiosplug/
32 Send mail to nagiosplug-help@lists.sourceforge.net for assistance. Please
33 include the OS type and version that you are using. Also, run the plugin with
34 the '-v' option and provide the resulting version information. Of course,
35 there may be additional diagnostic information required as well. Use good
36 judgment.
38 Send mail to nagiosplug-devel@lists.sourceforge.net for developer discussions.
40 For patch submissions and bug reports, please use the appropriate resources at
41 http://sourceforge.net/projects/nagiosplug/ (navigate to the bug tool and/or
42 patch tool from the summary page). Patches should be relative to the current
43 CVS head (development), or to the head of the current stable branch. Also,
44 please include version information for your OS and the plugin(s) your are
45 patching/reporting.
50 Nagios Plugins Quick-and-Dirty Installation Instructions
51 --------------------------------------------------------
53 0) If using the CVS tree, you need m4, gettext, automake, and autoconf. To
54 start out, run ./tools/setup
56 For development, we generally use the most recent stable tools from
57 the FSF. Currently we use gettext 0.11.5, autoconf 2.58, and
58 automake 1.7.9. You may see warnings or errors with other versions,
59 particularly with autoconf < 2.54.
62 1) Run the configure script to initialize variables and create a Makefile, etc.
64 ./configure --prefix=BASEDIRECTORY --with-nagios-user=SOMEUSER --with-nagios-group=SOMEGROUP --with-cgiurl=SOMEURL
66 a) Replace BASEDIRECTORY with the path of the directory under which Nagios
67 is installed (default is '/usr/local/nagios')
68 b) Replace SOMEUSER with the name of a user on your system that will be
69 assigned permissions to the installed plugins (default is 'nagios')
70 c) Replace SOMEGRP with the name of a group on your system that will be
71 assigned permissions to the installed plugins (default is 'nagios')
72 d) Replace CGIURL with the path used to access the Nagios CGIs with
73 a web browser (default is '/nagios/cgi-bin')
76 2) Compile the plugins with the following command:
78 make
81 3) Install the compiled plugins and plugin scripts with the following command:
83 make install
85 The installation procedure will attempt to place the plugins in a
86 'libexec/' subdirectory in the base directory you specified with
87 the --prefix argument to the configure script.
90 4) Verify that your host configuration file (hosts.cfg) for Nagios contains
91 the correct paths to the new plugins.
95 That's it. If you have any problems or questions, feel free send mail
96 to nagios-users@lists.sourceforge.net or nagiosplug-help@lists.sourceforge.net
101 --
102 Karl DeBisschop (kdebisschop@users.sourceforge.net)