caddytls: Update docs for on-demand config

Matthew Holt committed Aug 9, 2023 at 11:15 UTC 080db938170ce154def7c6eb860634ffc6168c1c

1 file changed +19 -16

modules/caddytls/automation.go

+19 -16

@@ -459,29 +459,32 @@ type DNSChallengeConfig struct {

459 // Caddy can "ask" if it should be allowed to manage

460 // certificates for a given hostname.

461 type OnDemandConfig struct {

462 - // An optional rate limit to throttle the

463 - // issuance of certificates from handshakes.

464 - RateLimit *RateLimit `json:"rate_limit,omitempty"`

465 -

466 - // REQUIRED. If Caddy needs to obtain/renew a certificate

467 - // during a TLS handshake, it will perform a quick

468 - // HTTP request to this URL to check if it should be

469 - // allowed to try to get a certificate for the name

470 - // in the "domain" query string parameter, like so:

471 - // `?domain=example.com`. The endpoint must return a

472 - // 200 OK status if a certificate is allowed;

473 - // anything else will cause it to be denied.

462 + // REQUIRED. If Caddy needs to load a certificate from

463 + // storage or obtain/renew a certificate during a TLS

464 + // handshake, it will perform a quick HTTP request to

465 + // this URL to check if it should be allowed to try to

466 + // get a certificate for the name in the "domain" query

467 + // string parameter, like so: `?domain=example.com`.

468 + // The endpoint must return a 200 OK status if a certificate

469 + // is allowed; anything else will cause it to be denied.

470 // Redirects are not followed.

471 Ask string `json:"ask,omitempty"`

472 +

473 + // DEPRECATED. An optional rate limit to throttle

474 + // the checking of storage and the issuance of

475 + // certificates from handshakes if not already in

476 + // storage. WILL BE REMOVED IN A FUTURE RELEASE.

477 + RateLimit *RateLimit `json:"rate_limit,omitempty"`

478 }

479

478 -// RateLimit specifies an interval with optional burst size.

480 +// DEPRECATED. RateLimit specifies an interval with optional burst size.

481 type RateLimit struct {

480 - // A duration value. A certificate may be obtained 'burst'

481 - // times during this interval.

482 + // A duration value. Storage may be checked and a certificate may be

483 + // obtained 'burst' times during this interval.

484 Interval caddy.Duration `json:"interval,omitempty"`

485

484 - // How many times during an interval a certificate can be obtained.

486 + // How many times during an interval storage can be checked or a

487 + // certificate can be obtained.

488 Burst int `json:"burst,omitempty"`

489 }

490