[pmg-devel] [PATCH pmg-docs v2 1/1] certs: add wildcard certificate support

[Thomas Lamprecht]

On 12.04.21 21:28, Stoiko Ivanov wrote:
> Signed-off-by: Stoiko Ivanov <s.ivanov at proxmox.com>
> ---
>  pmg-ssl-certificate.adoc | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
> 
> diff --git a/pmg-ssl-certificate.adoc b/pmg-ssl-certificate.adoc
> index 6cd44b1..24e8d71 100644
> --- a/pmg-ssl-certificate.adoc
> +++ b/pmg-ssl-certificate.adoc
> @@ -187,6 +187,23 @@ and set the `alias` property in the {pmg} node configuration file
>  `/etc/pmg/node.conf` to `domain2.example` to allow the DNS server of
>  `domain2.example` to validate all challenges for `domain1.example`.
>  
> +[[sysadmin_certs_acme_dns_wildcard]]
> +Wildcard Certificates
> +^^^^^^^^^^^^^^^^^^^^^
> +You can create a certificate for a 'wildcard DNS name' as described in

why the single quotes? I'd rather go for something like

"You can create wildcard certificates with the DNS challenge type."

> +https://community.letsencrypt.org/t/acme-v2-production-environment-wildcards/55578[ACME v2 Production Environment & Wildcards].

Maybe rather link:
https://letsencrypt.org/docs/challenge-types/#dns-01-challenge


> +
> +Wildcard DNS names start with a `*.` prefix and are considered valid for all
> +(one-level) subdomain names of the verified domain. So a certificate for
> +`*.domain.example` is valid for example for `foo.domain.example` and
> +`bar.domain.example`.

above paragraph should come first, as it's the actual introduction to wildcards.
A example for not being valid for deeper level would also help, something like:

"is valid for example for `foo.domain.example` and `bar.domain.example`, but not
for `baz.foo.domain.example`."

> +
> +Verification for wildcard DNS names only works with the `dns-01` validation
> +method.
> +

We should probably check above in the frontend and backend for better UX.

> +You need to configure both the base domain (`domain.example`) as well as the
> +wildcard equivalent (`*.domain.example`) under `Certificates` with a DNS plugin.
> +

above paragraph is wrong.

>  
>  Combination of Plugins
>  ^^^^^^^^^^^^^^^^^^^^^^
>