diff options
author | Antoine A <> | 2024-01-23 22:51:31 +0100 |
---|---|---|
committer | Antoine A <> | 2024-01-23 22:51:31 +0100 |
commit | b386faed01df759843ad5bbccf22972dd553e96b (patch) | |
tree | 7c61255a700c8c6c106c68ec1681826fbe863824 /frags | |
parent | 968813951b4c10005f12ec15afafab97c0e8ee68 (diff) | |
download | docs-b386faed01df759843ad5bbccf22972dd553e96b.tar.gz docs-b386faed01df759843ad5bbccf22972dd553e96b.tar.bz2 docs-b386faed01df759843ad5bbccf22972dd553e96b.zip |
Improve nexus documentation
Diffstat (limited to 'frags')
-rw-r--r-- | frags/ebics-setup.rst | 27 |
1 files changed, 8 insertions, 19 deletions
diff --git a/frags/ebics-setup.rst b/frags/ebics-setup.rst index c6ff5143..8d822e8e 100644 --- a/frags/ebics-setup.rst +++ b/frags/ebics-setup.rst @@ -1,4 +1,3 @@ - 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 @@ -22,10 +21,6 @@ The following snippet shows the mandatory configuration values: 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 @@ -35,29 +30,23 @@ The following snippet shows the mandatory configuration values: 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). +.. note:: + If you want to use existing client keys, copy the JSON file to the configured path ``CLIENT_PRIVATE_KEYS_FILE`` (``/var/lib/libeufin-nexus/client-ebics-keys.json`` by default) before running the commands. + +Assuming that the configuration file exists at ``$config_file``, the following command would start the EBICS setup process. .. 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. +If the previous command failed when running EBICS INI with an error code ``EBICS_INVALID_USER_STATE``, you need to confirm your keys to your bank to activate your account. -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``. +To that purpose, the previous run should have left a PDF document that you can print, sign and send to the bank. Look for the message that looks 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. +Once the bank has received and approved this printed documents, run the same command again to download and accept the bank keys. .. code-block:: console libeufin-nexus ebics-setup -c $config_file -The setup is considered finished once the user accepts the bank keys.
\ No newline at end of file +The setup is considered finished once the bank keys are accepted.
\ No newline at end of file |