From 51fc9f0d4a9cf32e7304e8e0edb08c612482f7c9 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Wed, 12 Apr 2023 16:09:37 +0200 Subject: document #6363 --- manpages/taler-merchant-webhook.1.rst | 62 ++++++++++++++++++++++++++++++ manpages/taler-merchant-wirewatch.1.rst | 68 +++++++++++++++++++++++++++++++++ manpages/taler.conf.5.rst | 22 +++++++++++ 3 files changed, 152 insertions(+) create mode 100644 manpages/taler-merchant-webhook.1.rst create mode 100644 manpages/taler-merchant-wirewatch.1.rst (limited to 'manpages') diff --git a/manpages/taler-merchant-webhook.1.rst b/manpages/taler-merchant-webhook.1.rst new file mode 100644 index 00000000..2d9b61cf --- /dev/null +++ b/manpages/taler-merchant-webhook.1.rst @@ -0,0 +1,62 @@ +taler-merchant-webhook(1) +######################## + +.. only:: html + + Name + ==== + + **taler-merchant-webhook** - run webhooks of Taler merchant backend + + +Synopsis +======== + +**taler-merchant-webhook** +[**-c** *FILENAME* | **--config=**\ ‌\ *FILENAME*] +[**-h** | **--help**] +[**-L** *LOGLEVEL* | **--loglevel=**\ ‌\ *LOGLEVEL*] +[**-l** *FILENAME* | **--logfile=**\ ‌\ *FILENAME*] +[**-t** | **--test**] +[**-v** | **--version**] + +Description +=========== + +**taler-merchant-webhook** is a command-line tool to trigger webhooks +scheduled by a Taler merchant backend. It makes the necessary HTTP +requests and updates the Taler merchant database accordingly. + +Its options are as follows: + +**-c** *FILENAME* \| **--config=**\ ‌\ *FILENAME* + Use the configuration and other resources for the merchant to operate + from *FILENAME*. + +**-h** \| **--help** + Print short help on options. + +**-L** *LOGLEVEL* \| **--loglevel=**\ ‌\ *LOGLEVEL* + Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``, + ``WARNING``, ``ERROR``. + +**-l** *FILENAME* \| **--logfile=**\ ‌\ *FILENAME* + Send logging output to *FILENAME*. + +**-t** \| **--test** + Run in test mode. Only runs until there are no more webhooks + to be executed. + +**-v** \| **–version** + Print version information. + +See Also +======== + +taler-merchant-httpd(1), taler.conf(5). + +Bugs +==== + +Report bugs by using https://bugs.taler.net or by sending electronic +mail to . diff --git a/manpages/taler-merchant-wirewatch.1.rst b/manpages/taler-merchant-wirewatch.1.rst new file mode 100644 index 00000000..54daa767 --- /dev/null +++ b/manpages/taler-merchant-wirewatch.1.rst @@ -0,0 +1,68 @@ +taler-merchant-wirewatch(1) +########################### + +.. only:: html + + Name + ==== + + **taler-merchant-wirewatch** - import bank transfers into Taler merchant backend + + +Synopsis +======== + +**taler-merchant-wirewatch** +[**-c** *FILENAME* | **--config=**\ ‌\ *FILENAME*] +[**-h** | **--help**] +[**-L** *LOGLEVEL* | **--loglevel=**\ ‌\ *LOGLEVEL*] +[**-l** *FILENAME* | **--logfile=**\ ‌\ *FILENAME*] +[**-t** | **--test**] +[**-v** | **--version**] + +Description +=========== + +**taler-merchant-wirewatch** is a command-line tool to import +information about incoming bank transfers into a Taler merchant +backend. This will allow the merchant backend to validate that +the exchange paid the merchant correctly. + +Its options are as follows: + +**-c** *FILENAME* \| **--config=**\ ‌\ *FILENAME* + Use the configuration and other resources for the merchant to operate + from *FILENAME*. + +**-h** \| **--help** + Print short help on options. + +**-L** *LOGLEVEL* \| **--loglevel=**\ ‌\ *LOGLEVEL* + Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``, + ``WARNING``, ``ERROR``. + +**-l** *FILENAME* \| **--logfile=**\ ‌\ *FILENAME* + Send logging output to *FILENAME*. + +**-s** *SECTION* \| **--section=**\ \ *SECTION* + Configuration section to use. Default is taler-merchant-wirewatch. Needed + if different processes are used to watch multiple bank accounts (for the + same instance or different instances). + +**-t** \| **--test** + Run in test mode. Only runs until the current list of bank + transactions are all imported. + +**-v** \| **–version** + Print version information. + +See Also +======== + +taler-merchant-httpd(1), taler.conf(5). + +Bugs +==== + +Report bugs by using https://bugs.taler.net or by sending electronic +mail to . diff --git a/manpages/taler.conf.5.rst b/manpages/taler.conf.5.rst index 3d83b8d4..f1a51011 100644 --- a/manpages/taler.conf.5.rst +++ b/manpages/taler.conf.5.rst @@ -579,6 +579,28 @@ CURRENCY we use, which must be given in the ``[taler]`` section. +MERCHANT WIREWATCH OPTIONS +-------------------------- + +The name of the configuration section used by taler-merchant-wirewatch +can be changed via the command-line. By default, it is simply +"[taler-merchant-wirewatch]". The options are: + +INSTANCE + Which instance of the backend should transactions be imported for by this wirewatcher. +WIRE_GATEWAY_URL + Under which URL is the wire gateway (libeufin facade) reachable that makes bank transfer data availalbe to us. +WIRE_GATEWAY_AUTH_METHOD + Which authentication method should be used (currently only "NONE" or "BASIC" are supported). +USERNAME + Username to give to the wire gateway when using "BASIC" authentication. +PASSWORD + Password to give to the wire gateway when using "BASIC" authentication. + +Note that the libeufin facade type to configure for a taler-merchant-wirewatch +operation is the "Anastasis" facade. + + AUDITOR OPTIONS --------------- -- cgit v1.2.3