libeufin-nexus.conf.5.rst (5450B)
1 libeufin-nexus.conf(5) 2 ###################### 3 4 .. only:: html 5 6 Name 7 ==== 8 9 **libeufin-nexus.conf** - LibEuFin Nexus 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_NEXUS_PREFIX/share/libeufin-nexus/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 EBICS OPTIONS 28 -------------- 29 30 The following options are from the “[nexus-ebics]” section. 31 32 CURRENCY 33 Name of the currency, e.g. “EUR” for Euro. 34 35 HOST_BASE_URL 36 URL of the EBICS server 37 38 HOST_ID 39 EBICS specific: name of the EBICS host 40 41 USER_ID 42 EBICS specific: user ID of the EBICS subscriber. This value must be assigned 43 by the bank after having activated a new EBICS subscriber. 44 45 PARTNER_ID 46 EBICS specific: partner ID of the EBICS subscriber. This value must be assigned 47 by the bank after having activated a new EBICS subscriber. 48 49 IBAN 50 IBAN of the bank account that is associated with the EBICS subscriber. 51 52 BIC 53 BIC of the bank account that is associated with the EBICS subscriber. 54 55 QR_IBAN 56 QR IBAN of a QR virtual bank account linked to the configured bank account that can be used for QR BILL 57 58 NAME 59 Legal entity that is associated with the EBICS subscriber. 60 61 BANK_PUBLIC_KEYS_FILE 62 Filesystem location where Nexus should store the bank public keys. 63 64 CLIENT_PRIVATE_KEYS_FILE 65 Filesystem location where Nexus should store the subscriber private keys. 66 67 BANK_DIALECT 68 Name of the following combination: EBICS version and ISO20022 recommendations 69 that Nexus would honor in the communication with the bank. Currently only the 70 ``postfinance``, ``gls``, ``raiffeisen``, ``maerki_baumann`` or ``valiant`` dialects is supported. 71 72 ACCOUNT_TYPE 73 Specify the account type and therefore the indexing behavior. This can either can be ``normal`` or ``exchange``. Exchange accounts bounce invalid incoming Taler transactions. 74 75 EBICS SETUP OPTIONS 76 ------------------- 77 78 The following configuration value(s) belong to the “[nexus-setup]” section. 79 80 BANK_ENCRYPTION_PUB_KEY_HASH 81 Bank encryption public key hash. 82 83 BANK_AUTHENTICATION_PUB_KEY_HASH 84 Bank authentication public key hash. 85 86 EBICS SUBMIT OPTIONS 87 -------------------- 88 89 The following configuration value(s) belong to the “[nexus-submit]” section. 90 91 FREQUENCY 92 Duration value to instruct the ``ebics-submit`` subcommand how much to wait 93 before checking the database again to find new unsubmitted payments. 94 95 MANUAL_ACK 96 Wether to wait for manual acknowledgement before submiting transactions. 97 98 EBICS FETCH OPTIONS 99 ------------------- 100 101 The following configuration value(s) belong to the “[nexus-fetch]” section. 102 103 FREQUENCY 104 Duration value to instruct the ``ebics-fetch`` subcommand how often it should 105 download from the bank. 106 107 CHECKPOINT_TIME_OF_DAY 108 At what time HH:MM of day should ``ebics-fetch`` perform a checkpoint. 109 110 IGNORE_TRANSACTIONS_BEFORE 111 Ignore all transactions before a certain YYYY-MM-DD date, useful when you want to use an existing account with old transactions that should not be bounced. 112 113 IGNORE_BOUNCES_BEFORE 114 Ignore all malformed transactions prior to a certain YYYY-MM-DD date, useful when you want to import old transactions without bouncing the malformed ones a second time. 115 116 BOUNCE_DEDUCE_FEE 117 Whether to deduce the fee paid by the exchange account from the bounced amount. 118 119 BOUNCE_FEE 120 An additional fee to deduce from the bounced amount. 121 122 RESTRICTION_PAYTO_REGEX 123 Bounce transactions coming from account not matching this regex. 124 125 HTTP SERVER OPTIONS 126 ------------------- 127 128 The following configuration value(s) belong to the “[nexus-httpd]” section. 129 130 SERVE 131 This can either be ``tcp`` or ``unix``. 132 133 PORT 134 Port on which the HTTP server listens, e.g. 9967. 135 Only used if ``SERVE`` is ``tcp``. 136 137 BIND_TO 138 Which IP address should we bind to? E.g. ``127.0.0.1`` or ``::1``for loopback. Can also be given as a hostname. 139 Only used if ``SERVE`` is ``tcp``. 140 141 UNIXPATH 142 Which unix domain path should we bind to? 143 Only used if ``SERVE`` is ``unix``. 144 145 HTTP WIRE GATEWAY API OPTIONS 146 ----------------------------- 147 148 The following configuration value(s) belong to the “[nexus-httpd-wire-gateway-api]” section. 149 150 ENABLED 151 Whether to serve the Wire Gateway API and the Prepared Transfer API. 152 153 .. include:: frags/common-api-options.rst 154 155 HTTP REVENUE API OPTIONS 156 ------------------------ 157 158 The following configuration value(s) belong to the “[nexus-httpd-revenue-api]” section. 159 160 ENABLED 161 Whether to serve the Revenue API. 162 163 .. include:: frags/common-api-options.rst 164 165 HTTP OBSERVABILITY API OPTIONS 166 ------------------------------ 167 168 The following configuration value(s) belong to the “[nexus-httpd-observability-api]” section. 169 170 ENABLED 171 Whether to serve the Observability API. 172 173 .. include:: frags/common-api-options.rst 174 175 176 DATABASE OPTIONS 177 ---------------- 178 179 Setting the database belongs to the “[libeufin-nexusdb-postgres]” section and the following value. 180 181 .. include:: frags/common-db-options.rst 182 183 SEE ALSO 184 ======== 185 186 libeufin-nexus(1) 187 188 BUGS 189 ==== 190 191 Report bugs by using https://bugs.taler.net/ or by sending electronic 192 mail to <taler@gnu.org>.