diff options
Diffstat (limited to 'taler-exchange-manual.rst')
| -rw-r--r-- | taler-exchange-manual.rst | 52 |
1 files changed, 30 insertions, 22 deletions
diff --git a/taler-exchange-manual.rst b/taler-exchange-manual.rst index b7935fb7..a2cab433 100644 --- a/taler-exchange-manual.rst +++ b/taler-exchange-manual.rst @@ -412,18 +412,18 @@ Serving The exchange can serve HTTP over both TCP and UNIX domain socket. -The following values are to be configured in the section [exchange]: +The following options are to be configured in the section ``[exchange]``: -- serve: must be set to tcp to serve HTTP over TCP, or unix to serve - HTTP over a UNIX domain socket +- ``SERVE``: Must be set to ``tcp`` to serve HTTP over TCP, or ``unix`` to serve + HTTP over a UNIX domain socket. -- port: Set to the TCP port to listen on if serve Is tcp. +- ``PORT``: Set to the TCP port to listen on if ``SERVE`` is ``tcp``. -- unixpath: set to the UNIX domain socket path to listen on if serve Is - unix +- ``UNIXPATH``: Set to the UNIX domain socket path to listen on if ``SERVE`` is + ``unix``. -- unixpath_mode: number giving the mode with the access permission MASK - for the unixpath (i.e. 660 = rw-rw—-). +- ``UNIXPATH_MODE``: Number giving the mode with the access permission mask + for the ``UNIXPATH`` (i.e. 660 = ``rw-rw---``). .. _Currency: @@ -431,7 +431,7 @@ Currency -------- The exchange supports only one currency. This data is set under the -respective option ``CURRENCY`` in section [taler]. +respective option ``CURRENCY`` in section ``[taler]``. .. _Database: @@ -443,9 +443,9 @@ exchange is going to use. So far, only ``db = postgres`` is supported. After choosing the backend, it is mandatory to supply the connection string (namely, the database name). This is possible in two ways: -- via an environment variable: TALER_EXCHANGEDB_POSTGRES_CONFIG. +- via an environment variable: ``TALER_EXCHANGEDB_POSTGRES_CONFIG``. -- via configuration option CONFIG, under section [exchangedb-BACKEND]. +- via configuration option ``CONFIG``, under section ``[exchangedb-BACKEND]``. For example, the demo exchange is configured as follows: .. code-block:: ini @@ -581,26 +581,26 @@ if none are configured, the exchange will return a simple statement saying that there are no terms of service available. To configure the terms of service response, there are two options -in the [exchange] section: +in the ``[exchange]`` section: -- TERMS_ETAG: The current "Etag" to return for the terms of service. +- ``TERMS_ETAG``: The current "Etag" to return for the terms of service. This value must be changed whenever the terms of service are updated. A common value to use would be a version number. - Note that if you change the TERMS_ETAG, you MUST also provide - the respective files in TERMS_DIR (see below). -- TERMS_DIR: The directory that contains the terms of service. + Note that if you change the ``TERMS_ETAG``, you MUST also provide + the respective files in ``TERMS_DIR`` (see below). +- ``TERMS_DIR``: The directory that contains the terms of service. The files in the directory must be readable to the exchange process. -The TERMS_DIR directory structure must follow a particular layout. -First, inside of TERMS_DIR, there should be sub-directories using +The ``TERMS_DIR`` directory structure must follow a particular layout. +First, inside of ``TERMS_DIR``, there should be sub-directories using two-letter language codes like "en", "de", or "jp". Each of these directories would then hold translations of the current terms of service into the respective language. Empty directories are permitted in case translations are not available. Then, inside each language directory, files with the name of the -value set as the TERMS_ETAG must be provided. The extension of +value set as the ``TERMS_ETAG`` must be provided. The extension of each of the files should be typical for the respective mime type. The set of supported mime types is currently hard-coded in the exchange, and includes HTML, PDF and TXT files. If other files are @@ -609,7 +609,7 @@ present, the exchange may show a warning on startup. Example ^^^^^^^ -A sample file structure for a TERMS_ETAG of "v1" would be: +A sample file structure for a ``TERMS_ETAG`` of "v1" would be: - TERMS_DIR/en/v1.txt - TERMS_DIR/en/v1.html @@ -619,8 +619,8 @@ A sample file structure for a TERMS_ETAG of "v1" would be: - TERMS_DIR/de/v1.pdf - TERMS_DIR/fr/v1.pdf -If the user requests an HTML with language preferences "fr" followed by "en", -the exchange would return "TERMS_DIR/en/v1.html" lacking an HTML version in +If the user requests an HTML format with language preferences "fr" followed by "en", +the exchange would return ``TERMS_DIR/en/v1.html`` lacking an HTML version in French. @@ -927,6 +927,14 @@ of ``taler-exchange-offline``. under highly unusual (“emergency”) conditions and not in normal operation. +Testing a deployment +==================== + +We recommend testing whether an exchange deployment is functional by using the +Taler wallet command line interface. The tool can be used to withdraw and +deposit electronic cash via the exchange without having to deploy and operate a +separate merchant backend and storefront. For more information, see +:doc:`taler-wallet-cli-manual`. .. _Diagnostics: |