diff options
author | MS <ms@taler.net> | 2023-12-11 21:08:20 +0100 |
---|---|---|
committer | MS <ms@taler.net> | 2023-12-11 21:08:20 +0100 |
commit | 977353d896e55f6e96f37bd49a382cc1d7c2b9d9 (patch) | |
tree | 09c2691b96c5a837723b46299b2ed4c5b488eb84 | |
parent | ddece22779b216a2f793fba02b33a26d0a528bf0 (diff) | |
download | docs-977353d896e55f6e96f37bd49a382cc1d7c2b9d9.tar.gz docs-977353d896e55f6e96f37bd49a382cc1d7c2b9d9.tar.bz2 docs-977353d896e55f6e96f37bd49a382cc1d7c2b9d9.zip |
regional manual: addressing NLnet feedback
-rw-r--r-- | libeufin/regional-manual.rst | 76 |
1 files changed, 45 insertions, 31 deletions
diff --git a/libeufin/regional-manual.rst b/libeufin/regional-manual.rst index d93ff9da..adee8a83 100644 --- a/libeufin/regional-manual.rst +++ b/libeufin/regional-manual.rst @@ -31,7 +31,7 @@ these IPs. To further simplify the process, we suggest to use (or at least study) the automatic deployment scripts provided in the ``deployment.git`` Git repository -in the ``netzbon/`` folder. +in the ``regional-currency/`` folder. Obtaining the scripts @@ -48,7 +48,7 @@ Guided Configuration This approach sets up a regional currency with cash-in/-out rates of 1:1. -Navigate into the *netzbon/* directory, and as **root** run: +Navigate into the *regional-currency/* directory, and as **root** run: .. code-block:: console @@ -79,14 +79,17 @@ desired setup, in particular: IP address of the system on which you are running the installation (before you execute the installer)). -The information you entered will be stored in a file called -``config/user.conf``. Should you run the script in the future (for -example, to upgrade the installation), you will not be asked these -questions a second time. +The information you entered will be stored in a file called ``config/user.conf``. +Should you run the script in the future (for example, to upgrade the installation), +you will not be asked these questions a second time. -After answering all of the questions, the actual installation will -start. The scripts will download and configure various packages, -which may take some time. Grab a coffee. +After answering all of the questions, the actual installation will start. The +scripts will download and configure various packages, which may take some time. +Grab a coffee. + +.. note:: + + At this point, the setup is NOT connected to any fiat bank account! Connecting to a Fiat Bank ========================= @@ -108,30 +111,22 @@ in that bank account would likely confuse the system, it is highly advised to use a fresh bank account, with an empty transaction history. Today, the LibEuFin implementation supports EBICS 2.5 and 3.0 and has been -tested with the GLS Bank (EUR) and the Postfinance (CHF). Please note that -banks tend to have their own dialects of finance messages and thus other -retail banks may or may not work. Contact us if you need support for another -bank or core banking protocol. +tested with the Postfinance (CHF). Please note that banks tend to have their +own dialects of finance messages and thus other retail banks may or may not work. +Contact us if you need support for another bank or core banking protocol. EBICS setup ----------- -Follow the instructions from -:ref:`EBICS subscriber setup <ebics-setup>` to -configure the LibEuFin Nexus for access to your -fiat bank account, but do edit the config file at -``/etc/libeufin/libeufin-nexus.conf``, since the -other components expect it. +Follow the instructions from :ref:`EBICS subscriber setup <ebics-setup>` to +configure the LibEuFin Nexus for access to your fiat bank account, but do edit +the config file at ``/etc/libeufin/libeufin-nexus.conf``, since the other components +expect it. .. note:: - For debug setups where the cash-ins are simulated - :ref:`this way <withdraw-simulation>`, this step can - be entirely skipped. - -Once you have accepted the bank keys, you should -setup currency conversion before actually starting -to import transactions. + For debug setups where the cash-ins are simulated :ref:`this way <withdraw-simulation>`, + this step can be entirely skipped. Configuring the merchant ======================== @@ -188,11 +183,24 @@ for it. Take note of the link beside ``Payment URI`` (we'll call it ``$payUri`` In order to test the setup, it should be now possible to use the command line wallet to withdraw Taler coins and spend them to buy the order we just created. +.. _withdraw-simulation: + Pay for the order ----------------- -Run the script ``./withdraw.sh`` without any arguments. After the execution, 5 units -of the regional currency should be found in your waller CLI. Check it with: +This section explains how to pay for the order in a scenario where the fiat bank +is simulated. The simulation takes place by crafting ad-hoc XML files as if the +bank would have issued them. Such XML files carry information about incoming payments +to the regional currency master bank account. Finally, the XML files are passed +to LibEuFin nexus via a convenient CLI method. The responsible script for such +simulation is ``withdraw.sh``. + +Run ``./withdraw.sh`` without any arguments. Assuming that you ran the command +as the ``test-user``, after the execution, 5 units of the regional currency should +be found in the CLI wallet owned by ``test-user``. + + +Check it with: .. code-block:: console @@ -258,9 +266,15 @@ If so, call the wallet in the following way to finally pay for the order just cr # systemctl restart libeufin-bank - Note: the scripts TAN_SMS/EMAIL must accept the phone number as the ``$1`` - parameter and the content in their standard input. The LibEuFin repository - offers them in ``contrib/``: adjust to your setup! + The scripts TAN_SMS/EMAIL must accept the phone number / e-mail address + as the ``$1`` parameter and the content in their standard input. The LibEuFin + repository offers them in ``contrib/``: adjust to your setup! + + .. note:: + + the TAN_SMS script relies on a Telesign account. For this reason, + it needs a telesign-secret file found in the PATH, that defines the + environment variables API_KEY and CUSTOMER_ID Web-based Configuration ----------------------- |