diff options
Diffstat (limited to 'manpages/libeufin-bank.conf.5.rst')
| -rw-r--r-- | manpages/libeufin-bank.conf.5.rst | 146 |
1 files changed, 146 insertions, 0 deletions
diff --git a/manpages/libeufin-bank.conf.5.rst b/manpages/libeufin-bank.conf.5.rst new file mode 100644 index 00000000..ce00f0fa --- /dev/null +++ b/manpages/libeufin-bank.conf.5.rst @@ -0,0 +1,146 @@ +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. + +WIRE_TYPE + Supported payment target type, this can either be ``iban`` or ``x-taler-bank`` + +IBAN_PAYTO_BIC + Bank BIC used in generated iban payto URI. Required if ``WIRE_TYPE``is ``iban`` + +X_TALER_BANK_PAYTO_HOSTNAME + Bank hostname used in generated x-taler-bank payto URI. Required if ``WIRE_TYPE``is ``x-taler-bank`` + +NAME + Bank display name, used in webui and TAN messages. Default to ``Taler Bank`` if not specified. + +BASE_URL + The advertised base URL + +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_EDIT_NAME + Whether anyone can edit their legal name or whether this action is reserved for the admin. Defaults to ``NO`` if not specified. + +ALLOW_EDIT_CASHOUT_PAYTO_URI + Whether anyone can edit their cashout 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``. + +TAN_SMS_ENV + Environment variables for the sms TAN script. + Only used if ``TAN_SMS`` is set. + +TAN_EMAIL_ENV + Environment variables for the email TAN script. + Only used if ``TAN_EMAIL`` is set. + +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``. + +SUGGESTED_WITHDRAWAL_EXCHANGE + Exchange that is suggested to wallets when withdrawing + +GC_ABORT_AFTER + Time after which pending operations are aborted during garbage collection + +GC_CLEAN_AFTER + Time after which aborted operations and expired items are deleted during garbage collection + +GC_DELETE_AFTER + Time after which all bank transactions, operations and deleted accounts are deleted during garbage collection + +DATABASE OPTIONS +---------------- + +Setting the database belongs to the “[libeufin-bankdb-postgres]” section and the +following value. + +CONFIG + PostgreSQL connection string. + +SQL_DIR + Where are the SQL files to setup our tables? + +SEE ALSO +======== + +libeufin-bank(1). + +BUGS +==== + +Report bugs by using https://bugs.taler.net/ or by sending electronic +mail to <taler@gnu.org>. |