commit c7e4cd4cdf241074316c9aaf1be0f67834e4d5c2
parent 6e93827efa3481404d29005b7891830e804d0147
Author: MS <ms@taler.net>
Date: Mon, 5 Oct 2020 17:04:15 +0200
libeufin howto, more instructions
Diffstat:
1 file changed, 44 insertions(+), 7 deletions(-)
diff --git a/libeufin/nexus-howto.rst b/libeufin/nexus-howto.rst
@@ -5,7 +5,7 @@ Nexus How-To
Obtain Nexus
============
-Nexus belongs to the broader LibEuFin project, and can be downloaded via Git:
+Nexus belongs to the LibEuFin project, and can be downloaded via Git:
``$ git clone git://git.taler.net/libeufin``
Note that Kotlin+Gradle should already work on the host system.
@@ -25,16 +25,53 @@ one JSON-based abstraction layer. Therefore, "using Nexus" means having
a running Nexus service that will receive the requests from another command
line program that is as well offered along LibEuFin.
-Use the following command to `(1) run the nexus service`:
-``$ libeufin-nexus``
+Use the following command to *(1) run the nexus service*:
+
+.. code-block:: shell
+
+ $ libeufin-nexus
+
+At this point a *(2) superuser account needs to be activated
+into the system*:
+
+.. code-block:: shell
-At this point a `(2) superuser account needs to be activated
-into the system`:
-``$ libeufin-nexus superuser foo # Will interactively ask for password``
+ $ libeufin-nexus superuser foo # Will interactively ask for password
For simplicity, we'll enable the superuser to access the bank account
-via the EBICS protocol, but a API to create less privileged users exists.
+via the EBICS protocol, but a API to create less privileged users is
+as well offered.
+
+Nexus needs now to associate the user to a EBICS subscriber that was
+activated on the bank. In the terminology, this is called *(3) creating
+a EBICS connection*.
+
+.. code-block:: shell
+
+ ./libeufin-cli \
+ connections \
+ new-ebics-connection \
+ --connection-name $NEXUS_BANK_CONNECTION_NAME \
+ --ebics-url $EBICS_BASE_URL \
+ --host-id $EBICS_HOST_ID \
+ --partner-id $EBICS_PARTNER_ID \
+ --ebics-user-id $EBICS_USER_ID \
+ --nexus-user-id $NEXUS_USER \
+ --nexus-password $NEXUS_PASSWORD \
+ $NEXUS_URL
+
+If the previous command succeeded, Nexus must communicate all the details
+to the bank. Therefore, it will *(4) bootstrap the connection*.
+
+.. code-block:: shell
+ ./libeufin-cli \
+ connections \
+ bootstrap-connection \
+ --connection-name $NEXUS_BANK_CONNECTION_NAME \
+ --nexus-user-id $NEXUS_USER \
+ --nexus-password $NEXUS_PASSWORD \
+ $NEXUS_URL
Request history of transactions
===============================
