aboutsummaryrefslogtreecommitdiffstats
path: root/doc/check-certificates.md
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2020-03-27 22:15:43 +0100
committerGravatar Christian Hesse <mail@eworm.de>2020-03-27 22:15:43 +0100
commit54a8f2839dd32d9c8bd60c2edbbca3606b250bbb (patch)
treeb8164b53f21696c30869ca2b4c3699efd3eb1579 /doc/check-certificates.md
parenta87fbb4be1e1e090b01db9eebd7799a0e1d62771 (diff)
parent1d93e92dcda753b855e89295f74dafae4743bb80 (diff)
Merge branch 'documentation'
Diffstat (limited to 'doc/check-certificates.md')
-rw-r--r--doc/check-certificates.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/check-certificates.md b/doc/check-certificates.md
new file mode 100644
index 0000000..51ecd14
--- /dev/null
+++ b/doc/check-certificates.md
@@ -0,0 +1,52 @@
+Renew certificates and notify on expiration
+===========================================
+
+[◀ Go back to main README](../README.md)
+
+Description
+-----------
+
+This script tries to download and renew certificates, then notifies about
+certificates that are still about to expire.
+
+Requirements and installation
+-----------------------------
+
+Just install the script:
+
+ $ScriptInstallUpdate check-certificates;
+
+Configuration
+-------------
+
+The expiry notifications just require notification settings for e-mail and
+telegram.
+
+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;
+
+See also
+--------
+
+* [Renew locally issued certificates](certificate-renew-issued.md)
+
+---
+[◀ Go back to main README](../README.md)
+[▲ Go back to top](#top)