summaryrefslogtreecommitdiff
path: root/libeufin
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2021-01-29 21:05:17 +0100
committerChristian Grothoff <christian@grothoff.org>2021-01-29 21:05:17 +0100
commit7348e2f95f1e36d66e16be7778fa583d56c1b64e (patch)
treea9f3c9addb12790060abdae425570e183dcb2225 /libeufin
parent03eeb79192ceb55e01737640d0d59502b3c74ca0 (diff)
parent99eafd6b3b2292e473f316d61075680c48e9f0d1 (diff)
downloaddocs-7348e2f95f1e36d66e16be7778fa583d56c1b64e.tar.gz
docs-7348e2f95f1e36d66e16be7778fa583d56c1b64e.tar.bz2
docs-7348e2f95f1e36d66e16be7778fa583d56c1b64e.zip
Merge branch 'master' of git+ssh://git.taler.net/docs
Diffstat (limited to 'libeufin')
-rw-r--r--libeufin/nexus-tutorial.rst38
1 files changed, 14 insertions, 24 deletions
diff --git a/libeufin/nexus-tutorial.rst b/libeufin/nexus-tutorial.rst
index 0ce97c2b..dd850bda 100644
--- a/libeufin/nexus-tutorial.rst
+++ b/libeufin/nexus-tutorial.rst
@@ -110,6 +110,11 @@ The sandbox service is started with the following command:
To reset the state of the sandbox, delete the database. By default,
the database is a SQLite3 file in ``/tmp/libeufin-sandbox.sqlite3``.
+A different database can be specified as a JDBC connection URI
+with the ``LIBEUFIN_SANDBOX_DB_CONNECTION`` environment variable.
+Only *SQLite* (e.g. ``jdbc:sqlite:/tmp/libeufintestdb``) and *PostgreSQL (via TCP)*
+(e.g. ``jdbc:postgresql://localhost:$port/libeufintestdb?user=$username&password=$password``)
+are supported right now.
For invocations of the LibEuFin command-line interface tool (``libeufin-cli``),
the following environment variable must be set to the URL of the sandbox
@@ -121,13 +126,10 @@ service:
Verify that the sandbox is running:
-.. ??? What is the expected output of this command?
-.. => it's a JSON fragment like {name: "libeufin-sandbox", version: "0.0.0"}
- Basically, it calls this: https://git.taler.net/libeufin.git/tree/sandbox/src/main/kotlin/tech/libeufin/sandbox/Main.kt#n288
-
.. code-block:: console
$ libeufin-cli sandbox check
+ {name: "libeufin-sandbox", version: "0.0.0"}
Now an EBICS host can be created:
@@ -196,36 +198,24 @@ Use the following command to run the nexus service:
$ libeufin-nexus serve --port 5001
By default, the SQLite3 database ``/tmp/libeufin-nexus.sqlite3`` will be used.
-The database can be specified as a JDBC connection URI with the
-``--db-conn-string=$DBCONN`` option. Only *SQLite* and *PostgreSQL (only via
-TCP)* are supported right now.
-
-.. warning::
-
- For production-grade deployments of LibEuFin, we do not recommend specifying the
- secret database credentials via command line arguments, as can will expose
- those credentials to other users.
-
- Instead, the DB connection string should be specified in an environment variable
- (which can be set in the systemd unit via an ``EnvironmentFile`` option)
- once LibEuFin supports this (see the corresponding
- `bug tracker entry <https://bugs.gnunet.org/view.php?id=6720>`__).
-
+The database can be specified as a JDBC connection URI
+with the ``LIBEUFIN_NEXUS_DB_CONNECTION`` environment variable.
+Only *SQLite* (e.g. ``jdbc:sqlite:/tmp/libeufintestdb``) and *PostgreSQL (via TCP)*
+(e.g. ``jdbc:postgresql://localhost:$port/libeufintestdb?user=$username&password=$password``)
+are supported right now.
For example:
.. code-block:: console
- $ libeufin-nexus serve \
- --db-conn-string=jdbc:postgresql://127.0.0.1:5433/libeufindb?user=foo&password=secret
+ $ export LIBEUFIN_NEXUS_DB_CONNECTION=jdbc:postgresql://127.0.0.1:5433/libeufindb?user=foo&password=secret
+ $ libeufin-nexus serve
At this point a superuser account needs to be created:
.. code-block:: console
- $ libeufin-nexus superuser \
- --db-conn-string=jdbc:postgresql://127.0.0.1:5433/libeufindb?user=foo&password=secret \
- foo # Will interactively ask for password
+ $ libeufin-nexus superuser foo # Will interactively ask for password
For simplicity, a superuser can as well act as a normal user, but an API
to create less privileged users is offered.