Merge pull request #159 from PeterDaveHello/patch-2

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

diff --git a/config.sh.example b/config.sh.example
index 6f6f6f0e9f10322b6471ea38fca201bca206a4db..471339c2c4884609b2be4ad5e4cd5d0ec8bb9054 100644 (file)
--- a/config.sh.example
+++ b/config.sh.example
@@ -1,11 +1,10 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 ########################################################
-# This is the config file for letsencrypt.sh           #
+# This is the main 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)      #
@@ -13,24 +12,36 @@
 # 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"
+# Path to certificate authority (default: https://acme-v01.api.letsencrypt.org/directory)
+#CA="https://acme-v01.api.letsencrypt.org/directory"
 
-# Output directory for challenge-tokens to be served by webserver or deployed in HOOK (default: $SCRIPTDIR/.acme-challenges)
-#WELLKNOWN="${SCRIPTDIR}/.acme-challenges"
+# Path to license agreement (default: https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf)
+#LICENSE="https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf"
 
-# Default keysize for private keys (default: 4096)
-#KEYSIZE="4096"
+# Which challenge should be used? Currently http-01 and dns-01 are supported
+#CHALLENGETYPE="http-01"
+
+# Path to a directory containing additional config files, allowing to override
+# the defaults found in the main configuration file. Additional config files
+# in this directory needs to be named with a '.sh' ending.
+# default: <unset>
+#CONFIG_D=
 
 # Base directory for account key, generated certificates and list of domains (default: $SCRIPTDIR -- uses config directory if undefined)
 #BASEDIR=$SCRIPTDIR
 
+# Output directory for challenge-tokens to be served by webserver or deployed in HOOK (default: $BASEDIR/.acme-challenges)
+#WELLKNOWN="${BASEDIR}/.acme-challenges"
+
+# Location of private account key (default: $BASEDIR/private_key.pem)
+#PRIVATE_KEY="${BASEDIR}/private_key.pem"
+
+# Default keysize for private keys (default: 4096)
+#KEYSIZE="4096"
+
 # 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 (in this case altname is empty)
@@ -43,11 +54,20 @@
 # default: <unset>
 #HOOK=
 
-# Minimum days before expiration to automatically renew certificate (default: 14)
-#RENEW_DAYS="14"
+# Chain clean_challenge|deploy_challenge arguments together into one hook call per certificate (default: no)
+#HOOK_CHAIN="no"
+
+# Minimum days before expiration to automatically renew certificate (default: 30)
+#RENEW_DAYS="30"
 
 # Regenerate private keys instead of just signing new certificates on renewal (default: no)
 #PRIVATE_KEY_RENEW="no"
 
+# Which public key algorithm should be used? Supported: rsa, prime256v1 and secp384r1
+#KEY_ALGO=rsa
+
 # E-mail to use during the registration (default: <unset>)
 #CONTACT_EMAIL=
+
+# Lockfile location, to prevent concurrent access (default: $BASEDIR/lock)
+#LOCKFILE="${BASEDIR}/lock"