diff options
author | Antoine A <> | 2024-01-19 15:13:25 +0000 |
---|---|---|
committer | Antoine A <> | 2024-01-19 15:13:25 +0000 |
commit | 2ed2e2fe47ff9bd98646d00f4b4840c6969a0abc (patch) | |
tree | e432de1117b695944b7d69e90e0f986ae626eeb6 /libeufin/nexus-manual.rst | |
parent | 94bd6b747ac294e4a38131a5a8cc757669e0e5ad (diff) | |
download | docs-2ed2e2fe47ff9bd98646d00f4b4840c6969a0abc.tar.gz docs-2ed2e2fe47ff9bd98646d00f4b4840c6969a0abc.tar.bz2 docs-2ed2e2fe47ff9bd98646d00f4b4840c6969a0abc.zip |
Improve regional manual
Diffstat (limited to 'libeufin/nexus-manual.rst')
-rw-r--r-- | libeufin/nexus-manual.rst | 65 |
1 files changed, 2 insertions, 63 deletions
diff --git a/libeufin/nexus-manual.rst b/libeufin/nexus-manual.rst index 686bb1ff..14988b7e 100644 --- a/libeufin/nexus-manual.rst +++ b/libeufin/nexus-manual.rst @@ -45,68 +45,7 @@ be found in the $PATH. Setting up the EBICS subscriber =============================== -When you sign up for an EBICS-enabled bank account, the bank will provide you -with various credentials. Those must be provided in the -``/etc/libeufin/libeufin-nexus.conf`` configuration file together with the -name of the *fiat* currency. - -The following snippet shows the mandatory configuration values: - -.. _core-config: - -.. code-block:: console - - [nexus-ebics] - CURRENCY = CHF - - # Bank - HOST_BASE_URL = http://bank.example.com/ - BANK_DIALECT = postfinance - - # EBICS IDs - HOST_ID = mybank - USER_ID = myuser - PARTNER_ID = myorg - - # Key files - BANK_PUBLIC_KEYS_FILE = ${LIBEUFIN_HOME}/bank-keys.json - CLIENT_PRIVATE_KEYS_FILE = ${LIBEUFIN_HOME}/subscriber-keys.json - - # Account information - IBAN = myiban - BIC = mybic - NAME = myname - -.. note:: - Refer to the manpage ``libeufin-nexus.conf(5)`` - for the full array of configuration values. - -Assuming that the configuration file exists at ``$config_file``, the following -command would start the EBICS setup process. The files CLIENT_PRIVATE_KEYS_FILE -and BANK_PUBLIC_KEYS_FILE would be created at the CWD. Adjust their path to your -setup ('$HOME' is currently not supported along paths). - -.. code-block:: console - - libeufin-nexus ebics-setup -c $config_file - -If the previous command succeeded, the subscriber keys reached the bank, but the setup -**should** fail with an ``EBICS_INVALID_USER_STATE`` error code. That happens because -the client tries to download the bank keys *before* having confirmed the subscriber keys -via the traditional post service. - -To that purpose, the previous run should have left a PDF document that the subscriber can -print, sign, and send to the bank to confirm their subscriber keys. Look for the message -looking like ``PDF file with keys hex encoding created at: /tmp/libeufin-nexus-keys-$timestamp.pdf``. - -Once the bank received and approved such printed document, run the same command again, in -order to download the bank keys and let the user accept them. - -.. code-block:: console - - libeufin-nexus ebics-setup -c $config_file - -The setup is considered finished once the user accepts the bank keys. +.. include:: ../frags/ebics-setup.rst Sending payments ================ @@ -228,7 +167,7 @@ be stored. [nexus-postgres] config = postgres:///nexus [nexus-fetch] - # Optional, but usfeful against data loss. + # Optional, but usefull against data loss. statement_log_directory = $LIBEUFIN_DATA_HOME/downloads Assuming that ``$config_file`` contains any required option, the following command |