taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

libeufin-bank.conf.5.rst (4902B)


      1 libeufin-bank.conf(5)
      2 ######################
      3 
      4 .. only:: html
      5 
      6    Name
      7    ====
      8 
      9    **libeufin-bank.conf** - LibEuFin Bank configuration file
     10 
     11 
     12 Description
     13 ===========
     14 
     15 .. include:: ../frags/common-conf-syntax.rst
     16 
     17 Files containing default values for many of the options described below
     18 are installed under ``$LIBEUFIN_BANK_PREFIX/share/libeufin-bank/config.d/``.
     19 The configuration file given with **-c** to Taler binaries
     20 overrides these defaults.
     21 
     22 A configuration file may include another, by using the ``@INLINE@`` directive,
     23 for example, in ``main.conf``, you could write ``@INLINE@ sub.conf`` to
     24 include the entirety of ``sub.conf`` at that point in ``main.conf``.
     25 
     26 
     27 GLOBAL OPTIONS
     28 --------------
     29 
     30 The following options are from the “[libeufin-bank]” section.
     31 
     32 CURRENCY
     33   Internal currency of the libeufin-bank, e.g. “EUR” for Euro.
     34 
     35 WIRE_TYPE
     36   Supported payment target type, this can either be ``iban`` or ``x-taler-bank``
     37 
     38 IBAN_PAYTO_BIC
     39   Bank BIC used in generated iban payto URI.
     40 
     41 X_TALER_BANK_PAYTO_HOSTNAME
     42   Deprecated. The hostname from ``BASE_URL`` is used instead.
     43 
     44 NAME
     45   Bank display name, used in webui and TAN messages. Defaults to ``Taler Bank`` if not specified.
     46 
     47 BASE_URL
     48   The advertised base URL
     49 
     50 WIRE_TRANSFER_FEES
     51   Wire transfer execution fees. Only applies to bank transactions and withdrawals. Defaults to ``CURRENCY:0`` if not specified.
     52 
     53 MIN_WIRE_TRANSFER_AMOUNT
     54   Minimum wire transfer amount allowed. Only applies to bank transactions and withdrawals. Defaults to no limit.
     55 
     56 MAX_WIRE_TRANSFER_AMOUNT
     57   Maximum wire transfer amount allowed. Only applies to bank transactions and withdrawals. Defaults to no limit.
     58 
     59 DEFAULT_DEBT_LIMIT
     60   Default debt limit for newly created accounts. Defaults to ``CURRENCY:0`` if not specified.
     61 
     62 REGISTRATION_BONUS
     63   Value of the registration bonus for new users. Defaults to ``CURRENCY:0`` if not specified.
     64 
     65 ALLOW_REGISTRATION
     66   Whether anyone can create a new account or whether this action is reserved for the admin. Defaults to ``NO`` if not specified.
     67 
     68 ALLOW_ACCOUNT_DELETION
     69   Whether anyone can delete its account or whether this action is reserved for the admin. Defaults to ``NO`` if not specified.
     70 
     71 ALLOW_EDIT_NAME
     72   Whether anyone can edit their legal name or whether this action is reserved for the admin. Defaults to ``NO`` if not specified.
     73 
     74 ALLOW_EDIT_CASHOUT_PAYTO_URI
     75   Whether anyone can edit their cashout account or whether this action is reserved for the admin. Defaults to ``NO`` if not specified.
     76 
     77 ALLOW_CONVERSION
     78   Whether regional currency conversion is enabled. Defaults to ``NO`` if not specified.
     79 
     80 FIAT_CURRENCY
     81   External currency used during cashin and cashout.
     82   Only used if ``ALLOW_CONVERSION`` is ``YES``.
     83 
     84 TAN_SMS
     85   Path to TAN challenge transmission script via sms. If not specified, this TAN channel will not be supported.
     86 
     87 TAN_EMAIL
     88   Path to TAN challenge transmission script via email. If not specified, this TAN channel will not be supported.
     89 
     90 TAN_SMS_ENV
     91   Environment variables for the sms TAN script as a single-line JSON object
     92   Only used if ``TAN_SMS`` is set.
     93 
     94 TAN_EMAIL_ENV
     95   Environment variables for the email TAN script as a single-line JSON object
     96   Only used if ``TAN_EMAIL`` is set.
     97 
     98 SERVE
     99   This can either be ``tcp`` or ``unix``.
    100 
    101 PORT
    102   Port on which the HTTP server listens, e.g. 9967.
    103   Only used if ``SERVE`` is ``tcp``.
    104 
    105 BIND_TO
    106   Which IP address should we bind to?  E.g. ``127.0.0.1`` or ``::1``for loopback.  Can also be given as a hostname.
    107   Only used if ``SERVE`` is ``tcp``.
    108 
    109 UNIXPATH
    110   Which unix domain path should we bind to?
    111   Only used if ``SERVE`` is ``unix``.
    112 
    113 SPA
    114   Path to the separately installed WebUI files.
    115 
    116 SUGGESTED_WITHDRAWAL_EXCHANGE
    117   Exchange that is suggested to wallets when withdrawing
    118 
    119 PWD_HASH_ALGORITHM
    120   Password hash algorithm, this can only be ``bcrypt``
    121 
    122 PWD_HASH_CONFIG
    123   Password hash algorithm configuration as a single-line JSON object
    124   When ``PWD_HASH_ALGORITHM`` is ``bcrypt`` you can configure ``cost``
    125 
    126 PWD_CHECK
    127   Whether to check password quality
    128   Unstable flag, will become a non configurable default in a future version
    129 
    130 PWD_AUTH_COMPAT
    131   Whether to allow password auth everywhere
    132   Unstable flag, will become a non configurable default in a future version
    133 
    134 GC_ABORT_AFTER
    135   Time after which pending operations are aborted during garbage collection
    136 
    137 GC_CLEAN_AFTER
    138   Time after which aborted operations and expired items are deleted during garbage collection
    139 
    140 GC_DELETE_AFTER
    141   Time after which all bank transactions, operations and deleted accounts are deleted during garbage collection
    142 
    143 DATABASE OPTIONS
    144 ----------------
    145 
    146 Setting the database belongs to the “[libeufin-bankdb-postgres]” section and the
    147 following value.
    148 
    149 .. include:: frags/common-db-options.rst
    150 
    151 SEE ALSO
    152 ========
    153 
    154 libeufin-bank(1).
    155 
    156 BUGS
    157 ====
    158 
    159 Report bugs by using https://bugs.taler.net/ or by sending electronic
    160 mail to <taler@gnu.org>.