diff options
author | Antoine A <> | 2023-11-28 15:49:26 +0000 |
---|---|---|
committer | Antoine A <> | 2023-11-28 15:49:26 +0000 |
commit | da17f801f69320fa4cb7a133b01b299032abf85e (patch) | |
tree | 17c7ef8727dbce46e46739e45cf661107d7916c8 | |
parent | 2296f0e5717a879f1e8ba2928b08668daba6d955 (diff) | |
download | docs-da17f801f69320fa4cb7a133b01b299032abf85e.tar.gz docs-da17f801f69320fa4cb7a133b01b299032abf85e.tar.bz2 docs-da17f801f69320fa4cb7a133b01b299032abf85e.zip |
Improve libeufin-bank documentation
-rw-r--r-- | libeufin/bank-manual.rst | 16 | ||||
-rw-r--r-- | manpages/libeufin-bank.1.rst | 16 |
2 files changed, 24 insertions, 8 deletions
diff --git a/libeufin/bank-manual.rst b/libeufin/bank-manual.rst index 4d3c3b75..8ba68f8f 100644 --- 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 index 681eb3ab..6a445f09 100644 --- 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 ------ |