view mod_checkcerts/README.markdown @ 4755:99b467605dfc

luacheckrc: Remove accidentally commented directive Accidentally commented in 4b258329e6e4 This directive was removed from Prosody in d59be9befad7 followed by a big sweep of the resulting warnings.
author Kim Alvefur <zash@zash.se>
date Tue, 28 Jan 2020 21:54:04 +0100
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.