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>.