view mod_checkcerts/README.markdown @ 5668:ecfd7aece33b

mod_measure_modules: Report module statuses via OpenMetrics Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which provides access to module statuses with full details. After that, this idea came about, which seems natural. As noted in the README, it could be used to monitor that critical modules are in fact loaded correctly. As more modules use the status API, the more useful this module and mod_http_status becomes.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 18:34:39 +0200
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.