summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--libeufin/nexus-howto.rst23
1 files changed, 21 insertions, 2 deletions
diff --git a/libeufin/nexus-howto.rst b/libeufin/nexus-howto.rst
index 672f3f35..a2129273 100644
--- a/libeufin/nexus-howto.rst
+++ b/libeufin/nexus-howto.rst
@@ -3,14 +3,33 @@ Nexus How-To
.. contents:: Table of Contents
+Obtain Nexus
+============
+Nexus can be downloaded via Git:
+``$ git clone git://git.taler.net/libeufin``
+
+Note that Kotlin+Gradle should already work on the host system.
+
Install Nexus
=============
+Navigate into the `libeufin` local repository, and from top-level run:
+``$ ./gradlew -Pprefix=$PREFIX nexus:installToPrefix``
+
+In case of success, Nexus can be run with the following command:
+``$ libeufin-nexus``
-Run Nexus without installation
-==============================
+..
+ 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
+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.
Request history of transactions
===============================