diff options
| -rw-r--r-- | core/api-merchant.rst | 5 | ||||
| -rw-r--r-- | merchant-db.png | bin | 0 -> 459305 bytes | |||
| -rw-r--r-- | taler-exchange-manual.rst | 2 | ||||
| -rw-r--r-- | taler-merchant-manual.rst | 146 |
4 files changed, 95 insertions, 58 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst index 5b0f9355..517faeef 100644 --- a/core/api-merchant.rst +++ b/core/api-merchant.rst @@ -1924,9 +1924,6 @@ Giving Customer Tips // Total amount requested for this pickup_id. requested_amount: Amount; - // Total amount processed by the exchange for this pickup. - exchange_amount: Amount; - } @@ -1976,6 +1973,8 @@ Giving Customer Tips The tip identifier is unknown. :status 409 Conflict: Some of the denomination key hashes of the request do not match those currently available from the exchange (hence there is a conflict between what the wallet requests and what the merchant believes the exchange can provide). + :status 410 Gone: + The tip has expired. .. ts:def:: TipPickupRequest diff --git a/merchant-db.png b/merchant-db.png Binary files differnew file mode 100644 index 00000000..cd5f7bd6 --- /dev/null +++ b/merchant-db.png diff --git a/taler-exchange-manual.rst b/taler-exchange-manual.rst index 2e29dbe3..2e84ab54 100644 --- a/taler-exchange-manual.rst +++ b/taler-exchange-manual.rst @@ -776,7 +776,7 @@ useful for test cases but should never be used in production. Finally, taler-exchange-dbinit has a function to garbage collect a database, allowing administrators to purge records that are no longer required. -The database scheme used by the exchange look as follows: +The database scheme used by the exchange looks as follows: .. image:: exchange-db.png diff --git a/taler-merchant-manual.rst b/taler-merchant-manual.rst index ca952d29..245e29b9 100644 --- a/taler-merchant-manual.rst +++ b/taler-merchant-manual.rst @@ -112,60 +112,6 @@ Installation This chapter describes how to install the GNU Taler merchant backend. -Installing Taler using Docker ------------------------------ - -This section provides instructions for the merchant backend installation -using ‘Docker‘. - -For security reasons, we run Docker against a VirtualBox instance, so -the ``docker`` command should connect to a ``docker-machine`` instance -that uses the VirtualBox driver. - -Therefore, the needed tools are: “docker“, “docker-machine“, and -“docker-compose“. Please refer to Docker’s official [1]_ documentation -in order to get those components installed, as that is not in this -manual’s scope. - -Before starting to build the merchant’s image, make sure a -“docker-machine“ instance is up and running. - -Because all of the Docker source file are kept in our “deployment“ -repository, we start by checking out the ``git://taler.net/deployment`` -codebase: - -:: - - $ git clone git://taler.net/deployment - -Now we actually build the merchant’s image. From the same directory as -above: - -:: - - $ cd deployment/docker/merchant/ - $ docker-compose build - -If everything worked as expected, the merchant is ready to be launched. -From the same directory as the previous step: - -:: - - # Recall: the docker-machine should be up and running. - $ docker-compose up - -You should see some live logging from all the involved containers. At -this stage of development, you should also ignore some (harmless) error -message from postresql about already existing roles and databases. - -To test if everything worked as expected, it suffices to issue a simple -request to the merchant, as: - -:: - - $ curl http://$(docker-machine ip)/ - # A greeting message should be returned by the merchant. - .. _Generic-instructions: Generic instructions @@ -329,6 +275,8 @@ commands: libtool \ libltdl-dev \ libunistring-dev \ + libsodium-dev \ + libargon2-dev \ libcurl4-gnutls-dev \ libgcrypt20-dev \ libjansson-dev \ @@ -353,6 +301,8 @@ For more recent versions of Debian, you should instead run: libtool \ libltdl-dev \ libunistring-dev \ + libsodium-dev \ + libargon2-dev \ libcurl4-gnutls-dev \ libgcrypt20-dev \ libjansson-dev \ @@ -1172,3 +1122,91 @@ options: .. [2] Supporting SEPA is still work in progress; the backend will accept this configuration, but the exchange will not work with SEPA today. + + + +Diagnostics +=========== + +This chapter includes various (very unpolished) sections on specific +topics that might be helpful to understand how the exchange operates, +which files should be backed up. The information may also be helpful for +diagnostics. + +.. _Database-Scheme: + +Database Scheme +--------------- + +The merchant database must be initialized using taler-merchant-dbinit. +This tool creates the tables required by the Taler merchant to operate. +The tool also allows you to reset the Taler merchant database, which is +useful for test cases but should never be used in production. Finally, +taler-merchant-dbinit has a function to garbage collect a database, +allowing administrators to purge records that are no longer required. + +The database scheme used by the merchant looks as follows: + +.. image:: merchant-db.png + + + +Legacy +====== + +This chapter contains some legacy documentation we need to update +before it can be considered even reasonably accurate. + +Installing Taler using Docker +----------------------------- + +This section provides instructions for the merchant backend installation +using ‘Docker‘. + +For security reasons, we run Docker against a VirtualBox instance, so +the ``docker`` command should connect to a ``docker-machine`` instance +that uses the VirtualBox driver. + +Therefore, the needed tools are: “docker“, “docker-machine“, and +“docker-compose“. Please refer to Docker’s official [1]_ documentation +in order to get those components installed, as that is not in this +manual’s scope. + +Before starting to build the merchant’s image, make sure a +“docker-machine“ instance is up and running. + +Because all of the Docker source file are kept in our “deployment“ +repository, we start by checking out the ``git://taler.net/deployment`` +codebase: + +:: + + $ git clone git://taler.net/deployment + +Now we actually build the merchant’s image. From the same directory as +above: + +:: + + $ cd deployment/docker/merchant/ + $ docker-compose build + +If everything worked as expected, the merchant is ready to be launched. +From the same directory as the previous step: + +:: + + # Recall: the docker-machine should be up and running. + $ docker-compose up + +You should see some live logging from all the involved containers. At +this stage of development, you should also ignore some (harmless) error +message from postresql about already existing roles and databases. + +To test if everything worked as expected, it suffices to issue a simple +request to the merchant, as: + +:: + + $ curl http://$(docker-machine ip)/ + # A greeting message should be returned by the merchant. |
