diff options
author | Antoine A <> | 2024-02-12 18:03:50 +0100 |
---|---|---|
committer | Antoine A <> | 2024-02-12 18:03:50 +0100 |
commit | 808abd6ee3c8dc5053e69a7ba8df4b4d3cf29a6a (patch) | |
tree | 48615c654c62536c562b80822c71df64dacf714c | |
parent | a2dba11f1da7ee18eb2da19533e92a700fa755fc (diff) | |
download | docs-808abd6ee3c8dc5053e69a7ba8df4b4d3cf29a6a.tar.gz docs-808abd6ee3c8dc5053e69a7ba8df4b4d3cf29a6a.tar.bz2 docs-808abd6ee3c8dc5053e69a7ba8df4b4d3cf29a6a.zip |
Improve regional currency manual
-rw-r--r-- | libeufin/bank-manual.rst | 2 | ||||
-rw-r--r-- | libeufin/nexus-manual.rst | 20 | ||||
-rw-r--r-- | libeufin/regional-manual.rst | 54 |
3 files changed, 37 insertions, 39 deletions
diff --git a/libeufin/bank-manual.rst b/libeufin/bank-manual.rst index 83f25f6a..25b793ea 100644 --- a/libeufin/bank-manual.rst +++ b/libeufin/bank-manual.rst @@ -255,7 +255,7 @@ Withdrawing e-cash to a Taler wallet .. note:: - This step is fully automated if you use the :ref:`guided automated setup <automated-regional-currency-setup>`. + This step is fully automated if you use the :ref:`guided automated setup <automated-regional-currency-setup>`. Users can withdraw digital cash from their bank account starting from their online banking as implemented by the libeufin-bank. However, in this scenario, diff --git a/libeufin/nexus-manual.rst b/libeufin/nexus-manual.rst index a5ef0e8e..c51b8838 100644 --- a/libeufin/nexus-manual.rst +++ b/libeufin/nexus-manual.rst @@ -105,25 +105,25 @@ The following snippet shows the mandatory configuration values: CURRENCY = CHF # Bank - HOST_BASE_URL = http://bank.example.com/ + HOST_BASE_URL = https://ebics.postfinance.ch/ebics/ebics.aspx BANK_DIALECT = postfinance # EBICS IDs - HOST_ID = mybank - USER_ID = myuser - PARTNER_ID = myorg + HOST_ID = PFEBICS + USER_ID = PFC00563 + PARTNER_ID = PFC00563 # Account information - IBAN = myiban - BIC = mybic - NAME = myname + IBAN = CH7789144474425692816 + BIC = POFICHBEXXX + NAME = John Smith S.A. .. note:: Refer to the manpage ``libeufin-nexus.conf(5)`` for the full array of configuration values. .. note:: - If you want to use existing client keys, copy the JSON file to the configured path ``CLIENT_PRIVATE_KEYS_FILE`` (``/var/lib/libeufin-nexus/client-ebics-keys.json`` by default) before running the following commands. + If you want to use existing client keys, copy the JSON file to the configured path ``CLIENT_PRIVATE_KEYS_FILE`` (``/var/lib/libeufin-nexus/client-ebics-keys.json`` with the default config) before running the following commands. Assuming that the configuration file exists at ``$CONFIG_FILE``, the following command should start the EBICS setup process: @@ -314,8 +314,6 @@ The ``--debug-ebics $SAVEDIR`` flag will cause the files to be stored in date when the download took place. This is mostly useful for debugging. - - For Testing ----------- @@ -327,7 +325,7 @@ the present: .. code-block:: console - $ libeufin-nexus ebics-fetch -c "$CONFIG_FILE" --pinned-start 2023-06-01 + $ libeufin-nexus ebics-fetch -c "$CONFIG_FILE" --pinned-start 2023-11-01 .. note:: diff --git a/libeufin/regional-manual.rst b/libeufin/regional-manual.rst index d7187117..1a28fa6e 100644 --- a/libeufin/regional-manual.rst +++ b/libeufin/regional-manual.rst @@ -130,36 +130,36 @@ Running the Guided Configuration This approach sets up a regional currency with cash-in/-out rates of 1:1. -Navigate into the *regional-currency/* directory, and as **root** run: +Navigate into the *regional-currency/* directory and run *main.sh* as **root**: .. code-block:: console $ cd deployment/regional-currency/ - $ sudo ./main.sh + # ./main.sh 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. - * The ISO code of the fiat currency. Use 'CHF' or 'EUR'. - * 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. - * Whether to run taler-exchange-offline. Unless you need a high-security - setup and expect to run an offline key management process, say ``y``. - If you say ``n``, you will need to run ``taler-exchange-offline setup`` - on your offline system and provide the master public key. Furthermore, - you should then study the exchange manual on offline key management to - finish the exchange setup process later. - * The admin password for the bank. Be absolutely sure to enter a very, - very long and high-entropy password, preferably use the autogenerated one. - * The DNS domain name of your setup (i.e: domain.tld). The installer will - create by itself all the needed subdomains for your domain name, - as (``bank.$DOMAIN``, ``exchange.$DOMAIN`` and ``backend.$DOMAIN``). - But, these subdomain names, must have been added beforehand to your - DNS domain control panel, and they must be pointing to the - IP address of the system on which you are running the - installation (before you execute the installer). +* The name of the regional currency. It must have 3 to 11 letters. +* The ISO code of the fiat currency. Use 'CHF' or 'EUR'. +* 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. +* Whether to run taler-exchange-offline. Unless you need a high-security + setup and expect to run an offline key management process, say ``y``. + If you say ``n``, you will need to run ``taler-exchange-offline setup`` + on your offline system and provide the master public key. Furthermore, + you should then study the exchange manual on offline key management to + finish the exchange setup process later. +* The admin password for the bank. Be absolutely sure to enter a very, + very long and high-entropy password, preferably use the autogenerated one. +* The DNS domain name of your setup (i.e: domain.tld). The installer will + create by itself all the needed subdomains for your domain name, + as (``bank.$DOMAIN``, ``exchange.$DOMAIN`` and ``backend.$DOMAIN``). + But, these subdomain names, must have been added beforehand to your + DNS domain control panel, and they must be pointing to the + IP address of the system on which you are running the + installation (before you execute the installer). The information you entered as well as the generated bank admin password will be stored in a file called ``config/user.conf``. Should you run the script in @@ -212,9 +212,9 @@ channel for :ref:`multi-factor authentication <libeufin-mfa>` is configured: Make sure to (re)start the libeufin-bank after changing these configuration options: - .. code-block:: console +.. code-block:: console - # systemctl restart libeufin-bank + # systemctl restart libeufin-bank Web-based Configuration @@ -343,10 +343,10 @@ currency account, select cash-out, specify the desired amount and pass the second-factor authorization challenge by entering the TAN you receive at the registered e-mail address or mobile phone number. -note:: +.. note:: - Cash-out operations may be subject to conversion rates, conversion fees and - minimum amounts to be transferred. + Cash-out operations may be subject to conversion rates, conversion fees and + minimum amounts to be transferred. Alternative Podman-based Deployment |