diff options
| author | MS <ms@taler.net> | 2023-01-10 16:02:02 +0100 |
|---|---|---|
| committer | MS <ms@taler.net> | 2023-01-10 16:03:06 +0100 |
| commit | f3a21a5a6250c2d7fe9475f11e44fdb91e5c3cb8 (patch) | |
| tree | eb778bc5f8a340de456b3bba8878b105c3a60f53 | |
| parent | bb748c56fe5172489bc99e68cda31ba2da4e76b8 (diff) | |
| download | docs-f3a21a5a6250c2d7fe9475f11e44fdb91e5c3cb8.tar.gz docs-f3a21a5a6250c2d7fe9475f11e44fdb91e5c3cb8.tar.bz2 docs-f3a21a5a6250c2d7fe9475f11e44fdb91e5c3cb8.zip | |
circuit tutorial
Move content to a dedicate document.
| -rw-r--r-- | libeufin/nexus-tutorial.rst | 42 |
1 files changed, 8 insertions, 34 deletions
diff --git a/libeufin/nexus-tutorial.rst b/libeufin/nexus-tutorial.rst index 482b0f96..70f0b147 100644 --- a/libeufin/nexus-tutorial.rst +++ b/libeufin/nexus-tutorial.rst @@ -94,6 +94,9 @@ Unpack the ``libeufin-$version.zip`` file to your desired location (typically ``/opt`` or ``~/opt``) and make sure that your ``PATH`` environment variable contains the ``bin/`` directory of the unpacked archive. + +.. _building-from-source: + Building from source -------------------- @@ -103,7 +106,8 @@ Nexus belongs to the LibEuFin project, and can be downloaded via Git: $ git clone git://git.taler.net/libeufin -Note that Kotlin and Gradle should already work on the host system. +Note that Kotlin and Gradle should already work on the host system, +and that Navigate into the *libeufin* local repository, and from top-level run: @@ -111,7 +115,7 @@ Navigate into the *libeufin* local repository, and from top-level run: $ ./bootstrap $ ./configure --prefix=$PREFIX - $ make install + $ make install # Note: This may require Java=18; Java=17 had errors, Java>=19 is unsupported by Gradle Verifying your installation --------------------------- @@ -441,6 +445,8 @@ To reduce the frequency to every five seconds, use the cronspec ``"*/5 * *"`` The sandbox is intended as a testing tool and thus not stable. +.. _disable-registrations: + Disable registrations (experimental) ------------------------------------ @@ -452,38 +458,6 @@ For more information on the available commands, use the built-in ``--help`` flag The full functionality of the sandbox is available via the :ref:`Sandbox API <sandbox-api>`. -Register merchants for local currencies (experimental) ------------------------------------------------------- - -This feature allows to register merchants to participate -in a local currency circuit. After having installed the -Sandbox with the steps described above, the administrator -can now register new merchant accounts with the following -command. The main difference with ordinary registrations -is that this API offers to associate a `cash-out` address -to the account, so that merchants can convert the local -currency back to their fiat bank account. - -.. note:: - Disable ordinary registrations as described in the previous section, - to make sure that only the administrator can add new accounts. - -.. code-block:: console - - $ export LIBEUFIN_SANDBOX_USERNAME=admin - $ export LIBEUFIN_SANDBOX_PASSWORD=$password - $ export LIBEUFIN_NEW_CIRCUIT_ACCOUNT_PASSWORD=$circuit-account-password - $ libeufin-cli sandbox demobank circuit-register \ - --username=example-shop \ - --email=example-shop@example.com \ - --cashout-address=payto://iban/EXAMPLESHOP-FIAT-IBAN \ - --name="Example Shop" - - -If the command exited successfully, the new user should be -able to login with the ``$circuit-account-username`` and -``$circuit-account-password`` credentials. Run ``libeufin-cli sandbox demobank circuit-register --help``, for additional information about the other options. - Connect Nexus with an EBICS account =================================== |