commit 9c39c8f01a8c07257463d84569f59a33a1d5a020 parent f678df93fee97ed75d4c974681f72538cff09716 Author: Martin Schanzenbach <schanzen@gnunet.org> Date: Fri, 20 Mar 2026 16:15:51 +0100 add taler directory manpages Diffstat:
| A | manpages/taler-directory-config.1.rst | | | 70 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | manpages/taler-directory-dbinit.1.rst | | | 53 | +++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | manpages/taler-directory-httpd.1.rst | | | 53 | +++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | manpages/taler-directory.conf.5.rst | | | 179 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
4 files changed, 355 insertions(+), 0 deletions(-)
diff --git a/manpages/taler-directory-config.1.rst b/manpages/taler-directory-config.1.rst @@ -0,0 +1,70 @@ +taler-directory-config(1) +######################### + +.. only:: html + + Name + ==== + + **taler-directory-config** - manipulate taler-directory configuration file + +Synopsis +======== + +**taler-directory-config** +[**-c** *filename* | **--config=**\ \ *filename*] +[**-h** | **--help**] +[**-L** *loglevel* | **--loglevel=**\ \ *loglevel*] +[**-l** *filename* | **--logfile=**\ \ *filename*] +[**-o** *option* | **--option=**\ \ *option*] +[**-O** | **--only-value**] +[**-S** | **--list-sections**] +[**-s** *section* | **--section=**\ \ *section*] +[**-v** | **--version**] + + +Description +=========== + +**taler-directory-config** can be used to read or modify taler-directory configuration files. + +**-c** *FILENAME* \| **--config=**\ \ *FILENAME* + Use the configuration file *FILENAME*. + +**-h** \| **--help** + Print short help on options. + +**-L** *LOGLEVEL* \| **--loglevel=**\ \ *LOGLEVEL* + Use *LOGLEVEL* for logging. + Valid values are ``DEBUG``, ``INFO``, ``WARNING``, and ``ERROR``. + +**-o** *OPTION* \| **--option=**\ \ *OPTION* + Which configuration option should be accessed or edited. Required to set a + value. If not given, all values of a given section will be printed in the + format "OPTION = VALUE". + +**-O** \| **--only-value** + Print only the value(s), not the key(s). + +**-S** \| **--list-sections** + List available configuration sections for use with ``--section``. + +**-s** *SECTION* \| **--section=**\ \ *SECTION* + Which configuration section should be accessed or edited. + Required option. + +**-v** \| **--version** + Print GNU Taler version number. + + +See Also +======== + +taler-directory-dbinit(1), taler-directory-httpd(1), taler-directory.conf(5). + + +Bugs +==== + +Report bugs by using https://bugs.taler.net or by sending electronic +mail to <taler@gnu.org>. diff --git a/manpages/taler-directory-dbinit.1.rst b/manpages/taler-directory-dbinit.1.rst @@ -0,0 +1,53 @@ +taler-directory-dbinit(1) +######################### + +.. only:: html + + Name + ==== + + **taler-directory-dbinit** - initialize the taler-directory database + + +Synopsis +======== + +**taler-directory-dbinit** +[**-c** *FILENAME* | **--config=**\ \ *FILENAME*] +[**-h** | **--help**] +[**-L** | **--loglevel**] +[**-v** | **--version**] + + +Description +=========== + +**taler-directory-dbinit** is a command-line tool to initialize the taler-directory database. + +Its options are as follows: + +**-c** *FILENAME* \| **--config=**\ \ *FILENAME* + Use the configuration and other resources for the taler-directory commands + to operate from *FILENAME*. + +**-h** \| **--help** + Print short help on options. + +**-L** *LOGLEVEL* \| **--log=**\ \ *LOGLEVEL* + Configure logging to use *LOGLEVEL*. + +**-v** \| **–version** + Print version information. + + +See Also +======== + +taler-directory-config(1), taler-directory-httpd(1), taler-directory.conf(5). + + +Bugs +==== + +Report bugs by using https://bugs.taler.net or by sending electronic +mail to <taler@gnu.org>. diff --git a/manpages/taler-directory-httpd.1.rst b/manpages/taler-directory-httpd.1.rst @@ -0,0 +1,53 @@ +taler-directory-httpd(1) +######################## + +.. only:: html + + Name + ==== + + **taler-directory-httpd** - provide the taler-directory HTTP interface + + +Synopsis +======== + +**taler-directory-httpd** +[**-c** *FILENAME* | **--config=**\ \ *FILENAME*] +[**-h** | **--help**] +[**-L** *LOGLEVEL* | **--log=**\ \ *LOGLEVEL*] +[**-l** *FILENAME* | **--logfile=**\ \ *FILENAME*] +[**-v** | **--version**] + + +Description +=========== + +**taler-directory-httpd** is a command-line tool to provide the taler-directory HTTP interface. + +Its options are as follows: + +**-c** *FILENAME* \| **--config=**\ \ *FILENAME* + Use the configuration and other resources for the taler-directory commands + to operate from *FILENAME*. + +**-h** \| **--help** + Print short help on options. + +**-L** *LOGLEVEL* \| **--log=**\ \ *LOGLEVEL* + Configure logging to use *LOGLEVEL*. + +**-v** \| **–version** + Print version information. + +See Also +======== + +taler-directory-config(1), taler-directory-dbinit(1), taler-directory.conf(5). + + +Bugs +==== + +Report bugs by using https://bugs.taler.net or by sending electronic +mail to <taler@gnu.org>. diff --git a/manpages/taler-directory.conf.5.rst b/manpages/taler-directory.conf.5.rst @@ -0,0 +1,179 @@ +taler-directory.conf(5) +####################### + +.. only:: html + + Name + ==== + + **taler-directory.conf** - taler-directory configuration file + + +Description +=========== + +.. include:: ../frags/common-conf-syntax.rst + +Files containing default values for many of the options described below +are installed under ``$PREFIX/share/taler-directory/config.d/``. +The configuration file given with **-c** to taler-directory binaries +overrides these defaults. + +A configuration file may include another, by using the ``@INLINE@`` directive, +for example, in ``main.conf``, you could write ``@INLINE@ sub.conf`` to +include the entirety of ``sub.conf`` at that point in ``main.conf``. + +Be extra careful when using ``taler-directory-config -V VALUE`` to change configuration +values: it will destroy all uses of ``@INLINE@`` and furthermore remove all +comments from the configuration file! + + +GLOBAL OPTIONS +-------------- + +The following options are from the “[taler-directory]” section. + +BASE_URL + The base URL of the service. If your service is proxied, the external base URL this service is availiable at. + Default: ``http://localhost:11000`` + +CHALLENGE_BYTES + Number of bytes of the challenge. + Default: ``16`` + +VALIDATION_INITIATION_MAX + Maximum number of pending validations for the same alias. + Default: ``3`` + +SOLUTION_ATTEMPT_MAX + Maximum times a solution may be attempted for an active validation. + Default: ``3`` + +VALIDATION_TIMEFRAME + Cooldown period between two successive validation requests (for the same alias). + Default: ``5m`` + +SOLUTION_ATTEMPT_TIMEFRAME + Duration for which a solution must be provided for any given validation. + Default: ``1h`` + +VALIDATION_EXPIRATION + Time until a pending validation expires + Default: ``24h`` + +VALID_PAYMENT_SYSTEM_ADDRESS_REGEX + Defines valid payment system addresses that may be registered. + Default: ``.*`` + +MONTHLY_FEE + Cost for registration of a single month. + Default: ``KUDOS:0`` + +NAVIGATION + The navigation (header) HTML template file. If relative will be interpreted relative to DATADIR. + Default: ``web/templates/nav.html`` + +FOOTER + The footer HTML template file. If relative will be interpreted relative to DATADIR. + Default: ``web/templates/footer.html`` + +IMPRINT_PAGE + The imprint HTML template file. If relative will be interpreted relative to DATADIR. + Default: ``web/templates/imprint.html`` + +ABOUT_PAGE + The about HTML template file. If relative will be interpreted relative to DATADIR. + Default: ``web/templates/about.html`` + +LANDING_PAGE + The landing page HTML template file. If relative will be interpreted relative to DATADIR. + Default: ``web/templates/landing.html`` + +VALIDATION_LANDING + The validation landing HTML template file. If relative will be interpreted relative to DATADIR. + Default: ``web/templates/validation_landing.html`` + +LOOKUP_RESULT_PAGE + The lookup result HTML template file. If relative will be interpreted relative to DATADIR. + Default: ``web/templates/validation_landing.html`` + + +The following options are from a “[taler-directory-<validator>]” section. + +ENABLED + Is this validator enabled or disabled. + Default: ``false`` + +TYPE + What type of validator is this. Options: ``command``, ``oidc``. + Default: ``command`` + +CHALLENGE_FEE + What does the initiation of a challenge cost. + Default: ``KUDOS:0`` + +VALID_ALIAS_REGEX + Defines which aliases are valid in this validator context. + Default: empty + +COMMAND + Only when TYPE ``command``. The command to execute. Must be set if TYPE is ``command``. + Default: unset + +SENDER + What should the sender of the email be. Only read by the email validator. + Default: unset + +AUTHORIZATION_ENDPOINT + Only when TYPE ``oidc``. The URI of the authorization endpoint. + Default: unset + +TOKEN_ENDPOINT + Only when TYPE ``oidc``. The URI of the token endpoint. + Default: unset + +USERINFO_ENDPOINT + Only when TYPE ``oidc``. The URI of the userinfo endpoint. + Default: unset + +CLIENT_ID + Only when TYPE ``oidc``. The OAuth client_id. + Default: unset + +CLIENT_SECRET + Only when TYPE ``oidc``. The OAuth client_secret. + Default: unset + +SCOPE + Only when TYPE ``oidc``. The OAuth scope(s) to request. + Default: unset + +ALIAS_CLAIM + Only when TYPE ``oidc``. The claim to read from the userinfo response. Must be equal to the alias that is being validated. + Default: ``sub`` + +The following options are from a “[taler-directory-<disseminator>]” section. + +ENABLED + Is this disseminator enabled or disabled. + Default: ``false`` + +ZONE + The name (not ZEKY) of the local zone authoritative for publication of the directory. + Default: unset + +EXPIRATION + The relative expiration time of the record sets. + Default: ``1d`` + +SEE ALSO +======== + +taler-directory-dbinit(1), taler-directory-httpd(1), taler-directory-config(1). + + +BUGS +==== + +Report bugs by using https://bugs.taler.net/ or by sending electronic +mail to <taler@gnu.org>.