commit da17f801f69320fa4cb7a133b01b299032abf85e
parent 2296f0e5717a879f1e8ba2928b08668daba6d955
Author: Antoine A <>
Date: Tue, 28 Nov 2023 15:49:26 +0000
Improve libeufin-bank documentation
Diffstat:
2 files changed, 24 insertions(+), 8 deletions(-)
diff --git a/libeufin/bank-manual.rst b/libeufin/bank-manual.rst
@@ -92,12 +92,6 @@ 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
--------------------------
-
-You have to create an exchange account with username ``exchange`` though the Web
-interface of the bank as the ``admin`` user.
-
Configuration
-------------
@@ -112,8 +106,16 @@ Then you have to enable conversion and at least one TAN channel for cashout in t
# And/Or
TAN_EMAIL = libeufin-tan-email.sh
+
+You must have an exchange account with username ``exchange`` for conversion to work.
Assuming that the configuration file exists at ``$config_file``, the following
-command would start the server with conversion API enabled.
+command would create one:
+
+.. code-block:: console
+
+ libeufin-bank create-account '{"username":"exchange","password":"password","name":"Cashout Exchange","is_taler_exchange":true}' -c $config_file
+
+Then the following command would start the server with conversion API enabled :
.. code-block:: console
diff --git a/manpages/libeufin-bank.1.rst b/manpages/libeufin-bank.1.rst
@@ -17,7 +17,7 @@ Synopsis
[**--version**]
COMMAND [ARGS...]
-Subcommands: **serve**, **dbinit**, **passwd**, **config**
+Subcommands: **serve**, **dbinit**, **create-account**, **passwd**, **config**
Description
@@ -73,6 +73,20 @@ Its options are as follows:
**-c** \| **--config** \ \ *FILENAME*
Specifies the configuration file.
+create-account
+--------------
+
+This command create a bank account.
+
+It takes one argument, the JSON body of an account creation request via the Rest API.
+
+Its options are as follows:
+
+**-h** \| **--help**
+ Print short help on options.
+**-c** \| **--config** \ \ *FILENAME*
+ Specifies the configuration file.
+
passwd
------
