commit 726d801d970c2f6b4951c6ed44d1839b86683f11
parent e8ce884dc77cacc037fd8cc3f74adc25ed59bf33
Author: Christian Grothoff <christian@grothoff.org>
Date: Fri, 4 Jul 2025 16:06:24 +0200
add ADDRESS_HINT option (#9996)
Diffstat:
1 file changed, 3 insertions(+), 0 deletions(-)
diff --git a/manpages/challenger.conf.5.rst b/manpages/challenger.conf.5.rst
@@ -71,6 +71,9 @@ AUTH_COMMAND
ADDRESS_TYPE
Type of the address that is being collected, returned as part of the ``address_type`` in the ``/info`` endpoint. Examples include ``email`` or ``phone``.
+ADDRESS_HINT
+ Hint to show to users for entering the address. Should be an example address in the right format.
+
ADDRESS_RESTRICTIONS
JSON object with a map of keys (names of the fields of the address to be entered by the user) to objects with a "regex" (string) containing an extended Posix regular expression for allowed address field values, and a "hint"/"hint_i18n" giving a human-readable explanation to display if the value entered by the user does not match the regex. Keys that are not mapped to such an object have no restriction on the value provided by the user. Examples would be '{"email":{"hint":"valid e-mail address required","regex":"^[a-zA-Z0-9\_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$"}' or '{"zip":{"hint":"numeric zip code required","regex":"^[0-9]+$"}'.
