From 705e6bb77ae24f337cb00cbc4be025ca5ccefbe4 Mon Sep 17 00:00:00 2001 From: Jack-Benny Persson Date: Fri, 17 Jun 2016 05:03:46 +0200 Subject: [PATCH] Added a README-file --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..25b4889 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# check_imap_starttls # +This is a Nagios plugin written in Bash to check IMAP-servers +with STARTTLS capabilities. The plugin also tries to login to the +server so it's required that you have an account on the server +you want to check. + +## Usage ## + + ./check_imap_starttls.sh - Version 0.1 + (c) 2016 Jack-Benny Persson (jack-benny@cyberinfo.se) + Test/monitor a IMAP server with STARTTLS and login with a username/password + Options: + -h + Print detailed help screen + -V + Print version information + -p | --port + Port to connect to + -H | --hostname + Hostname to connect to + -U | --username + Username to use for login + -P | --password + Password to use for login + +## License ## +Copyright 2016, Jack-Benny Persson (jack-benny@cyberinfo.se) and released +under GNU GPL2.