jan/check_xmppng
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

convert documentation to markdown

Browse source
This commit is contained in:
Jan Dittberner 2015-02-11 22:48:33 +01:00
parent e215567b31
commit 22eecd2616
3 changed files with 59 additions and 59 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.gitignore vendored
View file

@ -1,3 +1,4 @@
.*.swp .*.swp
.ropeproject/ .ropeproject/
README.html README.html
changes.html

41
README.md
View file

@ -1,9 +1,7 @@
=========================================== # check_xmppng - check plugin for XMPP
check_xmppng - nagios/icinga check for XMPP
===========================================
This program implements a nagios check plugin for XMPP servers implementing the This program implements a nagios check plugin for XMPP servers implementing the
XMPP protocol as specified in `RFC 6120 <http://tools.ietf.org/html/rfc6120>`_. XMPP protocol as specified in [RFC 6120](http://tools.ietf.org/html/rfc6120).
The program implements the following features: The program implements the following features:
@ -13,24 +11,22 @@ The program implements the following features:
* check the validity of the server certificate presented by the XMPP server * check the validity of the server certificate presented by the XMPP server
The plugin has been implemented because of insufficiencies in check_ssl_cert The plugin has been implemented because of insufficiencies in check_ssl_cert
and the existing `check_xmpp and the existing [check_xmpp](https://exchange.icinga.org/exchange/check_xmpp).
<https://exchange.icinga.org/exchange/check_xmpp>`_.
Maximum acceptable timeouts as well as minimum acceptable number of days the Maximum acceptable timeouts as well as minimum acceptable number of days the
server certificate needs to be valid can be specified as command line server certificate needs to be valid can be specified as command line
parameters. For a full list of parameters see the *Usage* section below. parameters. For a full list of parameters see the *Usage* section below.
Dependencies ## Dependencies
------------
The program is implemented in Python 3 and uses the following libraries besides The program is implemented in Python 3 and uses the following libraries besides
the Python standard library: the Python standard library:
* `defusedxml <https://pypi.python.org/pypi/defusedxml/>`_ to sanitize XML from * [defusedxml](https://pypi.python.org/pypi/defusedxml/) to sanitize XML from
the XMPP server the XMPP server
* `nagiosplugin <https://pypi.python.org/pypi/nagiosplugin>`_ to take care of * [nagiosplugin](https://pypi.python.org/pypi/nagiosplugin) to take care of the
the nagios plugin interface boilerplate code nagios plugin interface boilerplate code
The software has been developed and tested with the following versions: The software has been developed and tested with the following versions:
@ -39,8 +35,7 @@ The software has been developed and tested with the following versions:
* nagiosplugin 1.2.2 * nagiosplugin 1.2.2
License ## License
-------
check_xmppng is free software: you can redistribute it and/or modify it under check_xmppng is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software the terms of the GNU General Public License as published by the Free Software
@ -52,23 +47,21 @@ WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details. PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with You should have received a copy of the GNU General Public License along with
this program in the file ``COPYING``. If not, see this program in the file `COPYING`. If not, see
<http://www.gnu.org/licenses/>. http://www.gnu.org/licenses/.
Usage ## Usage
-----
.. code:: ```
usage: check_xmpp [-h] -H HOST_ADDRESS [-p PORT] [--s2s | --c2s] [-4 | -6]
usage: check_xmpp [-h] -H HOST_ADDRESS [-p PORT] [--s2s | --c2s] [-4 | -6]
[--servername SERVERNAME] [--starttls] [-w SECONDS] [--servername SERVERNAME] [--starttls] [-w SECONDS]
[-c SECONDS] [--no-check-certificates] [-r CAROOTS] [-c SECONDS] [--no-check-certificates] [-r CAROOTS]
[--warn-days WARNDAYS] [--crit-days CRITDAYS] [-v] [--warn-days WARNDAYS] [--crit-days CRITDAYS] [-v]
Check XMPP services Check XMPP services
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
-H HOST_ADDRESS, --host-address HOST_ADDRESS -H HOST_ADDRESS, --host-address HOST_ADDRESS
host address host address
@ -97,10 +90,10 @@ Usage
--crit-days CRITDAYS set state to CRITICAL if the certificate is valid for --crit-days CRITDAYS set state to CRITICAL if the certificate is valid for
not more than the given number of days not more than the given number of days
-v, --verbose -v, --verbose
```
Contact ## Contact
-------
If you want to provide feedback or bug reports please send me a mail to If you want to provide feedback or bug reports please send me a mail to
jan (at) dittberner [dot] info. jan (at) dittberner [dot] info.

14
changes.md
View file

@ -1,12 +1,18 @@
version 0.1.1 2015-02-11 # change log
------------------------
## version 0.1.2 2015-02-11
* first icinga exchange release
* convert documentation to markdown
* add icingaexchange.yml
## version 0.1.1 2015-02-11
* rename to xmpp_checkng to avoid clash with existing xmpp_check on Icinga * rename to xmpp_checkng to avoid clash with existing xmpp_check on Icinga
exchange exchange
* add proper documentation * add proper documentation
version 0.1 2015-02-11 ## version 0.1 2015-02-11
----------------------
* support S2S and C2S checks * support S2S and C2S checks
* support STARTTLS handling * support STARTTLS handling