2020-03-27 20:41:18 +00:00
|
|
|
|
Renew certificates and notify on expiration
|
|
|
|
|
|
===========================================
|
|
|
|
|
|
|
|
|
|
|
|
[◀ Go back to main README](../README.md)
|
|
|
|
|
|
|
2022-02-12 12:05:56 +00:00
|
|
|
|
> ℹ️ **Info**: This script can not be used on its own but requires the base
|
2022-02-11 22:34:39 +00:00
|
|
|
|
> installation. See [main README](../README.md) for details.
|
2021-05-03 13:07:50 +00:00
|
|
|
|
|
2020-03-27 20:41:18 +00:00
|
|
|
|
Description
|
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
|
|
This script tries to download and renew certificates, then notifies about
|
|
|
|
|
|
certificates that are still about to expire.
|
|
|
|
|
|
|
2021-06-17 13:23:51 +00:00
|
|
|
|
### Sample notification
|
|
|
|
|
|
|
2021-11-11 21:42:54 +00:00
|
|
|
|
|
2021-06-17 13:23:51 +00:00
|
|
|
|
|
2020-03-27 20:41:18 +00:00
|
|
|
|
Requirements and installation
|
|
|
|
|
|
-----------------------------
|
|
|
|
|
|
|
|
|
|
|
|
Just install the script:
|
|
|
|
|
|
|
|
|
|
|
|
$ScriptInstallUpdate check-certificates;
|
|
|
|
|
|
|
|
|
|
|
|
Configuration
|
|
|
|
|
|
-------------
|
|
|
|
|
|
|
2021-05-28 15:30:37 +00:00
|
|
|
|
The expiry notifications just require notification settings for e-mail,
|
|
|
|
|
|
matrix and/or telegram.
|
2020-03-27 20:41:18 +00:00
|
|
|
|
|
|
|
|
|
|
For automatic download and renewal of certificates you need configuration
|
|
|
|
|
|
in `global-config-overlay`, these are the parameters:
|
|
|
|
|
|
|
|
|
|
|
|
* `CertRenewPass`: an array of passphrases to try
|
|
|
|
|
|
* `CertRenewUrl`: the url to download certificates from
|
|
|
|
|
|
|
|
|
|
|
|
Certificates on the web server should be named `CN.pem` (`PEM` format) or
|
|
|
|
|
|
`CN.p12` (`PKCS#12` format).
|
|
|
|
|
|
|
|
|
|
|
|
Usage and invocation
|
|
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
|
|
|
|
Just run the script:
|
|
|
|
|
|
|
|
|
|
|
|
/ system script run check-certificates;
|
|
|
|
|
|
|
|
|
|
|
|
... or create a scheduler for periodic execution:
|
|
|
|
|
|
|
|
|
|
|
|
/ system scheduler add interval=1d name=check-certificates on-event="/ system script run check-certificates;" start-time=startup;
|
|
|
|
|
|
|
2020-09-03 11:06:20 +00:00
|
|
|
|
Alternatively running on startup may be desired:
|
|
|
|
|
|
|
2021-02-18 13:52:47 +00:00
|
|
|
|
/ system scheduler add name=check-certificates-startup on-event="/ system script run check-certificates;" start-time=startup;
|
2020-09-03 11:06:20 +00:00
|
|
|
|
|
2020-03-27 20:41:18 +00:00
|
|
|
|
See also
|
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
|
|
* [Renew locally issued certificates](certificate-renew-issued.md)
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
[◀ Go back to main README](../README.md)
|
|
|
|
|
|
[▲ Go back to top](#top)
|
