import-certs.sh: simplify expiry check

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

diff --git a/config.sh.example b/config.sh.example
index 63d9ebc1e7a7410f0d2807ca752bc7b0f8012127..f61b430a85e0ab47d95f8b382bbb147901b0a62c 100644 (file)
--- a/config.sh.example
+++ b/config.sh.example
@@ -1,4 +1,53 @@
-# default values are commented
+#!/bin/bash
 
+########################################################
+# This is the config file for letsencrypt.sh           #
+#                                                      #
+# This file is looked for in the following locations:  #
+# $SCRIPTDIR/config.sh (next to this script)           #
+# ${HOME}/.letsencrypt.sh/config.sh (in user home)     #
+# /usr/local/etc/letsencrypt.sh/config.sh              #
+# /etc/letsencrypt.sh/config.sh                        #
+# ${PWD}/config.sh (in current working-directory)      #
+#                                                      #
+# Default values of this config are in comments        #
+########################################################
+
+# Path to certificate authority (default: https://acme-v01.api.letsencrypt.org)
 #CA="https://acme-v01.api.letsencrypt.org"
-WELLKNOWN="/var/www/letsencrypt/.well-known/acme-challenge"
+
+# Output directory for challenge-tokens to be served by webserver or deployed in HOOK (default: $SCRIPTDIR/.acme-challenges)
+#WELLKNOWN="${SCRIPTDIR}/.acme-challenges"
+
+# Default keysize for private keys (default: 4096)
+#KEYSIZE="4096"
+
+# Base directory for account key, generated certificates and list of domains (default: $SCRIPTDIR -- uses config directory if undefined)
+#BASEDIR=$SCRIPTDIR
+
+# Path to openssl config file (default: <unset> - tries to figure out system default)
+#OPENSSL_CNF=
+
+# Name of root certificate (default: lets-encrypt-x1-cross-signed.pem)
+#ROOTCERT="lets-encrypt-x1-cross-signed.pem"
+
+# 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
+# default: <unset>
+#HOOK=
+
+# Minimum days before expiration to automatically renew certificate (default: 14)
+#RENEW_DAYS="14"
+
+# Regenerate private keys instead of just signing new certificates on renewal (default: no)
+#PRIVATE_KEY_RENEW="no"
+
+# E-mail to use during the registration (default: <unset>)
+#CONTACT_EMAIL=