]> git.street.me.uk Git - andy/dehydrated.git/blame - config.sh.example
fixed signcsr test
[andy/dehydrated.git] / config.sh.example
CommitLineData
c70b77a9
LS
1#!/bin/bash
2
cb6dc26c 3########################################################
a1cb7ccc 4# This is the main config file for letsencrypt.sh #
cb6dc26c
LS
5# #
6# This file is looked for in the following locations: #
7# $SCRIPTDIR/config.sh (next to this script) #
454c164b
LS
8# /usr/local/etc/letsencrypt.sh/config.sh #
9# /etc/letsencrypt.sh/config.sh #
10# ${PWD}/config.sh (in current working-directory) #
cb6dc26c
LS
11# #
12# Default values of this config are in comments #
13########################################################
f11bb1db 14
09729186
LS
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"
cb6dc26c 20
e925b293
MG
21# Which challenge should be used? Currently http-01 and dns-01 are supported
22#CHALLENGETYPE="http-01"
23
a1cb7ccc
DB
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
4a6f7974
MG
30# Base directory for account key, generated certificates and list of domains (default: $SCRIPTDIR -- uses config directory if undefined)
31#BASEDIR=$SCRIPTDIR
32
1e33cfe5
AB
33# Output directory for challenge-tokens to be served by webserver or deployed in HOOK (default: $BASEDIR/.acme-challenges)
34#WELLKNOWN="${BASEDIR}/.acme-challenges"
35
36# Location of private account key (default: $BASEDIR/private_key.pem)
37#PRIVATE_KEY="${BASEDIR}/private_key.pem"
0e92aba2 38
cb6dc26c
LS
39# Default keysize for private keys (default: 4096)
40#KEYSIZE="4096"
41
cb6dc26c
LS
42# Path to openssl config file (default: <unset> - tries to figure out system default)
43#OPENSSL_CNF=
44
c24843c6 45# Program or function called in certain situations
46#
f527eef8 47# After generating the challenge-response, or after failed challenge (in this case altname is empty)
e32ea24c 48# Given arguments: clean_challenge|deploy_challenge altname token-filename token-content
c24843c6 49#
50# After successfully signing certificate
e32ea24c 51# Given arguments: deploy_cert domain path/to/privkey.pem path/to/cert.pem path/to/fullchain.pem
c24843c6 52#
53# BASEDIR and WELLKNOWN variables are exported and can be used in an external program
cb6dc26c 54# default: <unset>
c24843c6 55#HOOK=
e300c0a1 56
6e048f7f
GD
57# Chain clean_challenge|deploy_challenge arguments together into one hook call per certificate (default: no)
58#HOOK_CHAIN="no"
59
da2795d3
ON
60# Minimum days before expiration to automatically renew certificate (default: 30)
61#RENEW_DAYS="30"
3dbbb461 62
cb6dc26c
LS
63# Regenerate private keys instead of just signing new certificates on renewal (default: no)
64#PRIVATE_KEY_RENEW="no"
ea5b70a3 65
c71ca3a8
MG
66# Which public key algorithm should be used? Supported: rsa, prime256v1 and secp384r1
67#KEY_ALGO=rsa
68
cb6dc26c 69# E-mail to use during the registration (default: <unset>)
ea5b70a3 70#CONTACT_EMAIL=
a87b9264 71
72# Lockfile location, to prevent concurrent access (default: $BASEDIR/lock)
73#LOCKFILE="${BASEDIR}/lock"