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