view mod_checkcerts/README.markdown @ 4776:13e913471b75

mod_http_admin_api: Ensure freshness of metrics when in manual mode When in manual collection mode, as recommended for Prometheus, collection needs to be triggered manually, or they would be stale, possibly dating from the start of the server. This might vary per metric depending on how and when the metrics are gathered.
author Kim Alvefur <zash@zash.se>
date Thu, 18 Nov 2021 19:26:07 +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.