Diff

mod_checkcerts/README.md @ 6003:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parent 3182:9e5616a49d59
child 6074:b842f5d168bc
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_checkcerts/README.md	Tue Oct 22 10:26:01 2024 +0200
@@ -0,0 +1,32 @@
+---
+labels:
+summary: Certificate expiry reminder
+...
+
+Introduction
+============
+
+This module periodically checks your certificate to see if it is about
+to expire soon. The time before expiry is printed in the logs. About a
+week before a certificate expires, reminder messages will be sent to
+admins.
+
+Configuration
+=============
+
+Simply add the module to the `modules_enabled` list. You can optionally
+configure how long before expiry to start sending messages to admins.
+
+    modules_enabled = {
+        ...
+        "checkcerts"
+    }
+    checkcerts_notify = 7 -- ( in days )
+
+Compatibility
+=============
+
+Needs LuaSec 0.5+
+
+Originally written for Prosody 0.9.x, apparently incompatible with
+0.10.x.