[taler-docs] branch master updated: comment out untested sections

[gnunet]

This is an automated email from the git hooks/post-receive script.

ms pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new 917c4764 comment out untested sections
917c4764 is described below

commit 917c4764741abe5c4c22986a731f794da2173657
Author: MS <ms@taler.net>
AuthorDate: Fri Dec 8 09:12:11 2023 +0100

    comment out untested sections
---
 libeufin/regional-manual.rst | 267 ++++++++++++++++++++++---------------------
 1 file changed, 136 insertions(+), 131 deletions(-)

diff --git a/libeufin/regional-manual.rst b/libeufin/regional-manual.rst
index 4f31f8b0..3b4e471b 100644
--- a/libeufin/regional-manual.rst
+++ b/libeufin/regional-manual.rst
@@ -46,6 +46,8 @@ First, download the deployment scripts via Git:
 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:
 
 .. code-block:: console
@@ -56,6 +58,7 @@ The script will start by asking you fundamental questions 
about the
 desired setup, in particular:
 
   * The name of the regional currency. It must have 3 to 11 letters.
+    Currently only 'NETZBON' is supported.
   * The name of the regional currency bank. It will be shown to business
     users when they interact with the system.
   * Whether to use TLS or not. You should answer ``y`` in most cases.
@@ -130,108 +133,10 @@ Once you have accepted the bank keys, you should
 setup currency conversion before actually starting
 to import transactions.
 
-Enable regional currency conversion
-===================================
-
-Prerequisites
--------------
-
-This step assumes that you already have a working regional currency bank
-and have successfully connected to a backing fiat bank account.
-
-Additionally, for each account that is allowed to convert regional currency
-into fiat, you must configure the (fiat) bank account number of the fiat
-currency with the respective account profile.  Only the bank ``admin`` is
-allowed to set fiat bank account numbers.
-
-Furthermore, to achieve a reasonable security level, you must enable two
-factor authentication for "cash out" transactions. This requires you to
-configure an e-mail address or phone number for every account that supports
-"cash out" transactions --- and to setup your system for sending e-mails or
-SMS. This manual does not cover setting up e-mail.  For SMS delivery, you will
-need to obtain credentials from an SMS provider and provide a script to send
-messages via such a provider.
-
-Configuration
--------------
-
-You have to enable conversion and at least one TAN channel for cashout in the
-``/etc/libeufin/libeufin-bank.conf`` configuration file:
-
-.. code-block:: console
-
-  [libeufin-bank]
-  ALLOW_CONVERSION = yes
-  FIAT_CURRENCY = EUR
-
-  TAN_SMS = libeufin-tan-sms.sh
-  # And/Or
-  TAN_EMAIL = libeufin-tan-email.sh
-
-Afterwards, restart the bank:
-
-.. code-block:: console
-
-  # 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!
+Configuring the merchant
+========================
 
-Web-based Configuration
------------------------
-
-Now you should be able to setup conversion rates and ``admin`` debt limit 
though the Web
-interface of the bank as the ``admin`` user.
-
-
-Conversion ON!
---------------
-
-The last step is to enable the Nexus services to import incoming bank
-transactions (cash in) and to trigger outgoing bank transactions (cash out):
-
-.. code-block:: console
-
-  # systemd enable --now libeufin-nexus-ebics-fetch
-  # systemd enable --now libeufin-nexus-ebics-submit
-
-
-Going live!
-===========
-
-Exchange setup
---------------
-
-First, you need to use the ``taler-exchange-offline`` tool to inform the
-exchange about the fiat bank account that can be used for cash in operations
-and also specify the URL for currency conversion. Additionally, you may also
-configure restrictions on the bank accounts that may originate the funds, for
-example to prevent international wire transfers that may expose you to
-additional compliance risks.
-
-Given the ``$IBAN`` of the fiat currency bank account and ``$NAME`` as
-the (URL-encoded) name of the exchange-account owner, the following
-``taler-exchange-offline`` invocation can be used to notify wallets about
-the possibility of currency conversion (cash in):
-
-.. code-block:: console
-
-  # taler-exchange-offline \
-      enable-account \
-        payto://iban/$IBAN?receiver-name=$NAME \
-        conversion-url "$CONVERSION_URL" \
-      upload
-
-Here, the ``$CONVERSION_URL`` must be set to the base URL of the conversion
-endpoint of the bank, which should be ``https://bank.$DOMAIN/conversion-info/``
-in our setup.
-
-Merchant setup
---------------
-
-In order to setup a shop, you need a merchant backend to run.  The installation
+In order to setup a shop, you need a merchant backend to run.  The guided setup
 installs and sets one backend up, but the user is required to complete the shop
 configuration via the Web browser.
 
@@ -268,7 +173,7 @@ After providing the details and confirming, the shop is 
ready to generate orders
 and accept payments.
 
 Make an order
-+++++++++++++
+-------------
 
 Click on ``Orders`` at the top left corner of the merchant backoffice page; the
 following page should appear
@@ -285,7 +190,7 @@ In order to test the setup, it should be now possible to 
use the command line wa
 to withdraw Taler coins and spend them to buy the order we just created.
 
 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:
@@ -305,31 +210,131 @@ If so, call the wallet in the following way to finally 
pay for the order just cr
    Delete the database records before going to production, as they alter the 
way
    nexus-fetch asks records to the bank.
 
-
-Wallet setup
-------------
-
-You need to add your regional currency exchange to the wallet.  This can
-be done by scanning a QR code with a ``taler://add-exchange/exchange.$DOMAIN``
-URL or by manually entering the URL into the respective ``Add exchange``
-dialogue.
-
-With this, you should then be able to ``add`` funds in the regional currency
-to your exchange by starting the withdraw process in the wallet. After
-specifying the desired amount, the wallet should show you the details of the
-fiat wire transfer that must be made for the cash in to be completed. Once the
-money has arrived at the fiat bank account, Nexus will obtain the transaction
-data and the regional currency bank will create the corresponding amount in
-regional currency, crediting the GNU Taler exchange account. In turn, the
-exchange will issue the respective amount to your wallet.
-
-For testing, you should be able to *deposit* regional currency directly
-into a LibEuFin Bank account from the Taler wallet.  Once the exchange
-has credited the regional currency account, log into the bank account
-using the Web interface. Assuming the cash out rules are satisfied, you
-should then be able to start a cash out operation. This will trigger a
-transfer from your regional currency account to the regional currency
-master ``bank`` account which will effectively destroy the respective
-amount of regional currency. The conversion triggers will inform Nexus
-about the destruction, and Nexus will then wire the corresponding amount
-in fiat to the associated fiat bank account.
+..
+  FIXME: uncomment once tested.
+
+  Enable regional currency conversion
+  ===================================
+  
+  Prerequisites
+  -------------
+  
+  This step assumes that you already have a working regional currency bank
+  and have successfully connected to a backing fiat bank account.
+  
+  Additionally, for each account that is allowed to convert regional currency
+  into fiat, you must configure the (fiat) bank account number of the fiat
+  currency with the respective account profile.  Only the bank ``admin`` is
+  allowed to set fiat bank account numbers.
+  
+  Furthermore, to achieve a reasonable security level, you must enable two
+  factor authentication for "cash out" transactions. This requires you to
+  configure an e-mail address or phone number for every account that supports
+  "cash out" transactions --- and to setup your system for sending e-mails or
+  SMS. This manual does not cover setting up e-mail.  For SMS delivery, you 
will
+  need to obtain credentials from an SMS provider and provide a script to send
+  messages via such a provider.
+  
+  Configuration
+  -------------
+  
+  You have to enable conversion and at least one TAN channel for cashout in the
+  ``/etc/libeufin/libeufin-bank.conf`` configuration file:
+  
+  .. code-block:: console
+  
+    [libeufin-bank]
+    ALLOW_CONVERSION = yes
+    FIAT_CURRENCY = EUR
+  
+    TAN_SMS = libeufin-tan-sms.sh
+    # And/Or
+    TAN_EMAIL = libeufin-tan-email.sh
+  
+  Afterwards, restart the bank:
+  
+  .. code-block:: console
+  
+    # 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!
+  
+  Web-based Configuration
+  -----------------------
+  
+  Now you should be able to setup conversion rates and ``admin`` debt limit 
though the Web
+  interface of the bank as the ``admin`` user.
+  
+  
+  Conversion ON!
+  --------------
+  
+  The last step is to enable the Nexus services to import incoming bank
+  transactions (cash in) and to trigger outgoing bank transactions (cash out):
+  
+  .. code-block:: console
+  
+    # systemd enable --now libeufin-nexus-ebics-fetch
+    # systemd enable --now libeufin-nexus-ebics-submit
+  
+  
+  Going live!
+  ===========
+  
+  Exchange setup
+  --------------
+  
+  First, you need to use the ``taler-exchange-offline`` tool to inform the
+  exchange about the fiat bank account that can be used for cash in operations
+  and also specify the URL for currency conversion. Additionally, you may also
+  configure restrictions on the bank accounts that may originate the funds, for
+  example to prevent international wire transfers that may expose you to
+  additional compliance risks.
+  
+  Given the ``$IBAN`` of the fiat currency bank account and ``$NAME`` as
+  the (URL-encoded) name of the exchange-account owner, the following
+  ``taler-exchange-offline`` invocation can be used to notify wallets about
+  the possibility of currency conversion (cash in):
+  
+  .. code-block:: console
+  
+    # taler-exchange-offline \
+        enable-account \
+          payto://iban/$IBAN?receiver-name=$NAME \
+          conversion-url "$CONVERSION_URL" \
+        upload
+  
+  Here, the ``$CONVERSION_URL`` must be set to the base URL of the conversion
+  endpoint of the bank, which should be 
``https://bank.$DOMAIN/conversion-info/``
+  in our setup.
+
+  Wallet setup
+  ------------
+  
+  You need to add your regional currency exchange to the wallet.  This can
+  be done by scanning a QR code with a 
``taler://add-exchange/exchange.$DOMAIN``
+  URL or by manually entering the URL into the respective ``Add exchange``
+  dialogue.
+  
+  With this, you should then be able to ``add`` funds in the regional currency
+  to your exchange by starting the withdraw process in the wallet. After
+  specifying the desired amount, the wallet should show you the details of the
+  fiat wire transfer that must be made for the cash in to be completed. Once 
the
+  money has arrived at the fiat bank account, Nexus will obtain the transaction
+  data and the regional currency bank will create the corresponding amount in
+  regional currency, crediting the GNU Taler exchange account. In turn, the
+  exchange will issue the respective amount to your wallet.
+  
+  For testing, you should be able to *deposit* regional currency directly
+  into a LibEuFin Bank account from the Taler wallet.  Once the exchange
+  has credited the regional currency account, log into the bank account
+  using the Web interface. Assuming the cash out rules are satisfied, you
+  should then be able to start a cash out operation. This will trigger a
+  transfer from your regional currency account to the regional currency
+  master ``bank`` account which will effectively destroy the respective
+  amount of regional currency. The conversion triggers will inform Nexus
+  about the destruction, and Nexus will then wire the corresponding amount
+  in fiat to the associated fiat bank account.

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.