config.sh.example

   1 #!/bin/bash
   2
   3 ########################################################
   4 # This is the 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 # ${HOME}/.letsencrypt.sh/config.sh (in user home)     #
   9 # /usr/local/etc/letsencrypt.sh/config.sh              #
  10 # /etc/letsencrypt.sh/config.sh                        #
  11 # ${PWD}/config.sh (in current working-directory)      #
  12 #                                                      #
  13 # Default values of this config are in comments        #
  14 ########################################################
  15
  16 # Path to certificate authority (default: https://acme-v01.api.letsencrypt.org/directory)
  17 #CA="https://acme-v01.api.letsencrypt.org/directory"
  18
  19 # Path to license agreement (default: https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf)
  20 #LICENSE="https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf"
  21
  22 # Base directory for account key, generated certificates and list of domains (default: $SCRIPTDIR -- uses config directory if undefined)
  23 #BASEDIR=$SCRIPTDIR
  24
  25 # Output directory for challenge-tokens to be served by webserver or deployed in HOOK (default: $BASEDIR/.acme-challenges)
  26 #WELLKNOWN="${BASEDIR}/.acme-challenges"
  27
  28 # Location of private account key (default: $BASEDIR/private_key.pem)
  29 #PRIVATE_KEY="${BASEDIR}/private_key.pem"
  30
  31 # Default keysize for private keys (default: 4096)
  32 #KEYSIZE="4096"
  33
  34 # Path to openssl config file (default: <unset> - tries to figure out system default)
  35 #OPENSSL_CNF=
  36
  37 # Program or function called in certain situations
  38 #
  39 # After generating the challenge-response, or after failed challenge (in this case altname is empty)
  40 # Given arguments: clean_challenge|deploy_challenge altname token-filename token-content
  41 #
  42 # After successfully signing certificate
  43 # Given arguments: deploy_cert domain path/to/privkey.pem path/to/cert.pem path/to/fullchain.pem
  44 #
  45 # BASEDIR and WELLKNOWN variables are exported and can be used in an external program
  46 # default: <unset>
  47 #HOOK=
  48
  49 # Minimum days before expiration to automatically renew certificate (default: 14)
  50 #RENEW_DAYS="14"
  51
  52 # Regenerate private keys instead of just signing new certificates on renewal (default: no)
  53 #PRIVATE_KEY_RENEW="no"
  54
  55 # E-mail to use during the registration (default: <unset>)
  56 #CONTACT_EMAIL=