docs/examples/config.sh.example

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