]> git.kaiwu.me - haproxy.git/commitdiff
DOC: acme: document missing acme-vars and provider-name keywords
authorWilliam Lallemand <wlallemand@haproxy.com>
Mon, 4 May 2026 12:40:20 +0000 (14:40 +0200)
committerWilliam Lallemand <wlallemand@haproxy.com>
Mon, 4 May 2026 12:44:53 +0000 (14:44 +0200)
Both keywords are used with dns-01 and dns-persist-01 challenges to pass
information to an external DNS provisioning tool (e.g. the dataplaneAPI)
via the "dpapi" sink. provider-name sets the DNS provider identifier and
acme-vars passes arbitrary tool-specific variables.

Thanks to @oliwer for reporting the issue.

Must be backported to 3.2, however previous version don't have
"dns-persist-01".

doc/configuration.txt

index 1ea7ed3ca4d09051d93449a48e96ce50a7cd856a..3316db7c9e6e40680a659742ec43f3d5372bcc92 100644 (file)
@@ -32447,6 +32447,16 @@ account-key <filename>
 
     openssl ecparam -name secp384r1 -genkey -noout -out account.key
 
+acme-vars <string>
+  Pass arbitrary variables to the external DNS provisioning tool (e.g. the
+  dataplaneAPI) via the "dpapi" sink. The semantics are tool-specific; refer
+  to your DNS provisioning tool's documentation.
+
+  This keyword is only meaningful when the challenge type is "dns-01" or
+  "dns-persist-01".
+
+  See also: "challenge", "provider-name"
+
 bits <number>
   Configure the number of bits to generate an RSA certificate. Default to 2048.
   Setting a too high value can trigger a warning if your machine is not
@@ -32596,6 +32606,16 @@ profile <string>
     # Request short-lived certificates
     profile shortlived
 
+provider-name <string>
+  Set the DNS provider name passed to the external DNS provisioning tool (e.g.
+  the dataplaneAPI) via the "dpapi" sink. The accepted values are
+  tool-specific; refer to your DNS provisioning tool's documentation.
+
+  This keyword is only meaningful when the challenge type is "dns-01" or
+  "dns-persist-01".
+
+  See also: "challenge", "acme-vars"
+
 reuse-key { on | off }
   If set to "on", HAProxy won't generate a new private key and will keep the
   previous one. Rotating private keys is recommended, when enabling this option