libeufin-bank.conf.5.rst (5022B)
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. Required if ``WIRE_TYPE``is ``iban`` 40 41 X_TALER_BANK_PAYTO_HOSTNAME 42 Bank hostname used in generated x-taler-bank payto URI. Required if ``WIRE_TYPE``is ``x-taler-bank`` 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 Only used if ``ALLOW_CONVERSION`` is ``YES``. 87 88 TAN_EMAIL 89 Path to TAN challenge transmission script via email. If not specified, this TAN channel will not be supported. 90 Only used if ``ALLOW_CONVERSION`` is ``YES``. 91 92 TAN_SMS_ENV 93 Environment variables for the sms TAN script as a single-line JSON object 94 Only used if ``TAN_SMS`` is set. 95 96 TAN_EMAIL_ENV 97 Environment variables for the email TAN script as a single-line JSON object 98 Only used if ``TAN_EMAIL`` is set. 99 100 SERVE 101 This can either be ``tcp`` or ``unix``. 102 103 PORT 104 Port on which the HTTP server listens, e.g. 9967. 105 Only used if ``SERVE`` is ``tcp``. 106 107 BIND_TO 108 Which IP address should we bind to? E.g. ``127.0.0.1`` or ``::1``for loopback. Can also be given as a hostname. 109 Only used if ``SERVE`` is ``tcp``. 110 111 UNIXPATH 112 Which unix domain path should we bind to? 113 Only used if ``SERVE`` is ``unix``. 114 115 SUGGESTED_WITHDRAWAL_EXCHANGE 116 Exchange that is suggested to wallets when withdrawing 117 118 PWD_HASH_ALGORITHM 119 Password hash algorithm, this can only be ``bcrypt`` 120 121 PWD_HASH_CONFIG 122 Password hash algorithm configuration as a single-line JSON object 123 When ``PWD_HASH_ALGORITHM`` is ``bcrypt`` you can configure ``cost`` 124 125 PWD_CHECK 126 Whether to check password quality 127 Unstable flag, will become a non configurable default in a future version 128 129 PWD_AUTH_COMPAT 130 Whether to allow password auth everywhere 131 Unstable flag, will become a non configurable default in a future version 132 133 GC_ABORT_AFTER 134 Time after which pending operations are aborted during garbage collection 135 136 GC_CLEAN_AFTER 137 Time after which aborted operations and expired items are deleted during garbage collection 138 139 GC_DELETE_AFTER 140 Time after which all bank transactions, operations and deleted accounts are deleted during garbage collection 141 142 DATABASE OPTIONS 143 ---------------- 144 145 Setting the database belongs to the “[libeufin-bankdb-postgres]” section and the 146 following value. 147 148 .. include:: frags/common-db-options.rs 149 150 SEE ALSO 151 ======== 152 153 libeufin-bank(1). 154 155 BUGS 156 ==== 157 158 Report bugs by using https://bugs.taler.net/ or by sending electronic 159 mail to <taler@gnu.org>.