diff options
| author | Matthew Holt <mholt@users.noreply.github.com> | 2022-08-08 12:48:28 -0600 |
|---|---|---|
| committer | Matthew Holt <mholt@users.noreply.github.com> | 2022-08-08 12:50:06 -0600 |
| commit | b9618b8b98e4267516ac9bd61f2fd4b7f905ab3c (patch) | |
| tree | 1ece53706a471e9b4d7f18f6a9a93bc3cd3d4c13 | |
| parent | d26559316fa6fae880351637365f07947a2b79f6 (diff) | |
Improve docs for ZeroSSL issuer
| -rw-r--r-- | modules/caddytls/zerosslissuer.go | 18 |
1 files changed, 13 insertions, 5 deletions
diff --git a/modules/caddytls/zerosslissuer.go b/modules/caddytls/zerosslissuer.go index a051ed4..c7ff70f 100644 --- a/modules/caddytls/zerosslissuer.go +++ b/modules/caddytls/zerosslissuer.go @@ -36,12 +36,20 @@ func init() { caddy.RegisterModule(new(ZeroSSLIssuer)) } -// ZeroSSLIssuer makes an ACME manager -// for managing certificates using ACME. +// ZeroSSLIssuer makes an ACME issuer for getting certificates +// from ZeroSSL by automatically generating EAB credentials. +// Please be sure to set a valid email address in your config +// so you can access/manage your domains in your ZeroSSL account. +// +// This issuer is only needed for automatic generation of EAB +// credentials. If manually configuring/reusing EAB credentials, +// the standard ACMEIssuer may be used if desired. type ZeroSSLIssuer struct { *ACMEIssuer // The API key (or "access key") for using the ZeroSSL API. + // This is optional, but can be used if you have an API key + // already and don't want to supply your email address. APIKey string `json:"api_key,omitempty"` mu sync.Mutex @@ -193,9 +201,9 @@ func (iss *ZeroSSLIssuer) Revoke(ctx context.Context, cert certmagic.Certificate // UnmarshalCaddyfile deserializes Caddyfile tokens into iss. // -// ... zerossl [<api_key>] { -// ... -// } +// ... zerossl [<api_key>] { +// ... +// } // // Any of the subdirectives for the ACME issuer can be used in the block. func (iss *ZeroSSLIssuer) UnmarshalCaddyfile(d *caddyfile.Dispenser) error { |