doc: Update configs

Signed-off-by: Stéphane Graber <[email protected]>
lxc · Feb 27, 2025 · 2db43a8 · 2db43a8
1 parent 59c1dba
commit 2db43a8
Show file tree

Hide file tree

Showing 2 changed files with 68 additions and 0 deletions.
diff --git a/doc/config_options.txt b/doc/config_options.txt
@@ -2066,6 +2066,14 @@ Specify the number of days after which the unused cached image expires.
 
 ```
 
+```{config:option} acme.challenge server-acme
+:defaultdesc: "`HTTP-01`"
+:scope: "global"
+:shortdesc: "ACME challenge type to use"
+:type: "string"
+Possible values are `DNS-01` and `HTTP-01`.
+```
+
 ```{config:option} acme.domain server-acme
 :scope: "global"
 :shortdesc: "Domain for which the certificate is issued"
@@ -2080,6 +2088,30 @@ Specify the number of days after which the unused cached image expires.
 
 ```
 
+```{config:option} acme.provider server-acme
+:defaultdesc: "``"
+:scope: "global"
+:shortdesc: "Backend provider for the challenge (used by DNS-01)"
+:type: "string"
+
+```
+
+```{config:option} acme.provider.environment server-acme
+:defaultdesc: "``"
+:scope: "global"
+:shortdesc: "Environment variables to set during the challenge (used by DNS-01)"
+:type: "string"
+
+```
+
+```{config:option} acme.provider.resolvers server-acme
+:defaultdesc: "``"
+:scope: "global"
+:shortdesc: "Comma-separated list of DNS resolvers (used by DNS-01)"
+:type: "string"
+DNS resolvers to use for performing (recursive) `CNAME` resolving and apex domain determination during DNS-01 challenge.
+```
+
 <!-- config group server-acme end -->
 <!-- config group server-cluster start -->
 ```{config:option} cluster.healing_threshold server-cluster

diff --git a/internal/server/metadata/configuration.json b/internal/server/metadata/configuration.json
@@ -2278,6 +2278,15 @@
 							"type": "string"
 						}
 					},
+					{
+						"acme.challenge": {
+							"defaultdesc": "`HTTP-01`",
+							"longdesc": "Possible values are `DNS-01` and `HTTP-01`.",
+							"scope": "global",
+							"shortdesc": "ACME challenge type to use",
+							"type": "string"
+						}
+					},
 					{
 						"acme.domain": {
 							"longdesc": "",
@@ -2293,6 +2302,33 @@
 							"shortdesc": "Email address used for the account registration",
 							"type": "string"
 						}
+					},
+					{
+						"acme.provider": {
+							"defaultdesc": "``",
+							"longdesc": "",
+							"scope": "global",
+							"shortdesc": "Backend provider for the challenge (used by DNS-01)",
+							"type": "string"
+						}
+					},
+					{
+						"acme.provider.environment": {
+							"defaultdesc": "``",
+							"longdesc": "",
+							"scope": "global",
+							"shortdesc": "Environment variables to set during the challenge (used by DNS-01)",
+							"type": "string"
+						}
+					},
+					{
+						"acme.provider.resolvers": {
+							"defaultdesc": "``",
+							"longdesc": "DNS resolvers to use for performing (recursive) `CNAME` resolving and apex domain determination during DNS-01 challenge.",
+							"scope": "global",
+							"shortdesc": "Comma-separated list of DNS resolvers (used by DNS-01)",
+							"type": "string"
+						}
 					}
 				]
 			},