docs/examples/config

   1 ########################################################
   2 # This is the main config file for letsencrypt.sh      #
   3 #                                                      #
   4 # This file is looked for in the following locations:  #
   5 # $SCRIPTDIR/config (next to this script)              #
   6 # /usr/local/etc/letsencrypt.sh/config                 #
   7 # /etc/letsencrypt.sh/config                           #
   8 # ${PWD}/config (in current working-directory)         #
   9 #                                                      #
  10 # Default values of this config are in comments        #
  11 ########################################################
  12
  13 # Path to certificate authority (default: https://acme-v01.api.letsencrypt.org/directory)
  14 #CA="https://acme-v01.api.letsencrypt.org/directory"
  15
  16 # Path to license agreement (default: https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf)
  17 #LICENSE="https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf"
  18
  19 # Which challenge should be used? Currently http-01 and dns-01 are supported
  20 #CHALLENGETYPE="http-01"
  21
  22 # Path to a directory containing additional config files, allowing to override
  23 # the defaults found in the main configuration file. Additional config files
  24 # in this directory needs to be named with a '.sh' ending.
  25 # default: <unset>
  26 #CONFIG_D=
  27
  28 # Base directory for account key, generated certificates and list of domains (default: $SCRIPTDIR -- uses config directory if undefined)
  29 #BASEDIR=$SCRIPTDIR
  30
  31 # File containing the list of domains to request certificates for (default: $BASEDIR/domains.txt)
  32 #DOMAINS_TXT="${BASEDIR}/domains.txt"
  33
  34 # Output directory for generated certificates
  35 #CERTDIR="${BASEDIR}/certs"
  36
  37 # Output directory for challenge-tokens to be served by webserver or deployed in HOOK (default: $BASEDIR/.acme-challenges)
  38 #WELLKNOWN="${BASEDIR}/.acme-challenges"
  39
  40 # Location of private account key (default: $BASEDIR/private_key.pem)
  41 #ACCOUNT_KEY="${BASEDIR}/private_key.pem"
  42
  43 # Location of private account registration information (default: $BASEDIR/private_key.json)
  44 #ACCOUNT_KEY_JSON="${BASEDIR}/private_key.json"
  45
  46 # Default keysize for private keys (default: 4096)
  47 #KEYSIZE="4096"
  48
  49 # Path to openssl config file (default: <unset> - tries to figure out system default)
  50 #OPENSSL_CNF=
  51
  52 # Program or function called in certain situations
  53 #
  54 # After generating the challenge-response, or after failed challenge (in this case altname is empty)
  55 # Given arguments: clean_challenge|deploy_challenge altname token-filename token-content
  56 #
  57 # After successfully signing certificate
  58 # Given arguments: deploy_cert domain path/to/privkey.pem path/to/cert.pem path/to/fullchain.pem
  59 #
  60 # BASEDIR and WELLKNOWN variables are exported and can be used in an external program
  61 # default: <unset>
  62 #HOOK=
  63
  64 # Chain clean_challenge|deploy_challenge arguments together into one hook call per certificate (default: no)
  65 #HOOK_CHAIN="no"
  66
  67 # Minimum days before expiration to automatically renew certificate (default: 30)
  68 #RENEW_DAYS="30"
  69
  70 # Regenerate private keys instead of just signing new certificates on renewal (default: yes)
  71 #PRIVATE_KEY_RENEW="yes"
  72
  73 # Which public key algorithm should be used? Supported: rsa, prime256v1 and secp384r1
  74 #KEY_ALGO=rsa
  75
  76 # E-mail to use during the registration (default: <unset>)
  77 #CONTACT_EMAIL=
  78
  79 # Lockfile location, to prevent concurrent access (default: $BASEDIR/lock)
  80 #LOCKFILE="${BASEDIR}/lock"