diff options
author | Matthew Holt <mholt@users.noreply.github.com> | 2021-09-24 18:31:01 -0600 |
---|---|---|
committer | Matthew Holt <mholt@users.noreply.github.com> | 2021-09-24 18:31:01 -0600 |
commit | 501da21f209c9fad92c65c8ba02a969a03ec5379 (patch) | |
tree | c60876dc13b4277bb933feea19b4494a26f639ed /modules/caddytls/acmeissuer.go | |
parent | 3336faf25466b1b2d9a007f5468d05a887e16775 (diff) |
General minor improvements to docs
Diffstat (limited to 'modules/caddytls/acmeissuer.go')
-rw-r--r-- | modules/caddytls/acmeissuer.go | 15 |
1 files changed, 6 insertions, 9 deletions
diff --git a/modules/caddytls/acmeissuer.go b/modules/caddytls/acmeissuer.go index b60e560..9a7e73c 100644 --- a/modules/caddytls/acmeissuer.go +++ b/modules/caddytls/acmeissuer.go @@ -36,20 +36,16 @@ func init() { caddy.RegisterModule(ACMEIssuer{}) } -// ACMEIssuer makes an ACME manager -// for managing certificates using ACME. -// -// TODO: support multiple ACME endpoints (probably -// requires an array of these structs) - caddy would -// also have to load certs from the backup CAs if the -// first one is expired... +// ACMEIssuer manages certificates using the ACME protocol (RFC 8555). type ACMEIssuer struct { - // The URL to the CA's ACME directory endpoint. + // The URL to the CA's ACME directory endpoint. Default: + // https://acme-v02.api.letsencrypt.org/directory CA string `json:"ca,omitempty"` // The URL to the test CA's ACME directory endpoint. // This endpoint is only used during retries if there - // is a failure using the primary CA. + // is a failure using the primary CA. Default: + // https://acme-staging-v02.api.letsencrypt.org/directory TestCA string `json:"test_ca,omitempty"` // Your email address, so the CA can contact you if necessary. @@ -71,6 +67,7 @@ type ACMEIssuer struct { ExternalAccount *acme.EAB `json:"external_account,omitempty"` // Time to wait before timing out an ACME operation. + // Default: 0 (no timeout) ACMETimeout caddy.Duration `json:"acme_timeout,omitempty"` // Configures the various ACME challenge types. |