Skip to content

Commit 904b5e3

Browse files
Docs: Clarify standalone dns01 API configuration structure with example (#1155)
* adding additional documentation detail for standalone DNS-01 verification * added example * Update Standalone-certificates.md * minor mistake * Update Standalone-certificates.md * Update Standalone-certificates.md
1 parent 044f056 commit 904b5e3

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

docs/Standalone-certificates.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,16 +51,51 @@ LETSENCRYPT_app_HOST=('myapp.yourdomain.tld' 'myapp.yourotherdomain.tld' 'servic
5151
LETSENCRYPT_othersite_HOST=('yetanotherdomain.tld')
5252
```
5353

54+
**Example using DNS-01 verification:**
55+
56+
In this example: `web` and `app` generate a certificate using the global/default configuration. However `othersite` will perform it's certificate verification using a specific DNS-01 API configuration.
57+
58+
```bash
59+
LETSENCRYPT_STANDALONE_CERTS=('web' 'app' 'othersite')
60+
LETSENCRYPT_web_HOST=('yourdomain.tld' 'www.yourdomain.tld')
61+
LETSENCRYPT_app_HOST=('myapp.yourdomain.tld' 'myapp.yourotherdomain.tld' 'service.yourotherdomain.tld')
62+
LETSENCRYPT_othersite_HOST=('yetanotherdomain.tld')
63+
64+
ACME_othersite_CHALLENGE=DNS-01
65+
declare -A ACMESH_othersite_DNS_API_CONFIG=(
66+
['DNS_API']='dns_cf'
67+
['CF_Token']='<CLOUDFLARE_TOKEN>'
68+
['CF_Account_ID']='<CLOUDFLARE_ACCOUNT_ID>'
69+
['CF_Zone_ID']='<CLOUDFLARE_ZONE_ID>'
70+
)
71+
```
72+
5473
### Optional configuration parameters:
5574

56-
Those are all single bash variables.
75+
Single bash variables:
5776

5877
`LETSENCRYPT_uniqueidentifier_EMAIL` : must be a valid email and will be used by Let's Encrypt to warn you of impeding certificate expiration (should the automated renewal fail).
5978

6079
`LETSENCRYPT_uniqueidentifier_KEYSIZE` : determines the size of the requested private key. See [private key size](./Let's-Encrypt-and-ACME.md#private-key-size) for accepted values.
6180

6281
`LETSENCRYPT_uniqueidentifier_TEST` : if set to true, the corresponding certificate will be a test certificates: it won't have the 5 certs/week/domain limits and will be signed by an untrusted intermediate (ie it won't be trusted by browsers).
6382

83+
DNS-01 related variables:
84+
85+
`ACME_uniqueidentifier_CHALLENGE`: Defaults to HTTP-01. In order to switch to the DNS-01 ACME challenge set it to `DNS-01`
86+
87+
`ACMESH_uniqueidentifier_DNS_API_CONFIG`: Defaults to the values of DNS_API_CONFIG. However if you wish to specify a specific DNS-01 verification method on a particular standalone certificate. It must be defined as a bash associative array.
88+
89+
Example
90+
```bash
91+
declare -A ACMESH_alt_DNS_API_CONFIG=(
92+
['DNS_API']='dns_cf'
93+
['CF_Token']='<CLOUDFLARE_TOKEN>'
94+
['CF_Account_ID']='<CLOUDFLARE_ACCOUNT_ID>'
95+
['CF_Zone_ID']='<CLOUDFLARE_ZONE_ID>'
96+
)
97+
```
98+
6499
### Picking up changes to letsencrypt_user_data
65100

66101
The container does not actively watch the `/app/letsencrypt_user_data` file for changes.

0 commit comments

Comments
 (0)