diff options
| author | Thien-Thi Nguyen <ttn@gnuvola.org> | 2022-01-21 05:02:15 -0500 |
|---|---|---|
| committer | Thien-Thi Nguyen <ttn@gnuvola.org> | 2022-01-21 05:02:15 -0500 |
| commit | 6df0badc65548bcecf486619c1262fa3458170ac (patch) | |
| tree | 66872f76c30fc904d6980f25ca86c7e3fc03a4be /libeufin/nexus-tutorial.rst | |
| parent | 753f507cc838fed5ba09b52778b74b45560ca56b (diff) | |
| download | docs-6df0badc65548bcecf486619c1262fa3458170ac.tar.gz docs-6df0badc65548bcecf486619c1262fa3458170ac.tar.bz2 docs-6df0badc65548bcecf486619c1262fa3458170ac.zip | |
drop ‘--no-auth’; explain usage w/ various env vars
Diffstat (limited to 'libeufin/nexus-tutorial.rst')
| -rw-r--r-- | libeufin/nexus-tutorial.rst | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/libeufin/nexus-tutorial.rst b/libeufin/nexus-tutorial.rst index 02ca7296..1aa97063 100644 --- a/libeufin/nexus-tutorial.rst +++ b/libeufin/nexus-tutorial.rst @@ -134,6 +134,9 @@ If you don't have access to a real bank account with an EBICS API, you can set up the sandbox. The sandbox is a simplistic and incomplete implementation of a core banking system with EBICS access to bank accounts. +The sandbox uses HTTP Basic auth, with username ``admin``. +Choose a password and set env var ``LIBEUFIN_SANDBOX_ADMIN_PASSWORD`` to it. + The sandbox relies on a database, which you must specify using a JDBC connection URI with the ``LIBEUFIN_SANDBOX_DB_CONNECTION`` environment variable, before invoking any commands. @@ -141,7 +144,8 @@ If this variable is not set, ``libeufin-sandbox`` complains and exits: .. code-block:: console - $ libeufin-sandbox serve --no-auth + $ LIBEUFIN_SANDBOX_ADMIN_PASSWORD=secret + $ libeufin-sandbox serve DB connection string not found/valid in the env variable LIBEUFIN_SANDBOX_DB_CONNECTION. The following two examples are valid connection strings: jdbc:sqlite:/tmp/libeufindb.sqlite3 @@ -149,27 +153,28 @@ If this variable is not set, ``libeufin-sandbox`` complains and exits: Only *SQLite* and *PostgreSQL (via TCP)* are supported right now. -The option ``--no-auth`` disables authentication since ``libeufin-cli`` -(described below) does not currently support authenticated interaction. - For the following commands, the sandbox service must be running. The sandbox service is started with the following command: .. code-block:: console + $ LIBEUFIN_SANDBOX_ADMIN_PASSWORD=secret $ export LIBEUFIN_SANDBOX_DB_CONNECTION=jdbc:sqlite:/tmp/libeufintestdb - $ libeufin-sandbox serve --port 5016 --no-auth + $ libeufin-sandbox serve --port 5016 To reset the state of the sandbox, delete the database. For invocations of the LibEuFin command-line interface tool (``libeufin-cli``), -the following environment variable must be set to the URL of the sandbox +the following environment variables must be set to the URL of the sandbox service: .. code-block:: console + $ export LIBEUFIN_SANDBOX_USERNAME=admin + $ export LIBEUFIN_SANDBOX_PASSWORD=secret $ export LIBEUFIN_SANDBOX_URL=http://localhost:5016/ +Note that the password is the same as for ``LIBEUFIN_SANDBOX_ADMIN_PASSWORD``. Verify that the sandbox is running: .. code-block:: console |