libeufin-nexus.conf(5)
######################

.. only:: html

   Name
   ====

   **libeufin-nexus.conf** - LibEuFin Nexus configuration file


Description
===========

.. include:: ../frags/common-conf-syntax.rst

Files containing default values for many of the options described below
are installed under ``$TALER_PREFIX/share/libeufin-nexus/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``.

Be extra careful when using ``taler-config -V VALUE`` to change configuration
values: it will destroy all uses of ``@INLINE@`` and furthermore remove all
comments from the configuration file!

EBICS OPTIONS
--------------

The following options are from the “[nexus-ebics]” section.

CURRENCY
  Name of the currency, e.g. “EUR” for Euro.

HOST_BASE_URL
  URL of the EBICS server

HOST_ID
  EBICS specific: name of the EBICS host

USER_ID
  EBICS specific: user ID of the EBICS subscriber.  This value must be assigned
  by the bank after having activated a new EBICS subscriber.

PARTNER_ID
  EBICS specific: partner ID of the EBICS subscriber.  This value must be assigned
  by the bank after having activated a new EBICS subscriber.

IBAN
  IBAN of the bank account that is associated with the EBICS subscriber.

BIC
  BIC of the bank account that is associated with the EBICS subscriber.

NAME
  Legal entity that is associated with the EBICS subscriber.

BANK_PUBLIC_KEYS_FILE
  Filesystem location where Nexus should store the bank public keys.
  
CLIENT_PRIVATE_KEYS_FILE
  Filesystem location where Nexus should store the subscriber private keys.

BANK_DIALECT
  Name of the following combination: EBICS version and ISO20022 recommendations
  that Nexus would honor in the communication with the bank. Currently only the
  ``postfinance`` or ``gls`` value is supported.

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.

EBICS SUBMIT OPTIONS
--------------------

The following configuration value(s) belong to the “[nexus-submit]” section.

FREQUENCY
  Duration value to instruct the ``ebics-submit`` subcommand how much to wait
  before checking the database again to find new unsubmitted payments.

EBICS FETCH OPTIONS
-------------------

The following configuration value(s) belong to the “[nexus-fetch]” section.

FREQUENCY
  Duration value to instruct the ``ebics-fetch`` subcommand how often it should
  download from the bank.

IGNORE_TRANSACTIONS_BEFORE
  Ignore all transactions before a certain YYYY-MM-DD date, useful when you want to use an existing account with old transactions that should not be bounced.

HTTP SERVER OPTIONS
-------------------

The following configuration value(s) belong to the “[nexus-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 “[nexus-httpd-wire-gateway-api]” section.

ENABLED
  Whether to serve the Wire Gateway API.

AUTH_METHOD
  How to authenticate this API. This can either be ``none`` or ``bearer-token``.

AUTH_BEARER_TOKEN
  The expected token.
  Only used if ``AUTH_METHOD`` is ``bearer-token``.

HTTP REVENUE API OPTIONS
------------------------

The following configuration value(s) belong to the “[nexus-httpd-revenue-api]” section.

ENABLED
  Whether to serve the Revenue API.

AUTH_METHOD
  How to authenticate this API. This can either be ``none`` or ``bearer-token``.

AUTH_BEARER_TOKEN
  The expected token.
  Only used if ``AUTH_METHOD`` is ``bearer-token``.

DATABASE OPTIONS
----------------

Setting the database belongs to the “[libeufin-nexusdb-postgres]” section and the following value.

CONFIG
  PostgreSQL connection string.

SQL_DIR
  Where are the SQL files to setup our tables?

SEE ALSO
========

libeufin-nexus(1)

BUGS
====

Report bugs by using https://bugs.taler.net/ or by sending electronic
mail to <taler@gnu.org>.