Fast and extensible multi-platform HTTP/1-2-3 web server with automatic HTTPS
Mirrored from https://github.com/Slazee/caddy.git
Synced Nov 13, 15:30 UTC
Improve docs for ZeroSSL issuer
Matthew Holt committed
Aug 8, 2022 at 12:48 UTC
b9618b8b98e4267516ac9bd61f2fd4b7f905ab3c
1 file changed
+13
-5
modules/caddytls/zerosslissuer.go
+13
-5
@@ -36,12 +36,20 @@ func init() {
36
caddy.RegisterModule(new(ZeroSSLIssuer))
37
}
38
39
-// ZeroSSLIssuer makes an ACME manager
40
-// for managing certificates using ACME.
39
+// ZeroSSLIssuer makes an ACME issuer for getting certificates
40
+// from ZeroSSL by automatically generating EAB credentials.
41
+// Please be sure to set a valid email address in your config
42
+// so you can access/manage your domains in your ZeroSSL account.
43
+//
44
+// This issuer is only needed for automatic generation of EAB
45
+// credentials. If manually configuring/reusing EAB credentials,
46
+// the standard ACMEIssuer may be used if desired.
47
type ZeroSSLIssuer struct {
48
*ACMEIssuer
49
50
// The API key (or "access key") for using the ZeroSSL API.
51
+ // This is optional, but can be used if you have an API key
52
+ // already and don't want to supply your email address.
53
APIKey string `json:"api_key,omitempty"`
54
55
mu sync.Mutex
@@ -193,9 +201,9 @@ func (iss *ZeroSSLIssuer) Revoke(ctx context.Context, cert certmagic.Certificate
201
202
// UnmarshalCaddyfile deserializes Caddyfile tokens into iss.
203
//
196
-// ... zerossl [<api_key>] {
197
-// ...
198
-// }
204
+// ... zerossl [<api_key>] {
205
+// ...
206
+// }
207
//
208
// Any of the subdirectives for the ACME issuer can be used in the block.
209
func (iss *ZeroSSLIssuer) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {