summaryrefslogtreecommitdiff
path: root/taler-exchange-manual.rst
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2023-05-16 13:13:46 +0200
committerChristian Grothoff <christian@grothoff.org>2023-05-16 13:13:46 +0200
commit91583384e3e2b27f7368d0a058e4eec9a973cb1b (patch)
tree65dce9c8f1ea2197339e0f3eec26bba95acb1509 /taler-exchange-manual.rst
parent93ad7cdc6fe6a331b913b41279adb6972b9b0890 (diff)
downloaddocs-91583384e3e2b27f7368d0a058e4eec9a973cb1b.tar.gz
docs-91583384e3e2b27f7368d0a058e4eec9a973cb1b.tar.bz2
docs-91583384e3e2b27f7368d0a058e4eec9a973cb1b.zip
stratify wire gateway configuration explanation
Diffstat (limited to 'taler-exchange-manual.rst')
-rw-r--r--taler-exchange-manual.rst74
1 files changed, 29 insertions, 45 deletions
diff --git a/taler-exchange-manual.rst b/taler-exchange-manual.rst
index 0ff1650e..0c5db851 100644
--- a/taler-exchange-manual.rst
+++ b/taler-exchange-manual.rst
@@ -1036,6 +1036,11 @@ The list of all granted permissions can be reviewed:
Exchange Bank Account Configuration
-----------------------------------
+An exchange must be configured with the right settings to access its bank
+account via a Taler Wire Gateway. An exchange can be configured to use
+multiple bank accounts by using multiple Wire Gateways. Typically only one
+Wire Gateway is used.
+
To configure a bank account in Taler, we need to furnish two pieces of
information:
@@ -1054,42 +1059,6 @@ information:
authentication information is currently a username and password
for HTTP basic authentication.
-You can configure multiple accounts for an exchange by creating sections
-starting with “exchange-account-” for the section name. You can ENABLE for
-each account whether it should be used, and for what (incoming or outgoing
-wire transfers):
-
-.. code-block:: ini
-
- [exchange-account-1]
- # With x-taler-bank (say for PyBank)
- PAYTO_URI = "payto://x-taler-bank/bank.demo.taler.net/Exchange"
-
- # Example using IBAN (for use with LibEuFin)
- # PAYTO_URI = "payto://iban/CH9300762011623852957"
-
- # URL for talking to the bank wire the wire API.
- WIRE_GATEWAY_URL = https://bank.demo.taler.net/taler-wire-gateway/Exchange
-
- # Use for exchange-aggregator (outgoing transfers)
- ENABLE_DEBIT = YES
- # Use for exchange-wirewatch (and listed in /wire)
- ENABLE_CREDIT = YES
-
- # Authentication options for exchange bank account go here.
- # (Next sections have examples of authentication mechanisms)
- WIRE_GATEWAY_AUTH_METHOD = basic
- USERNAME = exchange
- PASSWORD = super-secure
-
- ..note::
-
- FIXME: the text below explains basically the same thing again. We should de-duplicate it.
-
-The exchange must be configured with the right settings to
-access the Taler Wire Gateway. An exchange can be configured
-to use multiple bank accounts by using multiple Wire Gateways.
-Typically only one Wire Gateway is used.
A Taler Wire Gateway is configured in a configuration section that follows the
pattern ``exchange-account-$id``, where ``$id`` is an internal identifier for
@@ -1101,17 +1070,32 @@ corresponding ``exchange-accountcredentials-$id`` section in
should already be only readable for the ``taler-exchange-wire`` user. Other
exchange processes should not have access to this information.
+You can configure multiple accounts for an exchange by creating sections
+starting with “exchange-account-” for the section name. You can ENABLE for
+each account whether it should be used, and for what (incoming or outgoing
+wire transfers):
+
.. code-block:: ini
:caption: /etc/taler/conf.d/exchange-business.conf
[exchange-account-1]
- enable_credit = yes
- enable_debit = yes
-
# Account identifier in the form of an RFC-8905 payto:// URI.
# For SEPA, looks like payto://iban/$IBAN?receiver-name=$NAME
# Make sure to URL-encode spaces in $NAME!
- payto_uri =
+ #
+ # With x-taler-bank (for Fakebank)
+ # PAYTO_URI = "payto://x-taler-bank/bank.demo.taler.net/Exchange?receiver-name=exop"
+ #
+ # Example using IBAN (for use with LibEuFin)
+ PAYTO_URI = "payto://iban/CH9300762011623852957?receiver=name=exop"
+
+ # URL for talking to the bank wire the wire API.
+ WIRE_GATEWAY_URL = https://bank.demo.taler.net/taler-wire-gateway/Exchange
+
+ # Use for exchange-aggregator (outgoing transfers)
+ ENABLE_DEBIT = YES
+ # Use for exchange-wirewatch (and listed in /wire)
+ ENABLE_CREDIT = YES
@inline-secret@ exchange-accountcredentials-1 ../secrets/exchange-accountcredentials.secret.conf
@@ -1122,17 +1106,17 @@ exchange processes should not have access to this information.
[exchange-accountcredentials-1]
# LibEuFin expects basic auth.
- wire_gateway_auth_method = basic
+ WIRE_GATEWAY_AUTH_METHOD = basic
# Username and password set in LibEuFin.
- username = ...
- password = ...
+ USERNAME = ...
+ PASSWORD = ...
# Base URL of the wire gateway set up with LibEuFin.
- wire_gateway_url = ...
+ WIRE_GATEWAY_URL = ...
-The Wire Gateway configuration can be tested with the following command:
+Such a Wire Gateway configuration can be tested with the following commands:
.. code-block:: shell-session