summaryrefslogtreecommitdiff
path: root/manpages/libeufin-bank.conf.5.rst
blob: 0b27319f0198ff40ec6ecb7ea8e517e199abf920 (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
96
97
98
libeufin-bank.conf(5)
######################

.. only:: html

   Name
   ====

   **libeufin-bank.conf** - LibEuFin Bank 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-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``.

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 “[libeufin-bank]” section.

CURRENCY
  Internal currency of the libeufin-bank, e.g. “EUR” for Euro.

DEFAULT_DEBT_LIMIT
  Default debt limit for newly created accounts. Defaults to CURRENCY:0 if not specified.

REGISTRATION_BONUS
  Value of the registration bonus for new users. Defaults to CURRENCY:0 if not specified.

ALLOW_REGISTRATION
  Whether anyone can create a new account or whether this action is reserved for the admin. Defaults to no if not specified.

ALLOW_ACCOUNT_DELETION
  Whether anyone can delete its account or whether this action is reserved for the admin. Defaults to no if not specified.

ALLOW_CONVERSION
  Whether regional currency conversion is enabled. Defaults to no if not specified.

FIAT_CURRENCY
  External currency used during cashin and cashout.
  Only used if ``ALLOW_CONVERSION`` is ``YES``.

TAN_SMS
  Path to TAN challenge transmission script via sms. If not specified, this TAN channel will not be supported.
  Only used if ``ALLOW_CONVERSION`` is ``YES``.

TAN_EMAIL
  Path to TAN challenge transmission script via email. If not specified, this TAN channel will not be supported.
  Only used if ``ALLOW_CONVERSION`` is ``YES``.

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

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

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

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

CONFIG
  PostgreSQL connection string.

SEE ALSO
========

libeufin-bank(1).

BUGS
====

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