aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMitch Riedstra <mitch@riedstra.us>2021-01-24 10:37:34 -0500
committerMitch Riedstra <mitch@riedstra.us>2021-01-24 10:37:34 -0500
commit0539b119a4c205a96590b356849215b6e1b1ed35 (patch)
treefb0640cfc30947dfb15d100b7bb7b01d09a6146e
parenta4554be33914fd7cd77eea3326a747078bbe4c50 (diff)
downloadcheckup-0539b119a4c205a96590b356849215b6e1b1ed35.tar.gz
checkup-0539b119a4c205a96590b356849215b6e1b1ed35.tar.xz
Add a readme
-rw-r--r--readme.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..0633c3a
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,14 @@
+# Basic Server Checkup utility
+
+Opens TLS connections, checks the certificate validity using the default
+settings, then additionally checks whether or not it's going to expire soon
+with the window based on your configuration.
+
+Also checks HTTP servers for an expected status code
+
+Upon any failure it will send out a webhook to RocketChat, Discord or
+both.
+
+It's basic but it does what I want it to do. It should be easy enough to
+expand should you wish to.
+