summaryrefslogtreecommitdiff
path: root/manpages/libeufin-nexus.conf.5.rst
blob: d660994355d6e271ce6681c1d75835dc2394a957 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
taler.conf(5)
#############

.. only:: html

   Name
   ====

   **taler.conf** - Taler 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!


GLOBAL OPTIONS
--------------

The following options are from the “[nexus-ebics]” section and used by
the ``libeufin-nexus ebics-setup`` command.


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

HOST_BASE_URL = http://bank.example.com/
  URL of the EBICS server

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' value is supported.

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.


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.

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.


The “[PATHS]” section is special in that it contains paths that can be
referenced using “$” in other configuration values that specify
filenames. For Taler, it commonly contains the following paths:

LIBEUFIN_HOME
  Home directory of the user, usually “${HOME}”. Can be overwritten by
  testcases by setting ${LIBEUFIN_TEST_HOME}.


SEE ALSO
========

libeufin-nexus(1)

BUGS
====

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