commit 09d7b909af8d78cdbcdf99ae97eb06e3ec5cb4e2
parent d69d69930100fbe679d57771ecadbec4ffcc584a
Author: Antoine A <>
Date: Tue, 28 Nov 2023 13:42:23 +0000
Improve libeufin-bank documentation
Diffstat:
3 files changed, 34 insertions(+), 17 deletions(-)
diff --git a/libeufin/bank-manual.rst b/libeufin/bank-manual.rst
@@ -1,7 +1,7 @@
.. target audience: operator, developer
-Bank Manual
-###########
+Bank Setup Manual
+#################
.. contents:: Table of Contents
@@ -11,8 +11,8 @@ and REST APIs to interact with GNU Taler components.
In this manual, we explain how to setup a bank.
-Installing Bank
-===============
+Installing LibEuFin Bank
+========================
The following section was tested on an *OpenJDK 17* environment.
@@ -41,7 +41,7 @@ be found in the $PATH.
Setting up the LibEuFin Bank
============================
-The following snippet shows the mandatory configuration values.
+The following snippet shows the mandatory configuration values :
.. code-block:: console
@@ -70,7 +70,7 @@ command would define the database schema and create an admin account.
libeufin-bank dbinit -c $config_file
-If you wish to authenticate as admin, you must change the account password.
+If you wish to authenticate as admin, you must change the account password with the following command.
.. code-block:: console
@@ -85,15 +85,23 @@ Then you can start the HTTP server.
Enable regional currency conversion
===================================
-.. note::
- You need to have LibEuFin Nexus running to enable conversion.
- Refers to ``nexus-manual.conf`` for more details.
+Prerequisites
+-------------
+
+This step assumes that you already have a working regional currency bank
+and have successfully connected to a backing fiat bank account.
+Follow the instructions from :ref:`EBICS subscriber setup <ebics-setup>`.
+
+Exchange account creation
+-------------------------
-First you have to create an exchange account with username ``exchange``.
+You have to create an exchange account with username ``exchange`` though the Web
+interface of the bank as the ``admin`` user.
-TODO
+Configuration
+-------------
-Then you have to enable conversion in configuration and enable at least one TAN channel for cashout.
+Then you have to enable conversion and at least one TAN channel for cashout in the configuration file.
.. code-block:: console
@@ -111,6 +119,15 @@ command would start the server with conversion API enabled.
libeufin-bank serve -c $config_file
-Finally you have to setup conversion rates though the SPA.
+Web-based Configuration
+-----------------------
+
+Now you should be able to setup conversion rates though the Web
+interface of the bank as the ``admin`` user.
+
+Conversion ON!
+--------------
-TODO
-\ No newline at end of file
+The last step is to run Nexus to import incoming bank
+transactions (cash in) and to trigger outgoing bank transactions (cash out).
+Refers to ``nexus-manual.conf`` for more details.
+\ No newline at end of file
diff --git a/libeufin/regional-manual.rst b/libeufin/regional-manual.rst
@@ -146,7 +146,7 @@ messages via such a provider.
Configuration
-------------
-You have enable conversion and at least one TAN channel for cashout in the
+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
diff --git a/manpages/libeufin-bank.conf.5.rst b/manpages/libeufin-bank.conf.5.rst
@@ -70,7 +70,7 @@ UNIXPATH
Which unix domain path should we bind to?
Only used if ``SERVE`` is ``unix``.
-UNIXPATH_MODE = 660
+UNIXPATH_MODE
What should be the file access permissions for ``UNIXPATH``?
Only used if ``SERVE`` is ``unix``.
