From c2172dcc785db6402b8944d1ba0d0e1f646cf8c8 Mon Sep 17 00:00:00 2001 From: Kekalainen Date: Thu, 5 Sep 2024 00:36:44 +0300 Subject: [PATCH 1/3] docs: Update ZeroSSL issuer for v2.8 --- src/docs/markdown/caddyfile/directives/tls.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/src/docs/markdown/caddyfile/directives/tls.md b/src/docs/markdown/caddyfile/directives/tls.md index c1c122d..0971025 100644 --- a/src/docs/markdown/caddyfile/directives/tls.md +++ b/src/docs/markdown/caddyfile/directives/tls.md @@ -359,23 +359,22 @@ Obtains certificates using the ACME protocol. Note that `acme` is a default issu - **any_common_name** is a list of one or more common names; Caddy will choose the first chain that has an issuer that matches with at least one of the specified common names. +##### ZeroSSL + +Caddy will implicitly use [ZeroSSL's ACME endpoint](https://zerossl.com/documentation/acme/) (and generate EAB credentials) if you specify the the [`email` global option](/docs/caddyfile/options#email). + +To provide your own EAB credentials for ZeroSSL, specify the `dir` and `eab` options. #### zerossl -Obtains certificates using the ACME protocol, specifically with ZeroSSL. Note that `zerossl` is a default issuer, so configuring it explicitly is usually unnecessary. +Obtains certificates using the ZeroSSL API. ```caddy-d -... zerossl [] { +... zerossl { ... } ``` -The syntax for `zerossl` is exactly the same as for [`acme`](#acme), except that its name is `zerossl` and it can optionally take your ZeroSSL API key. - -Its functionality is also the same, except that it will use ZeroSSL's directory by default and it can automatically negotiate EAB credentials (whereas with the `acme` issuer, you have to manually provide EAB credentials and set the directory endpoint). - -When explicitly configuring `zerossl`, configuring an `email` is required so that your certificates can appear in your ZeroSSL dashboard. - #### internal Obtains certificates from an internal certificate authority. From c797f47e67e5282e2eee043a0348b1763d879e51 Mon Sep 17 00:00:00 2001 From: Kekalainen Date: Fri, 6 Sep 2024 15:21:15 +0300 Subject: [PATCH 2/3] docs: Restore previous issuer sections, disambiguate --- src/docs/markdown/caddyfile/directives/tls.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/docs/markdown/caddyfile/directives/tls.md b/src/docs/markdown/caddyfile/directives/tls.md index 0971025..776394f 100644 --- a/src/docs/markdown/caddyfile/directives/tls.md +++ b/src/docs/markdown/caddyfile/directives/tls.md @@ -359,15 +359,17 @@ Obtains certificates using the ACME protocol. Note that `acme` is a default issu - **any_common_name** is a list of one or more common names; Caddy will choose the first chain that has an issuer that matches with at least one of the specified common names. -##### ZeroSSL + + #### zerossl -Obtains certificates using the ZeroSSL API. +Obtains certificates using the [ZeroSSL API](https://zerossl.com/documentation/api/). ```caddy-d ... zerossl { From 5c827fd44801ce21b6916bba3c7210e5d00d47dd Mon Sep 17 00:00:00 2001 From: Kekalainen Date: Fri, 6 Sep 2024 15:30:16 +0300 Subject: [PATCH 3/3] docs: Add fields for zerossl issuer module --- src/docs/markdown/caddyfile/directives/tls.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/src/docs/markdown/caddyfile/directives/tls.md b/src/docs/markdown/caddyfile/directives/tls.md index 776394f..cf3318d 100644 --- a/src/docs/markdown/caddyfile/directives/tls.md +++ b/src/docs/markdown/caddyfile/directives/tls.md @@ -373,10 +373,18 @@ Obtains certificates using the [ZeroSSL API](https://zerossl.com/documentation/a ```caddy-d ... zerossl { - ... + validity_days + alt_http_port + dns [] + propagation_delay + propagation_timeout + resolvers + dns_ttl } ``` +Fields for the `zerossl` issuer module share the syntax of those in common with the [`acme` issuer module](#acme). + #### internal Obtains certificates from an internal certificate authority.