commit 5a74e2c9fa58e27903701f2ced9a45ba1c42ce9d
parent 2e8d77ecc1233cfeea24af524dd1093b2455be9e
Author: Antoine A <>
Date: Tue, 2 Apr 2024 17:46:21 +0200
Improve regional currency manual
Diffstat:
4 files changed, 40 insertions(+), 17 deletions(-)
diff --git a/frags/regional-manual-use.rst b/frags/regional-manual-use.rst
@@ -1,15 +1,17 @@
+.. _regional-use:
+
Using the Regional Currency
===========================
-The very first step you should check afte the installation process has been
-completed successfully, is to make sure all three URLs (bank,backend and exchange),
+The very first step you should check after the installation process has been
+completed successfully, is to make sure all three URLs (bank, backend and exchange),
are available (this means to see a Website, and not any NGINX error).
Bank backend walkthrough
+++++++++++++++++++++++++
-- As stated above, please visit before "https://bank.yourdomain.ltd", to make sure it is available.
+- As stated above, please visit before "https://bank.$DOMAIN_NAME", to make sure it is available.
- Now login with the username "admin" and the password you have choosen during the installation process, or use the one which might
have been generated automatically (and shown on your terminal screen), during the installation process.
@@ -28,7 +30,7 @@ Bank backend walkthrough
If you have successfully accomplished all the previous steps, for the bank administrator
backend and your installed Wallet, you can move now to test other components such
-as the Merchant backend (https://backend.yourdomain.ltd).
+as the Merchant backend (https://backend.$DOMAIN_NAME).
Wallet Setup
++++++++++++
@@ -37,10 +39,11 @@ This section describes the interaction between the Taler graphical wallet (Andro
iOS, WebExtensions) and the regional currency system.
You need to add your regional currency exchange to the wallet. This can
-be done by scanning a QR code with a ``taler://withdraw-exchange/exchange.$DOMAIN/$MASTER_PUB``
+be done by scanning a QR code with a ``taler://withdraw-exchange/exchange.$DOMAIN_NAME/$MASTER_PUBLIC_KEY``
URL or by manually entering the URL into the respective ``Add exchange``
dialogue.
+.. _regional-use-cashin:
Cash-In
+++++++
@@ -56,9 +59,12 @@ wallet.
.. note::
- Cash-in operations may be subject to conversion rates, conversion fees and
- minimum amounts to be transferred.
+ Cash-in operations may be subject to conversion rates, conversion fees and
+ minimum amounts to be transferred.
+
+.. warning::
+ Cash-in operations can take a long time, hours at the best of times, and even days on weekends or holidays when the bank is closed.
Making payments
+++++++++++++++
@@ -81,6 +87,7 @@ instance within such a setup. To configure an instance, you primarily need
again the bank account details to :ref:`setup instance bank accounts
<instance-bank-account>`.
+.. _regional-use-cashout:
Cash-Out
++++++++
@@ -97,3 +104,7 @@ registered e-mail address or mobile phone number.
Cash-out operations may be subject to conversion rates, conversion fees and
minimum amounts to be transferred.
+
+.. warning::
+
+ Cash-out operations can take a long time, hours at the best of times, and even days on weekends or holidays when the bank is closed.
diff --git a/frags/regional-system-on.rst b/frags/regional-system-on.rst
@@ -21,8 +21,18 @@ The last step is to enable libeufin-nexus to :ref:`import incoming bank
transactions <receive-transaction-data>` (cash in) and to :ref:`trigger
outgoing bank transactions <sending-payments>` (cash out).
+First, check that libeufin-nexus is correctly configured by running the following commands:
+
+.. code-block:: console
+
+ # sudo -u libeufin-nexus libeufin-nexus ebics-setup
+ # sudo -u libeufin-nexus libeufin-nexus ebics-fetch --transient
+ # sudo -u libeufin-nexus libeufin-nexus ebics-submit --transient
+
+None of those commands should fail. If they all work, you can enable the services:
+
.. code-block:: console
# systemctl enable --now libeufin-nexus.target
-.. FIXME: explain how to test if libeufin is working!
+Now that we know that libeufin-nexus is working correctly, we still need to check that communication with your bank is working properly. We will test this later, at :ref:`the end of the manual <regional-use>`. The system should only be considered functional after a successful :ref:`cash in <regional-use-cashin>` and :ref:`cash out <regional-use-cashout>`.
+\ No newline at end of file
diff --git a/libeufin/regional-automated-manual.rst b/libeufin/regional-automated-manual.rst
@@ -59,9 +59,9 @@ You can check this from your terminal very easily with the "ping" command, as th
.. code-block:: console
- $ ping -c1 bank.domainname.ltd
- $ ping -c1 exchange.domainname.ltd
- $ ping -c1 backend.domainname.ltd
+ $ ping -c1 bank.$DOMAIN_NAME
+ $ ping -c1 exchange.$DOMAIN_NAME
+ $ ping -c1 backend.$DOMAIN_NAME
You can also use `this tool <https://toolbox.googleapps.com/apps/dig/>`_ for the same purpose, and to check the propagation status.
@@ -92,6 +92,7 @@ Navigate into the *regional-currency/* directory and run *main.sh* as **root**:
The script will start by installing the required packages and then asking you fundamental questions about the desired setup, in particular:
+#. Wether to encrypt, when stored on disk, sensible configurations such as the admin password.
#. The name of the regional currency. It must have 3 to 11 letters.
#. Whether to setup the regional currency to be backed by a fiat currency. You'll need a bank account at a fiat currency bank offering an online banking protocol supported by LibEuFin Nexus. If you answer ``y``, you will also need to provide the following information:
@@ -247,11 +248,11 @@ Installing Updates
The standard procedure for installing updates is to:
- * First, make a backup (!)
- * Stop Taler services
- * Install new version
- * Upgrade databases
- * Start Taler services
+* First, make a backup (!)
+* Stop Taler services
+* Install new version
+* Upgrade databases
+* Start Taler services
The "upgrade.sh" script in the "regional-currency/" folder of "deployment.git"
shows how to do the above steps *except* for the backup. For the backup, all
diff --git a/libeufin/regional-custom-manual.rst b/libeufin/regional-custom-manual.rst
@@ -166,7 +166,7 @@ typically requires up to three annual settings:
global-fee $YEAR \
"${REGIO_CURRENCY}:0" \
"${REGIO_CURRENCY}:0" \
- "${REGIO_CURRENCY}:0"
+ "${REGIO_CURRENCY}:0" \
4w 6y 4 \
upload
