commit 532d8c15e493f4004bc537180fb96092dcdc2f59
parent c93cc33e6b025ecfa96bd784bb7d5646d5f0b7fa
Author: Martin Schanzenbach <schanzen@gnunet.org>
Date: Sat, 21 Mar 2026 10:04:46 +0100
fix directory and mailbox config file names
Diffstat:
6 files changed, 278 insertions(+), 6 deletions(-)
diff --git a/conf.py b/conf.py
@@ -430,6 +430,34 @@ man_pages = [
5,
),
(
+ "manpages/taler-mailbox-config.1",
+ "taler-mailbox-config",
+ "manipulate Taler mailbox configuration files",
+ "GNU Taler contributors",
+ 1,
+ ),
+ (
+ "manpages/taler-mailbox-dbinit.1",
+ "taler-mailbox-dbinit",
+ "initialize the Taler mailbox database",
+ "GNU Taler contributors",
+ 1,
+ ),
+ (
+ "manpages/taler-mailbox-httpd.1",
+ "taler-mailbox-httpd",
+ "provide the Taler mailbox HTTP interface",
+ "GNU Taler contributors",
+ 1,
+ ),
+ (
+ "manpages/taler-mailbox.conf.5",
+ "taler-mailbox.conf",
+ "Taler mailbox configuration file",
+ "GNU Taler contributors",
+ 5,
+ ),
+ (
"manpages/donau-config.1",
"donau-config",
"manipulate Donau configuration files",
diff --git a/manpages/taler-directory.conf.5.rst b/manpages/taler-directory.conf.5.rst
@@ -1,12 +1,12 @@
-taler-directory.conf(5)
-#######################
+directory.conf(5)
+#################
.. only:: html
Name
====
- **taler-directory.conf** - taler-directory configuration file
+ **directory.conf** - taler-directory configuration file
Description
@@ -31,7 +31,7 @@ comments from the configuration file!
GLOBAL OPTIONS
--------------
-The following options are from the “[taler-directory]” section.
+The following options are from the “[directory]” section.
BASE_URL
The base URL of the service. If your service is proxied, the external base URL this service is availiable at.
@@ -98,7 +98,7 @@ LOOKUP_RESULT_PAGE
Default: ``web/templates/validation_landing.html``
-The following options are from a “[taler-directory-<validator>]” section.
+The following options are from a “[directory-<validator>]” section.
ENABLED
Is this validator enabled or disabled.
@@ -152,7 +152,7 @@ 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.
+The following options are from a “[directory-<disseminator>]” section.
ENABLED
Is this disseminator enabled or disabled.
diff --git a/manpages/taler-mailbox-config.1.rst b/manpages/taler-mailbox-config.1.rst
@@ -0,0 +1,64 @@
+taler-mailbox-config(1)
+#######################
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-mailbox-config** - manipulate taler-mailbox configuration file
+
+Synopsis
+========
+
+**taler-mailbox-config**
+[**-c** *filename* | **--config=**\ \ *filename*]
+[**-h** | **--help**]
+[**-o** *option* | **--option=**\ \ *option*]
+[**-O** | **--only-value**]
+[**-S** | **--list-sections**]
+[**-s** *section* | **--section=**\ \ *section*]
+[**-v** | **--version**]
+
+
+Description
+===========
+
+**taler-mailbox-config** can be used to read or modify taler-mailbox configuration files.
+
+**-c** *FILENAME* \| **--config=**\ \ *FILENAME*
+ Use the configuration file *FILENAME*.
+
+**-h** \| **--help**
+ Print short help on options.
+
+**-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-mailbox-dbinit(1), taler-mailbox-httpd(1), taler-mailbox.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-mailbox-dbinit.1.rst b/manpages/taler-mailbox-dbinit.1.rst
@@ -0,0 +1,49 @@
+taler-mailbox-dbinit(1)
+#######################
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-mailbox-dbinit** - initialize the taler-mailbox database
+
+
+Synopsis
+========
+
+**taler-mailbox-dbinit**
+[**-c** *FILENAME* | **--config=**\ \ *FILENAME*]
+[**-h** | **--help**]
+**-v** | **--version**]
+
+
+Description
+===========
+
+**taler-mailbox-dbinit** is a command-line tool to initialize the taler-mailbox database.
+
+Its options are as follows:
+
+**-c** *FILENAME* \| **--config=**\ \ *FILENAME*
+ Use the configuration and other resources for the taler-mailbox commands
+ to operate from *FILENAME*.
+
+**-h** \| **--help**
+ Print short help on options.
+
+**-v** \| **–version**
+ Print version information.
+
+
+See Also
+========
+
+taler-mailbox-config(1), taler-mailbox-httpd(1), taler-mailbox.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-mailbox-httpd.1.rst b/manpages/taler-mailbox-httpd.1.rst
@@ -0,0 +1,53 @@
+taler-mailbox-httpd(1)
+######################
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-mailbox-httpd** - provide the taler-mailbox HTTP interface
+
+
+Synopsis
+========
+
+**taler-mailbox-httpd**
+[**-c** *FILENAME* | **--config=**\ \ *FILENAME*]
+[**-h** | **--help**]
+[**-L** *LOGLEVEL* | **--log=**\ \ *LOGLEVEL*]
+[**-v** | **--version**]
+
+
+Description
+===========
+
+**taler-mailbox-httpd** is a command-line tool to provide the taler-mailbox HTTP interface.
+
+Its options are as follows:
+
+**-c** *FILENAME* \| **--config=**\ \ *FILENAME*
+ Use the configuration and other resources for the taler-mailbox 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-mailbox-config(1), taler-mailbox-dbinit(1), taler-mailbox.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-mailbox.conf.5.rst b/manpages/taler-mailbox.conf.5.rst
@@ -0,0 +1,78 @@
+mailbox.conf(5)
+###############
+
+.. only:: html
+
+ Name
+ ====
+
+ **mailbox.conf** - taler-mailbox 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-mailbox/config.d/``.
+The configuration file given with **-c** to taler-mailbox 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-mailbox-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 “[mailbox]” section.
+
+BASE_URL
+ The base URL of the service. If your service is proxied, the external base URL this service is availiable at.
+ Default: ``https://example.com``
+
+MAX_BODY_BYTES
+ Number of bytes of the challenge.
+ Default: ``256``
+
+MESSAGE_RESPONSE_LIMIT
+ Maximum number of messages returned in a single response.
+ Default: ``50``
+
+MONTHLY_FEE
+ Monthly fee of this service.
+ Default: ``KUDOS:0``
+
+REGISTRATION_UPDATE_FEE
+ Registration modification fee.
+ Default: ``KUDOS:0``
+
+MESSAGE_FEE
+ Cost for sending a message to a mailbox.
+ Default: ``KUDOS:0``
+
+FREE_MESSAGE_QUOTA
+ Number of messages that can be sent for free
+ Default: ``0``
+
+PENDING_REGISTRATION_EXPIRATION
+ Lifetime of a pending (unpaid) registration until it is purged from the database.
+ Default: ``24h``
+
+SEE ALSO
+========
+
+taler-mailbox-dbinit(1), taler-mailbox-httpd(1), taler-mailbox-config(1).
+
+
+BUGS
+====
+
+Report bugs by using https://bugs.taler.net/ or by sending electronic
+mail to <taler@gnu.org>.
