view mod_checkcerts/README.markdown @ 5907:d194d1012fd3

Updating dox for mod_rest. Ideas expressed / clarified: 1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component. 2) Understanding some of the implications of this choice: A) Changes to user authentication B) How it affects subdomains 3) More consistent use of domain names for clarity. 4) Using different heading sizes to show scope of section. Essentially, I added all the tidbits I had to clarify in getting this to work in my own example.
author Ben Smith <bens@effortlessis.com>
date Mon, 13 May 2024 13:25:13 -0700
parents 9e5616a49d59
children
line wrap: on
line source

---
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.