]> git.street.me.uk Git - andy/dehydrated.git/blob - docs/hook_chain.md
Merge pull request #184 from gboudrias/master
[andy/dehydrated.git] / docs / hook_chain.md
1 # HOOK_CHAIN
2
3 If you want to deploy (and clean) all challenges for a single certificate in one hook call you can use `HOOK_CHAIN=yes` in your config.
4
5 Calls to your hook script change in a way that instead of having only X parameters on deploy_challenge and clean_challenge it will have Y*X parameters,
6 where Y is the number of domains in your cert, and you'll have to iterate over a set of X parameters at a time in your hook script.
7
8 See below for an example on how the calls change:
9
10 ### HOOK_CHAIN="no" (default behaviour)
11 ```
12 # INFO: Using main config file /etc/letsencrypt.sh/config.sh
13 Processing lukas.im with alternative names: www.lukas.im
14  + Checking domain name(s) of existing cert... unchanged.
15  + Checking expire date of existing cert...
16  + Valid till Jul  7 20:54:00 2016 GMT (Longer than 30 days). Ignoring because renew was forced!
17  + Signing domains...
18  + Generating private key...
19  + Generating signing request...
20  + Requesting challenge for lukas.im...
21  + Requesting challenge for www.lukas.im...
22 HOOK: deploy_challenge lukas.im blablabla blablabla.supersecure
23  + Responding to challenge for lukas.im...
24 HOOK: clean_challenge lukas.im blablabla blablabla.supersecure
25  + Challenge is valid!
26 HOOK: deploy_challenge www.lukas.im blublublu blublublu.supersecure
27  + Responding to challenge for www.lukas.im...
28 HOOK: clean_challenge www.lukas.im blublublu blublublu.supersecure
29  + Challenge is valid!
30  + Requesting certificate...
31  + Checking certificate...
32  + Done!
33  + Creating fullchain.pem...
34 HOOK: deploy_cert lukas.im /etc/letsencrypt.sh/certs/lukas.im/privkey.pem /etc/letsencrypt.sh/certs/lukas.im/cert.pem /etc/letsencrypt.sh/certs/lukas.im/fullchain.pem /etc/letsencrypt.sh/certs/lukas.im/chain.pem 1460152442
35  + Done!
36 ```
37
38 ### HOOK_CHAIN="yes"
39 ```
40 # INFO: Using main config file /etc/letsencrypt.sh/config.sh
41 Processing lukas.im with alternative names: www.lukas.im
42  + Checking domain name(s) of existing cert... unchanged.
43  + Checking expire date of existing cert...
44  + Valid till Jul  7 20:52:00 2016 GMT (Longer than 30 days). Ignoring because renew was forced!
45  + Signing domains...
46  + Generating private key...
47  + Generating signing request...
48  + Requesting challenge for lukas.im...
49  + Requesting challenge for www.lukas.im...
50 HOOK: deploy_challenge lukas.im blablabla blablabla.supersecure www.lukas.im blublublu blublublu.supersecure
51  + Responding to challenge for lukas.im...
52  + Challenge is valid!
53  + Responding to challenge for www.lukas.im...
54  + Challenge is valid!
55 HOOK: clean_challenge lukas.im blablabla blablabla.supersecure www.lukas.im blublublu blublublu.supersecure
56  + Requesting certificate...
57  + Checking certificate...
58  + Done!
59  + Creating fullchain.pem...
60 HOOK: deploy_cert lukas.im /etc/letsencrypt.sh/certs/lukas.im/privkey.pem /etc/letsencrypt.sh/certs/lukas.im/cert.pem /etc/letsencrypt.sh/certs/lukas.im/fullchain.pem /etc/letsencrypt.sh/certs/lukas.im/chain.pem 1460152408
61  + Done!
62 ```
63