aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md51
-rw-r--r--libexec/check_ftp2
2 files changed, 52 insertions, 1 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..61bccc7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+check\_ftp
+==========
+
+This plugin makes an FTP connection to a nominated server, optionally including
+a STARTTLS upgrade for FTPS. It does not support implicit FTPS.
+
+Installation
+------------
+
+ $ perl Makefile.PL
+ $ make
+ $ sudo make install
+
+Usage
+-----
+
+ Usage: check_ftp [--hostname|h HOSTNAME] [--starttls|S [SERVERNAME]]
+
+ -?, --usage
+ Print usage information
+ -h, --help
+ Print detailed help screen
+ -V, --version
+ Print version information
+ --extra-opts=[section][@file]
+ Read options from an ini file. See https://www.monitoring-plugins.org/doc/extra-opts.html
+ for usage and examples.
+ -H, --hostname=HOSTNAME
+ FTP server hostname or address
+ -S, --starttls[=HOSTNAME]
+ Try STARTTLS with optional specified hostname
+ -t, --timeout=INTEGER
+ Seconds before plugin times out (default: 15)
+ -v, --verbose
+ Show details for command-line debugging (can repeat up to 3 times)
+
+
+Thanks
+------
+
+This was written on company time with my employer [Inspire Net][1], who has
+generously allowed me to open source it.
+
+License
+-------
+
+Copyright (c) [Tom Ryder][2]. Distributed under [MIT License][3].
+
+[1]: https://www.inspire.net.nz/
+[2]: https://sanctum.geek.nz/
+[3]: https://opensource.org/licenses/MIT
diff --git a/libexec/check_ftp b/libexec/check_ftp
index a36dfd3..3ec2899 100644
--- a/libexec/check_ftp
+++ b/libexec/check_ftp
@@ -24,7 +24,7 @@ use Net::FTP;
use Try::Tiny;
# Decree package version
-our $VERSION = '1.00';
+our $VERSION = '1.01';
# Add description and license package variables
our $DESCRIPTION = <<'EOF';