commit 02200c9cd2f9ecab46f0604f4f33d77c78095c92
parent c24ed7e505cf6d1bc8aecc20991b635229b7b5c1
Author: Antoine A <>
Date: Thu, 30 Jan 2025 10:46:39 +0100
magnet-bank: init manpages
Diffstat:
2 files changed, 263 insertions(+), 0 deletions(-)
diff --git a/manpages/taler-magnet-bank.1.rst b/manpages/taler-magnet-bank.1.rst
@@ -0,0 +1,128 @@
+taler-magnet-bank(1)
+####################
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-magnet-bank** - Magnet Bank Taler adapter.
+
+
+Synopsis
+========
+
+**taler-magnet-bank**
+[**-h** | **--help**]
+[**--version**]
+COMMAND [ARGS...]
+
+Subcommands: **dbinit**, **setup**,
+**serve**, **worker**, **config**
+
+
+Description
+===========
+
+**taler-magnet-bank** is a Taler adapter for the Magnet Bank API.
+
+Its options are as follows:
+
+**-h** \| **--help**
+ Print short help on options.
+
+**--version**
+ Print version information.
+
+The interaction model is as follows:
+
+- Configure the database with commands ``dbinit``.
+
+- Setup API access with commands ``setup``. Setting the access means to generate an access token, to perform SCA check and upload some keys.
+
+- After a successful setup, the subcommands ``worker`` can be run to both send payments and sync the bank account history.
+
+- Start the HTTP server with command ``serve``.
+ Let this run in a shell, writing logs to stderr.
+
+The following sections describe each command in detail.
+
+dbinit
+------
+
+This command defines the database schema for taler-magnet-bank. It is mandatory to run this command before invoking the ``setup`` or ``serve`` commands.
+
+Its options are as follows:
+
+**-c** \| **--config** *config_file*
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+**-r** \| **--reset**
+ Reset database (DANGEROUS: All existing data is lost)
+**-h** \| **--help**
+ Print short help on options.
+
+setup
+-----
+
+This command setup a working API connection. This command create the keys file, if they aren't found already on the disk. It generate an access token, performs the SCA check and upload the public key.
+
+It is mandatory to run this command before invoking the ``worker`` command.
+
+Its options are as follows:
+
+**-c** \| **--config** *config_file*
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+**-r** \| **--reset**
+ Reset connection info and overwrite keys file
+**-h** \| **--help**
+ Print short help on options.
+
+worker
+------
+
+This subcommand initiate transaction throught the Magnet Bank API and sync the the bank account history.
+
+If ACCOUNT_TYPE is ``exchange``, incoming payments with an invalid Taler subject are bounced.
+
+Its options are as follows:
+
+**-c** \| **--config** *config_file*
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+**--transient**
+ Execute once and return.
+**-h** \| **--help**
+ Print short help on options.
+
+serve
+-----
+
+This command starts the HTTP server.
+
+Its options are as follows:
+
+**-c** \| **--config** *config_file*
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+**--check**
+ Check whether an API is in use (if it's useful to start the HTTP server). Exit with 0 if at least one API is enabled, otherwise 1.
+**-h** \| **--help**
+ Print short help on options.
+
+.. include:: ../frags/libeufin-config-cli.rst
+
+SEE ALSO
+========
+
+taler-magnet-bank.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-magnet-bank.conf.5.rst b/manpages/taler-magnet-bank.conf.5.rst
@@ -0,0 +1,134 @@
+taler-magnet-bank.conf(5)
+#########################
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-magnet-bank.conf** - Magnet Bank Taler adapter configuration file
+
+
+Description
+===========
+
+.. include:: ../frags/common-conf-syntax.rst
+
+Files containing default values for many of the options described below
+are installed under ``$TALER_MAGNET_BANK_PREFIX/share/taler-magnet-bank/config.d/``.
+The configuration file given with **-c** to Taler 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``.
+
+
+ADAPTER OPTIONS
+---------------
+
+The following options are from the “[magnet-bank]” section.
+
+API_URL
+ URL of the Magnet Bank API server.
+
+CONSUMER_KEY
+ Your Magnet Bank API unique identifier.
+
+CONSUMER_SECRET
+ Your Magnet Bank API confidential key.
+
+IBAN
+ IBAN of the bank account that is associated with the EBICS subscriber.
+
+NAME
+ Legal entity that is associated with the EBICS subscriber.
+
+KEYS_FILE
+ Filesystem location where taler-magnet-bank should store the crypto keys.
+
+ACCOUNT_TYPE
+ Specify the account type and therefore the indexing behavior. This can either can be ``normal`` or ``exchange``. Exchange accounts bounce invalid incoming Taler transactions.
+
+HTTP SERVER OPTIONS
+-------------------
+
+The following configuration value(s) belong to the “[magnet-bank-httpd]” section.
+
+SERVE
+ This can either be ``tcp`` or ``unix``.
+
+PORT
+ Port on which the HTTP server listens, e.g. 9967.
+ Only used if ``SERVE`` is ``tcp``.
+
+BIND_TO
+ Which IP address should we bind to? E.g. ``127.0.0.1`` or ``::1``for loopback. Can also be given as a hostname.
+ Only used if ``SERVE`` is ``tcp``.
+
+UNIXPATH
+ Which unix domain path should we bind to?
+ Only used if ``SERVE`` is ``unix``.
+
+UNIXPATH_MODE
+ What should be the file access permissions for ``UNIXPATH``?
+ Only used if ``SERVE`` is ``unix``.
+
+HTTP WIRE GATEWAY API OPTIONS
+-----------------------------
+
+The following configuration value(s) belong to the “[magnet-bank-httpd-wire-gateway-api]” section.
+
+ENABLED
+ Whether to serve the Wire Gateway API.
+
+AUTH_METHOD
+ Authentication scheme, this can either be ``basic``, ``bearer`` or ``none``.
+
+USERNAME
+ User name for ``basic`` authentication scheme.
+
+PASSWORD
+ Password for ``basic`` authentication scheme.
+
+TOKEN
+ Token for ``bearer`` authentication scheme.
+
+HTTP REVENUE API OPTIONS
+------------------------
+
+The following configuration value(s) belong to the “[magnet-bank-httpd-revenue-api]” section.
+
+ENABLED
+ Whether to serve the Revenue API.
+
+AUTH_METHOD
+ Authentication scheme, this can either be ``basic``, ``bearer`` or ``none``.
+
+USERNAME
+ User name for ``basic`` authentication scheme.
+
+PASSWORD
+ Password for ``basic`` authentication scheme.
+
+TOKEN
+ Token for ``bearer`` authentication scheme.
+
+DATABASE OPTIONS
+----------------
+
+Setting the database belongs to the “[magnet-bankddb-postgres]” section and the following value.
+
+CONFIG
+ PostgreSQL connection string.
+
+SEE ALSO
+========
+
+taler-magnet-bank(1)
+
+BUGS
+====
+
+Report bugs by using https://bugs.taler.net/ or by sending electronic
+mail to <taler@gnu.org>.
+\ No newline at end of file
