| blob | beb776902cdfc9627be94a490c2fe75705d5dd05 |
1 Monitoring Plugins
2 ==================
4 * For instructions on installing these plugins for use with your monitoring
5 system, see below. In addition, generic instructions for the GNU
6 toolchain can be found in the `INSTALL` file.
8 * For major changes between releases, read the `NEWS` 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 that
15 are dependent on other programs/libraries that are missing are usually not
16 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 You can check for the latest plugins at:
24 * <https://www.monitoring-plugins.org/>
26 Send an email to <help@monitoring-plugins.org> for assistance. Please
27 include the OS type and version that you are using. Also, run the plugin
28 with the `-vvv` option and provide the resulting version information. Of
29 course, there may be additional diagnostic information required as well.
30 Use good judgment.
32 Send an email to <devel@monitoring-plugins.org> for developer discussions.
34 For patch submissions and bug reports, please use the appropriate resources
35 at:
37 * <https://github.com/monitoring-plugins>
40 Installation Instructions
41 -------------------------
43 1. If you are using the Git tree, you will need m4, gettext, automake, and
44 autoconf. To start out, run:
46 ./tools/setup
48 For more detail, see the developer guidelines at
49 <https://www.monitoring-plugins.org/doc/guidelines.html>.
51 2. Run the configure script to initialize variables and create a Makefile,
52 etc.
54 ./configure --prefix=BASEDIRECTORY --with-cgiurl=SOMEURL
56 Replace `BASEDIRECTORY` with the path of the directory under which your
57 monitoring system is installed (default is `/usr/local`), and replace
58 `SOMEURL` with the path used to access the monitoring system CGIs with a
59 web browser (default is `/nagios/cgi-bin`).
61 3. Compile the plugins with the following command:
63 make
65 4. Install the compiled plugins and plugin scripts with the following
66 command:
68 make install
70 The installation procedure will attempt to place the plugins in a
71 `libexec/` subdirectory in the base directory you specified with the
72 `--prefix` argument to the configure script.
74 5. There are some plugins that require setuid. If you run make install as
75 a non-root user, they will not be installed. To install, switch to root
76 and run:
78 make install-root
80 That's it! If you have any problems or questions, feel free to send an
81 email to <help@monitoring-plugins.org>.
84 License Notice
85 --------------
87 You can redistribute and/or modify this software under the terms of the GNU
88 General Public License as published by the Free Software Foundation; either
89 version 3 of the License, or (at your option) any later version; with the
90 additional exemption that compiling, linking, and/or using OpenSSL is
91 allowed.
93 This software is distributed in the hope that it will be useful, but WITHOUT
94 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
95 FITNESS FOR A PARTICULAR PURPOSE.
97 See the `COPYING` file for the complete text of the GNU General Public
98 License, version 3.