diff options
author | Christian Grothoff <christian@grothoff.org> | 2021-08-03 13:33:47 +0200 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2021-08-03 13:33:47 +0200 |
commit | 8c9298b3e5868b4bea38cd66e989e67f177c20ab (patch) | |
tree | a1ff097f74a2cf64fc9217a3f1fd6ce4553b40a4 /libeufin | |
parent | c2ecf1e084964f1f94443e4d95e125b32ed13344 (diff) | |
download | docs-8c9298b3e5868b4bea38cd66e989e67f177c20ab.tar.gz docs-8c9298b3e5868b4bea38cd66e989e67f177c20ab.tar.bz2 docs-8c9298b3e5868b4bea38cd66e989e67f177c20ab.zip |
-docu clarifications
Diffstat (limited to 'libeufin')
-rw-r--r-- | libeufin/nexus-tutorial.rst | 62 |
1 files changed, 38 insertions, 24 deletions
diff --git a/libeufin/nexus-tutorial.rst b/libeufin/nexus-tutorial.rst index 6b6eff67..d094e1db 100644 --- a/libeufin/nexus-tutorial.rst +++ b/libeufin/nexus-tutorial.rst @@ -54,28 +54,28 @@ At this point, the services can be started on boot: .. code-block:: console - # systemctl enable nexus # use 'disable' to rollback - # systemctl enable sandbox + # systemctl enable libeufin-nexus # use 'disable' to rollback + # systemctl enable libeufin-sandbox # only if you want the sandbox Or just manually: .. code-block:: console - # systemctl start nexus # use 'stop' to terminate. - # systemctl start sandbox + # systemctl start libeufin-nexus # use 'stop' to terminate. + # systemctl start libeufin-sandbox # only if you want the sandbox The following command should inform the user about the status of the running / terminated service: .. code-block:: console - # systemctl status nexus + # systemctl status libeufin-nexus For more diagnostics, use: .. code-block:: console - # journalctl -u nexus + # journalctl -u libeufin-nexus Run-time dependencies --------------------- @@ -155,7 +155,7 @@ The sandbox service is started with the following command: .. code-block:: console $ export LIBEUFIN_SANDBOX_DB_CONNECTION=jdbc:sqlite:/tmp/libeufintestdb - $ libeufin-sandbox serve --port 5000 + $ libeufin-sandbox serve --port 5016 To reset the state of the sandbox, delete the database. @@ -165,7 +165,7 @@ service: .. code-block:: console - $ export LIBEUFIN_SANDBOX_URL=http://localhost:5000/ + $ export LIBEUFIN_SANDBOX_URL=http://localhost:5016/ Verify that the sandbox is running: @@ -251,11 +251,15 @@ Use the following command to run the nexus service: .. code-block:: console $ export LIBEUFIN_NEXUS_DB_CONNECTION=jdbc:postgresql://localhost:5433/libeufindb?user=foo&password=secret - $ libeufin-nexus serve --port 5001 + $ libeufin-nexus serve --port 5017 -This sets up the PostgreSQL database to listen on port 5433, -for internal communication with the nexus service. -The nexus service itself listens on port 5001. +This assumes that the PostgreSQL service with a database +called ``libeufindb`` listens on port 5433 +for requests from the nexus service. +The nexus service itself listens on port 5017. +Note that you must have the ``LIBEUFIN_NEXUS_DB_CONNECTION`` +environment variable set for most uses of the libeufin-nexus +command. At this point a superuser account needs to be created: @@ -276,14 +280,15 @@ The command line interface needs the following three values to be defined in the environment: ``LIBEUFIN_NEXUS_URL``, ``LIBEUFIN_NEXUS_USERNAME``, and ``LIBEUFIN_NEXUS_PASSWORD``. In this example, ``LIBEUFIN_NEXUS_USERNAME`` should be set to ``foo``, and ``LIBEUFIN_NEXUS_PASSWORD`` to the value given for its password -in the previous step (with the ``libeufin-nexus superuser`` command). +in the previous step (with the ``libeufin-nexus superuser`` command). The +``LIBEUFIN_NEXUS_URL`` could be given as ``http://localhost:5017/``. Next, we create a EBICS *bank connection* that nexus can use to communicate with the bank. .. note:: - For the sandbox setup in this guide, the EBICS base URL - is ``http://localhost:5000/ebicsweb``. + For the sandbox setup in this guide, the ``EBICS_BASE_URL`` + should be ``http://localhost:5016/ebicsweb``. .. code-block:: console @@ -354,6 +359,12 @@ It is now possible to list the accounts offered by the connection. list-offered-bank-accounts \ $CONNECTION_NAME +.. note:: + + The ``nexusBankAccountId`` field should at this step be ``null``, + as we have not yet imported the bank account and thus the account + does not yet have a local name. + Nexus now needs an explicit import of the accounts it should manage. This step is needed to let the user pick a custom name for such accounts. @@ -413,11 +424,11 @@ The following command prepares a payment: .. code-block:: console $ libeufin-cli accounts prepare-payment \ - --creditor-iban $IBAN_TO_SEND_MONEY_TO \ - --creditor-bic $BIC_TO_SEND_MONEY_TO \ - --creditor-name $CREDITOR_NAME \ - --payment-amount $AMOUNT \ - --payment-subject $SUBJECT \ + --creditor-iban=$IBAN_TO_SEND_MONEY_TO \ + --creditor-bic=$BIC_TO_SEND_MONEY_TO \ + --creditor-name=$CREDITOR_NAME \ + --payment-amount=$AMOUNT \ + --payment-subject=$SUBJECT \ $LOCAL_ACCOUNT_NAME Note: the ``$AMOUNT`` value needs the format ``X.Y:CURRENCY``; for example @@ -486,9 +497,10 @@ INI and HIA secret keys will be restored for the requesting user. .. code-block:: console - $ libeufin-cli connection \ restore-backup - --passphrase $SECRET \ - --backup-file $BACKUP_FILE \ + $ libeufin-cli connections \ + restore-backup \ + --passphrase=$SECRET \ + --backup-file=$BACKUP_FILE \ $CONNECTION_NAME Creating a Taler facade @@ -501,11 +513,13 @@ want to refuse payments that do not conform to certain rules. At this moment, only the *Taler facade type* is implemented in the Nexus, and the command below instantiates one under a -existing bank account / connection pair. +existing bank account / connection pair. You can freely +assign an identifier for the ``$FACADE_NAME`` below: .. code-block:: console $ libeufin-cli facades new-facade \ + --currency EUR \ --facade-name $FACADE_NAME \ $CONNECTION_NAME \ $LOCAL_ACCOUNT_NAME |