diff options
Diffstat (limited to 'web/input/doc')
-rw-r--r-- | web/input/doc/extra-opts.md | 72 | ||||
-rw-r--r-- | web/input/doc/faq/index.md | 9 | ||||
-rw-r--r-- | web/input/doc/index.md | 26 | ||||
-rw-r--r-- | web/input/doc/man/index.md | 20 | ||||
l--------- | web/input/doc/news.txt | 1 | ||||
-rw-r--r-- | web/input/doc/presentation.md | 26 | ||||
-rw-r--r-- | web/input/doc/release-notes/1-5.md | 95 |
7 files changed, 249 insertions, 0 deletions
diff --git a/web/input/doc/extra-opts.md b/web/input/doc/extra-opts.md new file mode 100644 index 0000000..542c199 --- /dev/null +++ b/web/input/doc/extra-opts.md | |||
@@ -0,0 +1,72 @@ | |||
1 | title: Extra-Opts | ||
2 | parent: Documentation | ||
3 | --- | ||
4 | |||
5 | # Extra-Opts | ||
6 | |||
7 | Starting with the 1.4.12 release, Nagios C plugins support reading | ||
8 | configuration options from a configuration file. This needs to be enabled at | ||
9 | compile-time for now (`--enable-extra-opts`) and will be enabled by default in | ||
10 | the future. Perl plugins using the Nagios::Plugin module have this support | ||
11 | since version 0.16. | ||
12 | |||
13 | You can easily know if a plugin supports *extra-opts* by checking the `--help` | ||
14 | output for the `--extra-opts` option. Once compiled in, the `--extra-opts` | ||
15 | plugin option allows reading extra options from a config file. The syntax for | ||
16 | the command is: | ||
17 | |||
18 | --extra-opts=[section][@file] | ||
19 | |||
20 | Some examples: | ||
21 | |||
22 | * Read `special_opts` section of default config file: | ||
23 | |||
24 | ./check_stuff --extra-opts=special_opts | ||
25 | |||
26 | * Read `special_opts` section of `/etc/myconfig.ini`: | ||
27 | |||
28 | ./check_stuff --extra-opts=special_opts@/etc/myconfig.ini | ||
29 | |||
30 | * Read `check_stuff` section of `/etc/myconfig.ini`: | ||
31 | |||
32 | ./check_stuff --extra-opts=@/etc/myconfig.ini | ||
33 | |||
34 | * Read `check_stuff` section of default config file and use additional | ||
35 | arguments along with the other specified arguments (*extra-opts* arguments | ||
36 | are always processed first no matter where `--extra-opts` appears on the | ||
37 | command line): | ||
38 | |||
39 | ./check_stuff --extra-opts -jk --some-other-opt | ||
40 | |||
41 | The default nagios plugins file is used if no explicit filename is given. The | ||
42 | current standard locations checked are: | ||
43 | |||
44 | * `/etc/nagios/plugins.ini` | ||
45 | * `/usr/local/nagios/etc/plugins.ini` | ||
46 | * `/usr/local/etc/nagios/plugins.ini` | ||
47 | * `/etc/opt/nagios/plugins.ini` | ||
48 | * `/etc/nagios-plugins.ini` | ||
49 | * `/usr/local/etc/nagios-plugins.ini` | ||
50 | * `/etc/opt/nagios-plugins.ini` | ||
51 | |||
52 | To use a custom location, set a `NAGIOS_CONFIG_PATH` environment variable to | ||
53 | the set of directories that should be checked (this is a colon-separated list | ||
54 | just like `PATH`). The first `plugins.ini` or `nagios-plugins.ini` file found | ||
55 | in these directories will be used. | ||
56 | |||
57 | To specify an option without parameter, you can use a key without value, but | ||
58 | the equal sign must remain, for example: | ||
59 | |||
60 | allow-regex= | ||
61 | |||
62 | Also note that repeated keys are allowed within sections just like you can | ||
63 | repeat arguments on the command line. | ||
64 | |||
65 | The basic theory is that options specified in the configuration files are | ||
66 | substituted at the beginning of the command line. | ||
67 | |||
68 | The initial use case for this functionality is for hiding passwords, so you do | ||
69 | not have to define sensitive credentials in the Nagios configuration and these | ||
70 | options won't appear in the command line. | ||
71 | |||
72 | <!--% # vim:set filetype=markdown textwidth=78 joinspaces: # %--> | ||
diff --git a/web/input/doc/faq/index.md b/web/input/doc/faq/index.md new file mode 100644 index 0000000..18584f2 --- /dev/null +++ b/web/input/doc/faq/index.md | |||
@@ -0,0 +1,9 @@ | |||
1 | title: FAQ | ||
2 | parent: Documentation | ||
3 | --- | ||
4 | |||
5 | # FAQ | ||
6 | |||
7 | The list of Frequently Asked Questions (FAQ) will come back soon. | ||
8 | |||
9 | <!--% # vim:set filetype=markdown textwidth=78 joinspaces: # %--> | ||
diff --git a/web/input/doc/index.md b/web/input/doc/index.md new file mode 100644 index 0000000..7b2d098 --- /dev/null +++ b/web/input/doc/index.md | |||
@@ -0,0 +1,26 @@ | |||
1 | title: Documentation | ||
2 | parent: Home | ||
3 | menu-position: 3 | ||
4 | --- | ||
5 | |||
6 | # Documentation | ||
7 | |||
8 | The Nagios Plugins documentation is split up into three parts: | ||
9 | |||
10 | 1. **[Manual Pages][man]** | ||
11 | This part provides documentation for each individual plugin. | ||
12 | |||
13 | 2. **[FAQ][faq]** | ||
14 | The FAQ section offers additional information on the Nagios Plugins | ||
15 | package as a whole. | ||
16 | |||
17 | 3. **[Presentation][video]** | ||
18 | A video that shows how to write your own check using the | ||
19 | [Nagios::Plugin][module] Perl module. | ||
20 | |||
21 | [man]: doc/man/index.html "Manual Pages" | ||
22 | [faq]: doc/faq/index.html "Frequently Asked Questions" | ||
23 | [video]: doc/presentation.html "Nagios::Plugin Presentation" | ||
24 | [module]: http://search.cpan.org/dist/Nagios-Plugin/ "Nagios::Plugin" | ||
25 | |||
26 | <!--% # vim:set filetype=markdown textwidth=78 joinspaces: # %--> | ||
diff --git a/web/input/doc/man/index.md b/web/input/doc/man/index.md new file mode 100644 index 0000000..d3c60c8 --- /dev/null +++ b/web/input/doc/man/index.md | |||
@@ -0,0 +1,20 @@ | |||
1 | title: Manpages | ||
2 | parent: Documentation | ||
3 | --- | ||
4 | |||
5 | # Manual Pages | ||
6 | |||
7 | There are two levels of documentation for each plugin: | ||
8 | |||
9 | 1. **`check_dummy --usage`** | ||
10 | Basic usage, with the most common command line options. | ||
11 | |||
12 | 2. **`check_dummy --help`** | ||
13 | More text, listing all the options available for a plugin. This text is | ||
14 | usually translated. | ||
15 | |||
16 | You can also access the most recent `--help` output for each plugin online: | ||
17 | |||
18 | <!--% list_kids() %--> | ||
19 | |||
20 | <!--% # vim:set filetype=markdown textwidth=78 joinspaces: # %--> | ||
diff --git a/web/input/doc/news.txt b/web/input/doc/news.txt new file mode 120000 index 0000000..f5208d5 --- /dev/null +++ b/web/input/doc/news.txt | |||
@@ -0,0 +1 @@ | |||
/home/plugins/exported/nagios-plugins/NEWS \ No newline at end of file | |||
diff --git a/web/input/doc/presentation.md b/web/input/doc/presentation.md new file mode 100644 index 0000000..458b101 --- /dev/null +++ b/web/input/doc/presentation.md | |||
@@ -0,0 +1,26 @@ | |||
1 | title: Presentation | ||
2 | parent: Documentation | ||
3 | --- | ||
4 | |||
5 | # Presentation | ||
6 | |||
7 | Former Nagios Plugins team lead Ton Voon gave a 15-minutes lightning talk | ||
8 | about the Nagios Plugins at [FOSDEM][fosdem]. He made a screencast of [the | ||
9 | presentation][talk] in Quicktime format (35 MB): | ||
10 | |||
11 | * [fosdem.mov][screencast] | ||
12 | |||
13 | The `check_weather` script demonstrated in the screencast is also available | ||
14 | for download, with additional comments: | ||
15 | |||
16 | * [check_weather.pl][script] | ||
17 | |||
18 | Both files are also [available via FTP][mirror]. | ||
19 | |||
20 | [fosdem]: https://fosdem.org/ "FOSDEM" | ||
21 | [talk]: https://archive.fosdem.org/2007/schedule/events/lt_nagios_plugins.html "Ton's Talk" | ||
22 | [screencast]: https://www.nagios-plugins.org/download/presentation/fosdem.mov "Screencast" | ||
23 | [script]: https://www.nagios-plugins.org/download/presentation/check_weather.pl "check_weather" | ||
24 | [mirror]: ftp://ftp.fu-berlin.de/unix/network/nagios-plugins/presentation/ "FTP Mirror" | ||
25 | |||
26 | <!--% # vim:set filetype=markdown textwidth=78 joinspaces: # %--> | ||
diff --git a/web/input/doc/release-notes/1-5.md b/web/input/doc/release-notes/1-5.md new file mode 100644 index 0000000..b8f3457 --- /dev/null +++ b/web/input/doc/release-notes/1-5.md | |||
@@ -0,0 +1,95 @@ | |||
1 | title: Version 1.5 | ||
2 | parent: Download | ||
3 | --- | ||
4 | |||
5 | # Version 1.5 Released | ||
6 | |||
7 | *Wednesday, October 2, 2013* | ||
8 | |||
9 | The Nagios Plugins Development Team is proud to announce version 1.5 of the | ||
10 | Nagios Plugins! This release comes with the new `check_dbi` plugin written by | ||
11 | Sebastian Harl, and includes lots of enhancements and fixes provided by more | ||
12 | than forty contributors. Many thanks to all of you! | ||
13 | |||
14 | Special kudos go to Sven Nierlein for fixing numerous bugs, reviewing many | ||
15 | pull requests, bringing our test suite back into shape, and setting up | ||
16 | automated tests on a variety of platforms. This helped us spotting lots of | ||
17 | bugs *before* the release. Let me also thank Ton Voon for doing the | ||
18 | unenviable work of updating the bundled Perl modules; and our newest team | ||
19 | member Jan Wagner for all his help with patch review. | ||
20 | |||
21 | See below for a list of major changes. Note that the new `check_http` version | ||
22 | introduces two minor backwards incompatibilities mentioned at the end of that | ||
23 | list, so please be sure to check whether they might affect you. | ||
24 | |||
25 | You can get the tarball from our [download page][download]. | ||
26 | |||
27 | ## Enhancements | ||
28 | |||
29 | * New `check_dbi` plugin for checking an (SQL) database using DBI | ||
30 | * Let OpenSSL load its configuration file (see the `OPENSSL_config(3)` man | ||
31 | page) | ||
32 | * Add performance data to `check_apt` | ||
33 | * Add performance data to `check_procs` | ||
34 | * Added `-4`/`-6` options to `check_dig` | ||
35 | * New `check_oracle` `--connect` option to perform real login | ||
36 | * New `check_nagios` `-t` option to override the default timeout | ||
37 | * New `check_disk` `-f`/`--freespace-ignore-reserved` option to ignore space | ||
38 | reserved for root | ||
39 | * New `check_disk` `-N`/`--include-type` option to limit the filesystem types | ||
40 | to check | ||
41 | * Allow for building the plugins in parallel | ||
42 | * Add `--without-{dbi,ldap,radius}` options to `./configure` | ||
43 | * Made Verbose output of `check_sensors` compliant | ||
44 | * New switch `-E`/`--extended-perfdata` for `check_http` to print additional | ||
45 | performance data | ||
46 | * New `check_http` `-d` option to specify a string to expect within the | ||
47 | response headers | ||
48 | * New `check_http` `-J`/`-K` options for client certificate authentication | ||
49 | support | ||
50 | * Add support for executing queries to `check_pgsql` | ||
51 | * Let `check_pgsql` accept a UNIX socket directory as hostname | ||
52 | * New `check_pgsql` `-o` option to specify additional connection parameters | ||
53 | * New `check_fping` `-S` option to specify the source IP address | ||
54 | * New `check_fping` `-I` option to specify the interface to bind to | ||
55 | * Let `check_fping` support IPv6 | ||
56 | * New `check_procs` `-k` option to ignore kernel threads (on Linux) | ||
57 | * Let `check_procs` use `/proc/<PID>/exe` (if available) instead of | ||
58 | `getpid(2)`, unless `-T` is specified | ||
59 | * Let `check_mysql` support SSL | ||
60 | * Let `check_mysql` add perfromance metrics for all checks | ||
61 | * New `check_mysql` `-f` option to specify a client options file | ||
62 | * New `check_mysql` `-g` option to specify a client options group | ||
63 | * New `check_snmp` `--offset` option to allow for adding/substracting an | ||
64 | offset value to sensor data | ||
65 | * Let `check_snmp` support an arbitrary number of OIDs | ||
66 | * Let `check_ide_smart` support NetBSD | ||
67 | |||
68 | ## Fixes | ||
69 | |||
70 | * Change the MAIL FROM command generated by `check_smtp` to be RFC compliant | ||
71 | * Fix compilation of `check_http` without SSL support | ||
72 | * Fix `check_snmp` reversed threshold ranges (backward-compatibility) | ||
73 | * Fix `check_snmp` memory violation when using more than 8 OIDs | ||
74 | * Fix `check_apt` security regular expression | ||
75 | * Fix `check_http` handling extra header (`-k`) containing semicolons | ||
76 | * Fix `check_apt` handling unknown exit codes from apt-get | ||
77 | * Fix deprecated imports of `check_nmap.py` | ||
78 | |||
79 | ## Warnings | ||
80 | |||
81 | * `check_http` behaviour of `-k`/`--header` changed since it does not seperate | ||
82 | multiple headers by semicolons anymore. Use multiple `-k` switches instead. | ||
83 | * `check_http`'s `--proxy_authorization` option is now called | ||
84 | `--proxy-authorization` (it was always documented this way) | ||
85 | * The [contrib directory][contrib] has been removed. These days, sites such | ||
86 | as [Nagios Exchange][nag-exchange] and [Monitoring Exchange][mon-exchange] | ||
87 | serve as much better places for publishing plugins not maintained by the | ||
88 | Nagios Plugins Development Team. | ||
89 | |||
90 | [download]: /download.html | ||
91 | [contrib]: https://github.com/nagios-plugins/nagios-plugins/tree/7a80e27fb38b26713ac5a1f6810b99519a31dbf3/contrib | ||
92 | [nag-exchange]: http://exchange.nagios.org/ | ||
93 | [mon-exchange]: https://www.monitoringexchange.org/ | ||
94 | |||
95 | <!--% # vim:set filetype=markdown textwidth=78 joinspaces: # %--> | ||