Skip to content

Commit 4fcd3d2

Browse files
committed
docs(certbot): state the DNS-wait clamp where the setting is
The page said a mismatched record costs the full `max_dns_wait`, while its own example is clamped to a quarter of that: `advisory_dns_wait` caps the wait at half of `renew_timeout`, so 120/300 waits 60s. An operator giving a slow zone more time by raising `max_dns_wait` alone, following this page, would see no change and no reason why -- the clamp logs at `debug` deliberately, because the stock 300/300 defaults would otherwise fire it on every issuance in every deployment.
1 parent 8b6f811 commit 4fcd3d2

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

docs/certbot-dns-persist-01.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,11 @@ domains = ["example.com", "*.example.com"]
7171
renew_interval = 3600
7272
renew_days_before = 10
7373
renew_timeout = 120
74+
# Capped at half of renew_timeout, so this one waits 60s, not 300s. The whole
75+
# order -- the wait, the authorizations, finalize, and fetching the certificate
76+
# -- has to fit inside renew_timeout, and a wait that outlasts it takes the
77+
# timeout with it, losing the warning naming the record that was missing.
78+
# Raising this alone changes nothing; raise renew_timeout with it.
7479
max_dns_wait = 300
7580
```
7681

@@ -117,8 +122,10 @@ Error: order is invalid: API error: Checking DNS-PERSIST-01 challenge TXT record
117122
The check is advisory and never blocks an order: certbot's resolver is not the
118123
CA's, and its expectation can be stricter than what the CA would accept. A
119124
warning with a successful issuance underneath it is a resolver difference, not
120-
a problem. A record that genuinely does not match costs the full `max_dns_wait`
121-
before the order is sent, because the check waits out its budget first.
125+
a problem. A record that genuinely does not match costs the whole DNS budget
126+
before the order is sent, because the check waits it out first -- that is
127+
`max_dns_wait`, or half of `renew_timeout` when that is smaller, which for the
128+
configuration above is 60s. certbot logs the budget it settled on at `debug`.
122129

123130
If the CA rejects the order, compare the published record against
124131
`certbot dns-records` character by character. The usual causes are a stale

0 commit comments

Comments
 (0)