]> git.street.me.uk Git - andy/dehydrated.git/blob - config.sh.example
also add default CA definition in description of variable
[andy/dehydrated.git] / 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 #                                                      #
9 # Default values of this config are in comments        #
10 ########################################################
11
12 # Path to certificate authority (default: https://acme-v01.api.letsencrypt.org)
13 #CA="https://acme-v01.api.letsencrypt.org"
14
15 # Output directory for challenge-tokens to be served by webserver or deployed in HOOK (default: $SCRIPTDIR/.acme-challenges)
16 #WELLKNOWN="${SCRIPTDIR}/.acme-challenges"
17
18 # Default keysize for private keys (default: 4096)
19 #KEYSIZE="4096"
20
21 # Base directory for account key, generated certificates and list of domains (default: $SCRIPTDIR)
22 #BASEDIR="${SCRIPTDIR}"
23
24 # Path to openssl config file (default: <unset> - tries to figure out system default)
25 #OPENSSL_CNF=
26
27 # Name of root certificate (default: lets-encrypt-x1-cross-signed.pem)
28 #ROOTCERT="lets-encrypt-x1-cross-signed.pem"
29
30 # Program or function called in certain situations
31 #
32 # After generating the challenge-response, or after failed challenge
33 # Given arguments: clean_challenge|deploy_challenge token-filename token-content
34 #
35 # After successfully signing certificate
36 # Given arguments: deploy_cert path/to/privkey.pem path/to/cert.pem path/to/fullchain.pem
37 #
38 # BASEDIR and WELLKNOWN variables are exported and can be used in an external program
39 # default: <unset>
40 #HOOK=
41
42 # Minimum days before expiration to automatically renew certificate (default: 14)
43 #RENEW_DAYS="14"
44
45 # Regenerate private keys instead of just signing new certificates on renewal (default: no)
46 #PRIVATE_KEY_RENEW="no"
47
48 # E-mail to use during the registration (default: <unset>)
49 #CONTACT_EMAIL=