libeufin-nexus.conf.5.rst (5288B)
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 NAME 56 Legal entity that is associated with the EBICS subscriber. 57 58 BANK_PUBLIC_KEYS_FILE 59 Filesystem location where Nexus should store the bank public keys. 60 61 CLIENT_PRIVATE_KEYS_FILE 62 Filesystem location where Nexus should store the subscriber private keys. 63 64 BANK_DIALECT 65 Name of the following combination: EBICS version and ISO20022 recommendations 66 that Nexus would honor in the communication with the bank. Currently only the 67 ``postfinance``, ``gls``, ``maerki_baumann`` or ``valiant`` dialects is supported. 68 69 ACCOUNT_TYPE 70 Specify the account type and therefore the indexing behavior. This can either can be ``normal`` or ``exchange``. Exchange accounts bounce invalid incoming Taler transactions. 71 72 EBICS SETUP OPTIONS 73 ------------------- 74 75 The following configuration value(s) belong to the “[nexus-setup]” section. 76 77 BANK_ENCRYPTION_PUB_KEY_HASH 78 Bank encryption public key hash. 79 80 BANK_AUTHENTICATION_PUB_KEY_HASH 81 Bank authentication public key hash. 82 83 EBICS SUBMIT OPTIONS 84 -------------------- 85 86 The following configuration value(s) belong to the “[nexus-submit]” section. 87 88 FREQUENCY 89 Duration value to instruct the ``ebics-submit`` subcommand how much to wait 90 before checking the database again to find new unsubmitted payments. 91 92 MANUAL_ACK 93 Wether to wait for manual acknowledgement before submiting transactions. 94 95 EBICS FETCH OPTIONS 96 ------------------- 97 98 The following configuration value(s) belong to the “[nexus-fetch]” section. 99 100 FREQUENCY 101 Duration value to instruct the ``ebics-fetch`` subcommand how often it should 102 download from the bank. 103 104 CHECKPOINT_TIME_OF_DAY 105 At what time HH:MM of day should ``ebics-fetch`` perform a checkpoint. 106 107 IGNORE_TRANSACTIONS_BEFORE 108 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. 109 110 IGNORE_BOUNCES_BEFORE 111 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. 112 113 BOUNCE_DEDUCE_FEE 114 Whether to deduce the fee paid by the exchange account from the bounced amount. 115 116 BOUNCE_FEE 117 An additional fee to deduce from the bounced amount. 118 119 RESTRICTION_PAYTO_REGEX 120 Bounce transactions coming from account not matching this regex. 121 122 HTTP SERVER OPTIONS 123 ------------------- 124 125 The following configuration value(s) belong to the “[nexus-httpd]” section. 126 127 SERVE 128 This can either be ``tcp`` or ``unix``. 129 130 PORT 131 Port on which the HTTP server listens, e.g. 9967. 132 Only used if ``SERVE`` is ``tcp``. 133 134 BIND_TO 135 Which IP address should we bind to? E.g. ``127.0.0.1`` or ``::1``for loopback. Can also be given as a hostname. 136 Only used if ``SERVE`` is ``tcp``. 137 138 UNIXPATH 139 Which unix domain path should we bind to? 140 Only used if ``SERVE`` is ``unix``. 141 142 HTTP WIRE GATEWAY API OPTIONS 143 ----------------------------- 144 145 The following configuration value(s) belong to the “[nexus-httpd-wire-gateway-api]” section. 146 147 ENABLED 148 Whether to serve the Wire Gateway API. 149 150 .. include:: frags/common-api-options.rst 151 152 HTTP REVENUE API OPTIONS 153 ------------------------ 154 155 The following configuration value(s) belong to the “[nexus-httpd-revenue-api]” section. 156 157 ENABLED 158 Whether to serve the Revenue API. 159 160 .. include:: frags/common-api-options.rst 161 162 HTTP OBSERVABILITY API OPTIONS 163 ------------------------------ 164 165 The following configuration value(s) belong to the “[nexus-httpd-observability-api]” section. 166 167 ENABLED 168 Whether to serve the Observability API. 169 170 .. include:: frags/common-api-options.rst 171 172 173 DATABASE OPTIONS 174 ---------------- 175 176 Setting the database belongs to the “[libeufin-nexusdb-postgres]” section and the following value. 177 178 .. include:: frags/common-db-options.rs 179 180 SEE ALSO 181 ======== 182 183 libeufin-nexus(1) 184 185 BUGS 186 ==== 187 188 Report bugs by using https://bugs.taler.net/ or by sending electronic 189 mail to <taler@gnu.org>.