A single HOOK to handle challenge, cleaning of challenge files and uploading of certs.

[andy/dehydrated.git] / config.sh.example

diff --git a/config.sh.example b/config.sh.example
index f4d9634cfcc7c58d173d00988f302904bf6b1993..e807212ed7ccf81ffde3c05b9952eb1b023a4d13 100644 (file)
--- a/config.sh.example
+++ b/config.sh.example
@@ -1,17 +1,30 @@
-# default values are commented
+#!/bin/bash
+
+# Default values are commented
 
 #CA="https://acme-v01.api.letsencrypt.org"
 #WELLKNOWN=".acme-challenges"
 #KEYSIZE=4096
 #BASEDIR=./
+#OPENSSL_CNF=.... # system default (see openssl version -d)
+#ROOTCERT="lets-encrypt-x1-cross-signed.pem"
 
-# program called before responding to the challenge, arguments: path/to/token
-# token; can be used to e.g. upload the challenge if this script doesn't run
-# on the webserver
-#HOOK_CHALLENGE=
+# Program or function called in certain situations
+#
+# After generating the challenge-response, or after failed challenge
+# Given arguments: clean_challenge|deploy_challenge token-filename token-content
+#
+# After successfully signing certificate
+# Given arguments: deploy_cert path/to/privkey.pem path/to/cert.pem path/to/fullchain.pem
+#
+# BASEDIR and WELLKNOWN variables are exported and can be used in an external program
+#HOOK=
 
 # try to renew certs that are within RENEW_DAYS days of their expiration date
 #RENEW_DAYS="14"
 
 # create new private key for each csr (yes|no)
 #PRIVATE_KEY_RENEW=no
+
+# email to use during the registration
+#CONTACT_EMAIL=