]> git.street.me.uk Git - andy/dehydrated.git/blame - config.sh.example
removed line-break in example config
[andy/dehydrated.git] / config.sh.example
CommitLineData
c70b77a9
LS
1#!/bin/bash
2
cb6dc26c
LS
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) #
454c164b
LS
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) #
cb6dc26c
LS
12# #
13# Default values of this config are in comments #
14########################################################
f11bb1db 15
007da420 16# Path to certificate authority (default: https://acme-v01.api.letsencrypt.org)
f11bb1db 17#CA="https://acme-v01.api.letsencrypt.org"
cb6dc26c
LS
18
19# Output directory for challenge-tokens to be served by webserver or deployed in HOOK (default: $SCRIPTDIR/.acme-challenges)
20#WELLKNOWN="${SCRIPTDIR}/.acme-challenges"
21
22# Default keysize for private keys (default: 4096)
23#KEYSIZE="4096"
24
454c164b
LS
25# Base directory for account key, generated certificates and list of domains (default: $SCRIPTDIR -- uses config directory if undefined)
26#BASEDIR=$SCRIPTDIR
cb6dc26c
LS
27
28# Path to openssl config file (default: <unset> - tries to figure out system default)
29#OPENSSL_CNF=
30
31# Name of root certificate (default: lets-encrypt-x1-cross-signed.pem)
329acb58 32#ROOTCERT="lets-encrypt-x1-cross-signed.pem"
b33f1288 33
c24843c6 34# Program or function called in certain situations
35#
f527eef8 36# After generating the challenge-response, or after failed challenge (in this case altname is empty)
e32ea24c 37# Given arguments: clean_challenge|deploy_challenge altname token-filename token-content
c24843c6 38#
39# After successfully signing certificate
e32ea24c 40# Given arguments: deploy_cert domain path/to/privkey.pem path/to/cert.pem path/to/fullchain.pem
c24843c6 41#
42# BASEDIR and WELLKNOWN variables are exported and can be used in an external program
cb6dc26c 43# default: <unset>
c24843c6 44#HOOK=
e300c0a1 45
cb6dc26c 46# Minimum days before expiration to automatically renew certificate (default: 14)
ff3dbc58 47#RENEW_DAYS="14"
3dbbb461 48
cb6dc26c
LS
49# Regenerate private keys instead of just signing new certificates on renewal (default: no)
50#PRIVATE_KEY_RENEW="no"
ea5b70a3 51
cb6dc26c 52# E-mail to use during the registration (default: <unset>)
ea5b70a3 53#CONTACT_EMAIL=