summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMS <ms@taler.net>2020-10-05 15:22:19 +0200
committerMS <ms@taler.net>2020-10-05 15:22:19 +0200
commit6e93827efa3481404d29005b7891830e804d0147 (patch)
tree19ffd2a730fb3214ee5756cf9e3abc44466d89f3
parentaaa614e806d65ee24184b489cbaf6e239d043b42 (diff)
downloaddocs-6e93827efa3481404d29005b7891830e804d0147.tar.gz
docs-6e93827efa3481404d29005b7891830e804d0147.tar.bz2
docs-6e93827efa3481404d29005b7891830e804d0147.zip
libeufin howto, more instructions
-rw-r--r--libeufin/api-nexus.rst4
-rw-r--r--libeufin/nexus-howto.rst19
2 files changed, 14 insertions, 9 deletions
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
index bb05a8f8..1d35a4ff 100644
--- a/libeufin/api-nexus.rst
+++ b/libeufin/api-nexus.rst
@@ -32,8 +32,8 @@ User Management
// User name
username: string;
- // Is it a superuser?
- superuser: boolean;
+ // Password
+ password: string;
}
.. http:post:: {nexusBase}/users
diff --git a/libeufin/nexus-howto.rst b/libeufin/nexus-howto.rst
index a2129273..5fc01472 100644
--- a/libeufin/nexus-howto.rst
+++ b/libeufin/nexus-howto.rst
@@ -5,7 +5,7 @@ Nexus How-To
Obtain Nexus
============
-Nexus can be downloaded via Git:
+Nexus belongs to the broader 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.
@@ -18,12 +18,6 @@ Navigate into the `libeufin` local repository, and from top-level run:
In case of success, Nexus can be run with the following command:
``$ libeufin-nexus``
-..
- Run Nexus without installation
- ==============================
- Navigate into the `libeufin` local repository, and from top-level run:
- ``$ ./gradlew nexus:run --console=plain --args=serve [--db-name=<my-db>]``
-
Connect Nexus with a EBICS account
==================================
Nexus is a Web service that unifies banking protocols, like EBICS, under
@@ -31,6 +25,17 @@ 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``
+
+At this point a `(2) superuser account needs to be activated
+into the system`:
+``$ 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.
+
+
Request history of transactions
===============================