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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
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
--------------
Setting the database belongs to the “[nexus-postgres]” section and the
following value.
CONFIG
PostgreSQL connection string. Note: this option is NOT used by the
ebics-setup subcommand, as it stores the key files directly on the
filesystem.
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}.
EBICS SETUP 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.
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. The duration
must be expressed with a number followed by the time unit. The following time
units are supported: 's' (seconds), 'm' (minutes), 'h' (hours).
For example, the value *5m* causes retries to be run every five minutes. Whenever
the given number is zero, the retries are long-polled. Note: the current version
does NOT support long-polling but would instead run in transient mode, whenever
the duration number is zero. Finally, even with a duration number of zero, the
duration unit must be specified.
SUBMISSIONS_LOG_DIRECTORY
Optional value to define the path where the pain.001 documents would be stored
after a submission. This directory would contain several directories, each named
after the YYYY-MM-DD format. The pain.001 file would then be named in the following
schema: ``$submissionTimestampMicroseconds_requestUid_$requestUid_pain.001.xml``.
``$requestUid`` is the same value that constitutes the pain.001 ``MsgIg`` element.
In the event that one log file would be overridden, ``ebics-submit`` fails without
overriding it.
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. The duration must be expressed with a number followed
by the time unit. The following time units are supported: 's' (seconds), 'm'
(minutes), 'h' (hours). For example, the value *5m* causes downloads to be run
every five minutes. Whenever the given number is zero, the retries are long-polled.
Note: the current version does NOT support long-polling but would instead run in
transient mode. Note: long polling depends also by the bank offering it.
STATEMENT_LOG_DIRECTORY
Optional value to define the path where the downloaded documents would be stored
This directory would contain several directories, each named after the YYYY-MM-DD
format. The stored files would then be named in the following schema:
``$downloadTimestampMicroseconds_$filenameAsGivenByTheBank``. In the event that
one log file would be overridden, ``ebics-fetch`` fails without overriding it.
SEE ALSO
========
libeufin-nexus(1)
BUGS
====
Report bugs by using https://bugs.taler.net/ or by sending electronic
mail to <taler@gnu.org>.
|
