From 1fba029da0ba66c16a2fd90e45ebbc9331c9d2c3 Mon Sep 17 00:00:00 2001 From: Fernandez Ludovic Date: Fri, 20 Sep 2024 00:26:13 +0200 Subject: [PATCH] chore: generate --- docs/content/dns/zz_gen_selfhostde.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/docs/content/dns/zz_gen_selfhostde.md b/docs/content/dns/zz_gen_selfhostde.md index 62c5838db7..a7c3996519 100644 --- a/docs/content/dns/zz_gen_selfhostde.md +++ b/docs/content/dns/zz_gen_selfhostde.md @@ -59,24 +59,34 @@ More information [here]({{% ref "dns#configuration-and-credentials" %}}). The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. More information [here]({{% ref "dns#configuration-and-credentials" %}}). -SelfHost.de doesn't have an API to create or delete TXT records, there is only an "unofficial" and undocumented endpoint to update an existing TXT record. +SelfHost.de doesn't have an API to create or delete TXT records, +there is only an "unofficial" and undocumented endpoint to update an existing TXT record. So, before using lego to request a certificate for a given domain or wildcard (such as `my.example.org` or `*.my.example.org`), -you should create: +you must create: + - one TXT record named `_acme-challenge.my.example.org` if you are **not** using wildcard for this domain. - two TXT records named `_acme-challenge.my.example.org` if you are using wildcard for this domain. After that you must edit the TXT record(s) to get the ID(s). -You should recreate a mapping to fill the `SELFHOSTDE_RECORDS_MAPPING` environement variable as following: +You then must prepare the `SELFHOSTDE_RECORDS_MAPPING` environment variable with the following format: ``` ::,::,:: ``` -Each group of domain + record id(s) is separated with a comma `,`. +where each group of domain + record ID(s) is separated with a comma (`,`), +and the domain and record ID(s) are separated with a colon (`:`). + +For example, if you want to create or renew a certificate for `my.example.org`, `*.my.example.org`, and `other.example.org`, +you would need: + +- two separate records for `_acme-challenge.my.example.org` +- and another separate record for `_acme-challenge.other.example.org` + +The resulting environment variable would then be: `SELFHOSTDE_RECORDS_MAPPING=my.example.com:123:456,other.example.com:789` -Each record id is separated with 2 dots `:`.