Diff

mod_checkcerts/README.md @ 6209:d611ed13df7e draft

Merge
author Trần H. Trung <xmpp:trần.h.trung@trung.fun>
date Tue, 18 Mar 2025 00:16:25 +0700
child 6211:750d64c47ec6
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_checkcerts/README.md	Tue Mar 18 00:16:25 2025 +0700
@@ -0,0 +1,37 @@
+---
+labels:
+- Stage-Broken
+summary: Certificate expiry reminder
+...
+
+::: {.alert .alert-info} 
+This module is incompatible with prosody since version 0.10.
+:::
+
+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 or greater