From b9618b8b98e4267516ac9bd61f2fd4b7f905ab3c Mon Sep 17 00:00:00 2001
From: Matthew Holt <mholt@users.noreply.github.com>
Date: Mon, 8 Aug 2022 12:48:28 -0600
Subject: [PATCH] Improve docs for ZeroSSL issuer
---
modules/caddytls/zerosslissuer.go | 18 +++++++++++++-----
1 file changed, 13 insertions(+), 5 deletions(-)
diff --git a/modules/caddytls/zerosslissuer.go b/modules/caddytls/zerosslissuer.go
index a051ed479..c7ff70fbd 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 {