diff options
Diffstat (limited to 'manpages')
21 files changed, 259 insertions, 223 deletions
diff --git a/manpages/taler-auditor-dbinit.1.rst b/manpages/taler-auditor-dbinit.1.rst index 463814ac..48509012 100644 --- a/manpages/taler-auditor-dbinit.1.rst +++ b/manpages/taler-auditor-dbinit.1.rst @@ -54,5 +54,5 @@ taler-auditor-httpd(1), taler-auditor(1), taler.conf(5). Bugs ==== -Report bugs by using https://bugs.gnunet.org or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to <taler@gnu.org>. diff --git a/manpages/taler-auditor-exchange.1.rst b/manpages/taler-auditor-exchange.1.rst index 219ad44e..3471cf1a 100644 --- a/manpages/taler-auditor-exchange.1.rst +++ b/manpages/taler-auditor-exchange.1.rst @@ -58,10 +58,10 @@ Bugs We should optionally verify the correctness of this exchange’s base URL and that it matches the master public key (note that the exchange may -still be offline, so it should be possible to bypass such a verfication +still be offline, so it should be possible to bypass such a verification step). Furthermore, if we do verification, as a (less secure) convenience option, we should make **-** m optional and obtain it from the base URL. -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to <taler@gnu.org>. diff --git a/manpages/taler-auditor-sign.1.rst b/manpages/taler-auditor-sign.1.rst index b9c34fb8..86dfba39 100644 --- a/manpages/taler-auditor-sign.1.rst +++ b/manpages/taler-auditor-sign.1.rst @@ -59,5 +59,5 @@ taler.conf(5) Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to <taler@gnu.org>. diff --git a/manpages/taler-auditor.1.rst b/manpages/taler-auditor.1.rst index d8ee1a96..1d04c487 100644 --- a/manpages/taler-auditor.1.rst +++ b/manpages/taler-auditor.1.rst @@ -47,5 +47,5 @@ gnunet-ecc(1), taler-auditor-sign(1), taler.conf(5), taler-auditor-dbinit(1) Bugs ==== -Report bugs by using https://bugs.gnunet.org or by sending electronic +Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>. diff --git a/manpages/taler-bank-transfer.1.rst b/manpages/taler-bank-transfer.1.rst index 9e466def..56fe0186 100644 --- a/manpages/taler-bank-transfer.1.rst +++ b/manpages/taler-bank-transfer.1.rst @@ -105,5 +105,5 @@ taler-bank-manage(1), taler.conf(5), https://docs.taler.net/core/api-wire.html#w Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to <taler@gnu.org> diff --git a/manpages/taler-config-generate.1.rst b/manpages/taler-config-generate.1.rst index f7fd1cc5..3cd36d10 100644 --- a/manpages/taler-config-generate.1.rst +++ b/manpages/taler-config-generate.1.rst @@ -89,5 +89,5 @@ for the Taler exchange or Taler merchants. Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to <taler@gnu.org>. diff --git a/manpages/taler-exchange-aggregator.1.rst b/manpages/taler-exchange-aggregator.1.rst index 255e1e14..1e010fad 100644 --- a/manpages/taler-exchange-aggregator.1.rst +++ b/manpages/taler-exchange-aggregator.1.rst @@ -43,5 +43,5 @@ taler-exchange-httpd(1), taler.conf(5). Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to <taler@gnu.org>. diff --git a/manpages/taler-exchange-benchmark.1.rst b/manpages/taler-exchange-benchmark.1.rst index 9bc0c8d0..98bae49e 100644 --- a/manpages/taler-exchange-benchmark.1.rst +++ b/manpages/taler-exchange-benchmark.1.rst @@ -69,5 +69,5 @@ taler-exchange-httpd(1), taler.conf(5) Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to <taler@gnu.org>. diff --git a/manpages/taler-exchange-closer.1.rst b/manpages/taler-exchange-closer.1.rst index 8783cd61..7cc9e34c 100644 --- a/manpages/taler-exchange-closer.1.rst +++ b/manpages/taler-exchange-closer.1.rst @@ -43,5 +43,5 @@ taler-exchange-transfer(1), taler-exchange-httpd(1), taler.conf(5). Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to <taler@gnu.org>. diff --git a/manpages/taler-exchange-dbinit.1.rst b/manpages/taler-exchange-dbinit.1.rst index 6d9b787b..5a1616d5 100644 --- a/manpages/taler-exchange-dbinit.1.rst +++ b/manpages/taler-exchange-dbinit.1.rst @@ -52,5 +52,5 @@ taler-exchange-reservemod(1), taler.conf(5). Bugs ==== -Report bugs by using https://bugs.gnunet.org or by sending electronic +Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>. diff --git a/manpages/taler-exchange-httpd.1.rst b/manpages/taler-exchange-httpd.1.rst index 11027684..88a47435 100644 --- a/manpages/taler-exchange-httpd.1.rst +++ b/manpages/taler-exchange-httpd.1.rst @@ -100,5 +100,5 @@ taler-exchange-reservemod(1), taler.conf(5). Bugs ==== -Report bugs by using https://gnunet.org/bugs or by sending electronic +Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>. diff --git a/manpages/taler-exchange-keycheck.1.rst b/manpages/taler-exchange-keycheck.1.rst index 3f7b0352..d79bbddb 100644 --- a/manpages/taler-exchange-keycheck.1.rst +++ b/manpages/taler-exchange-keycheck.1.rst @@ -51,5 +51,5 @@ taler-exchange-dbinit(1), taler.conf(5). Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to <taler@gnu.org>. diff --git a/manpages/taler-exchange-keyup.1.rst b/manpages/taler-exchange-keyup.1.rst index cab075a7..d21cbebe 100644 --- a/manpages/taler-exchange-keyup.1.rst +++ b/manpages/taler-exchange-keyup.1.rst @@ -80,5 +80,5 @@ taler-exchange-keycheck(1), taler.conf(5). Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to <taler@gnu.org>. diff --git a/manpages/taler-exchange-transfer.1.rst b/manpages/taler-exchange-transfer.1.rst index 4dac3625..c579e655 100644 --- a/manpages/taler-exchange-transfer.1.rst +++ b/manpages/taler-exchange-transfer.1.rst @@ -42,5 +42,5 @@ taler-exchange-httpd(1), taler.conf(5). Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to <taler@gnu.org>. diff --git a/manpages/taler-exchange-wire.1.rst b/manpages/taler-exchange-wire.1.rst index 22ab8572..23242d1c 100644 --- a/manpages/taler-exchange-wire.1.rst +++ b/manpages/taler-exchange-wire.1.rst @@ -42,5 +42,5 @@ taler-exchange-httpd(1), taler.conf(5). Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to <taler@gnu.org>. diff --git a/manpages/taler-exchange-wirewatch.1.rst b/manpages/taler-exchange-wirewatch.1.rst index 8aaa50fb..9c00fd66 100644 --- a/manpages/taler-exchange-wirewatch.1.rst +++ b/manpages/taler-exchange-wirewatch.1.rst @@ -53,5 +53,5 @@ taler-exchange-aggregator(1), taler-exchange-httpd(1), taler.conf(5). Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to <taler@gnu.org>. diff --git a/manpages/taler-merchant-benchmark.1.rst b/manpages/taler-merchant-benchmark.1.rst index b4a1af36..3d688e07 100644 --- a/manpages/taler-merchant-benchmark.1.rst +++ b/manpages/taler-merchant-benchmark.1.rst @@ -99,7 +99,7 @@ Common Options Bugs ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to <taler@gnu.org>. diff --git a/manpages/taler-merchant-httpd.1.rst b/manpages/taler-merchant-httpd.1.rst index 0d12030f..68cd2fbe 100644 --- a/manpages/taler-merchant-httpd.1.rst +++ b/manpages/taler-merchant-httpd.1.rst @@ -53,7 +53,7 @@ SIGTERM Bugs ==== -Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending +Report bugs by using Mantis <https://bugs.taler.net/> or by sending electronic mail to <taler@gnu.org> diff --git a/manpages/taler-merchant-setup-reserve.1.rst b/manpages/taler-merchant-setup-reserve.1.rst new file mode 100644 index 00000000..485f769b --- /dev/null +++ b/manpages/taler-merchant-setup-reserve.1.rst @@ -0,0 +1,76 @@ +taler-merchant-setup-reserve(1) +############################### + + +.. only:: html + + Name + ==== + + **taler-merchant-setup-reserve** - setup reserve for tipping + + +Synopsis +======== + +**taler-merchant-setup-reserve** [*options*] + + +Description +=========== + +**taler-merchant-setup-reserve** is a command line tool to setup a reserve +(creating the private reserve key) and obtaining the wire transfer information +from the exchange needed to fill the reserve. + + +Options +======= + +-a VALUE, --amount=VALUE + Amount to be transferred to the reserve. Mandatory. + +-e URL, --exchange-url=URL + Use URL for the exchange base URL. This is the exchange where + the reserve will be created. The currency used in the amount + specificiation must be offered by this exchange. Mandatory. + +-m URL, --merchant-url=URL + Use URL as the merchant base URL. Should include the path to + the instance if the reserve is to be created for a non-default instance. + Mandatory. + +-w METHOD, --wire-method=METHOD + Which wire method should be used. Needed to select the wire + transfer method of the exchange. The method must be supported + by the exchange. Typical values would be "iban" or "x-taler-bank". + Mandatory. + +-c FILENAME, --config=FILENAME + Use the configuration and other resources for the merchant to + operate from FILENAME. + +-h, --help + Print short help on options. + +-v, --version + Print version information. + +-l LF, --logfile=LF + Sends logs to file whose path is LF. + +-L LOGLEVEL, --log=LOGLEVEL + Use loglevel LOGLEVEL. + + +Bugs +==== + +Report bugs by using https://bugs.taler.net/ or by sending electronic +mail to <taler@gnu.org>. + + +See Also +======== + +taler-merchant-dbinit(1), taler.conf(5) diff --git a/manpages/taler-wallet-cli.1.rst b/manpages/taler-wallet-cli.1.rst index 83fe591c..15864478 100644 --- a/manpages/taler-wallet-cli.1.rst +++ b/manpages/taler-wallet-cli.1.rst @@ -57,5 +57,5 @@ for testing. Bugs ==== -Report bugs by using https://bugs.gnunet.org or by sending electronic +Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>. diff --git a/manpages/taler.conf.5.rst b/manpages/taler.conf.5.rst index acbfa03e..174587ed 100644 --- a/manpages/taler.conf.5.rst +++ b/manpages/taler.conf.5.rst @@ -27,31 +27,31 @@ The following options are from the “[taler]” section and used by virtually all Taler components. CURRENCY - Name of the currency, i.e. “EUR” for Euro. + Name of the currency, i.e. “EUR” for Euro. The “[PATHS]” section is special in that it contains paths that can be referenced using “$” in other configuration values that specify filenames. For Taler, it commonly contains the following paths: TALER_HOME - Home directory of the user, usually “${HOME}”. Can be overwritten by - testcases by setting ${TALER_TEST_HOME}. + Home directory of the user, usually “${HOME}”. Can be overwritten by + testcases by setting ${TALER_TEST_HOME}. TALER_DATA_HOME - Where should Taler store its long-term data. Usually - “${TALER_HOME}/.local/share/taler/” + Where should Taler store its long-term data. Usually + “${TALER_HOME}/.local/share/taler/” TALER_CONFIG_HOME - Where is the Taler configuration kept. Usually - “${TALER_HOME}/.config/taler/” + Where is the Taler configuration kept. Usually + “${TALER_HOME}/.config/taler/” TALER_CACHE_HOME - Where should Taler store cached data. Usually - “${TALER_HOME}/.cache/taler/” + Where should Taler store cached data. Usually + “${TALER_HOME}/.cache/taler/” TALER_RUNTIME_DIR - Where should Taler store system runtime data (like UNIX domain - sockets). Usually “${TMP}/taler-system-runtime”. + Where should Taler store system runtime data (like UNIX domain + sockets). Usually “${TMP}/taler-system-runtime”. EXCHANGE OPTIONS ---------------- @@ -60,42 +60,42 @@ The following options are from the “[exchange]” section and used by most exchange tools. DB - Plugin to use for the database, i.e. “postgres” + Plugin to use for the database, i.e. “postgres” PORT - Port on which the HTTP server listens, i.e. 8080. + Port on which the HTTP server listens, i.e. 8080. MASTER_PUBLIC_KEY - Crockford Base32-encoded master public key, public version of the - exchange´s long-time offline signing key. + Crockford Base32-encoded master public key, public version of the + exchange´s long-time offline signing key. MASTER_PRIV_FILE - Location of the master private key on disk. Only used by tools that - can be run offline (as the master key is for offline signing). + Location of the master private key on disk. Only used by tools that + can be run offline (as the master key is for offline signing). BASE_URL - Specifies the base URL under which the exchange can be reached. Added - to wire transfers to enable tracking by merchants. + Specifies the base URL under which the exchange can be reached. Added + to wire transfers to enable tracking by merchants. AGGREGATOR_IDLE_SLEEP_INTERVAL - For how long should the aggregator sleep when it is idle before trying - to look for more work? Default is 60 seconds. + For how long should the aggregator sleep when it is idle before trying + to look for more work? Default is 60 seconds. SIGNKEY_DURATION - For how long is a signing key valid? + For how long is a signing key valid? LEGAL_DURATION - For how long are signatures with signing keys legally valid? + For how long are signatures with signing keys legally valid? LOOKAHEAD_SIGN - How long do we generate denomination and signing keys ahead of time? + How long do we generate denomination and signing keys ahead of time? LOOKAHEAD_PROVIDE - How long into the future do we provide signing and denomination keys - to clients? + How long into the future do we provide signing and denomination keys + to clients? TERMS_DIR - Directory where the terms of service of the exchange operator can be fund. The directory must contain sub-directories for every supported language, using the two-character language code in lower case, i.e. "en/" or "fr/". Each subdirectory must then contain files with the terms of service in various formats. The basename of the file of the current policy must be specified under TERMS_ETAG. The extension defines the mime type. Supported extensions include "html", "htm", "txt", "pdf", "jpg", "jpeg", "png" and "gif". For example, using a TERMS_ETAG of "0", the structure could be the following: + Directory where the terms of service of the exchange operator can be fund. The directory must contain sub-directories for every supported language, using the two-character language code in lower case, i.e. "en/" or "fr/". Each subdirectory must then contain files with the terms of service in various formats. The basename of the file of the current policy must be specified under TERMS_ETAG. The extension defines the mime type. Supported extensions include "html", "htm", "txt", "pdf", "jpg", "jpeg", "png" and "gif". For example, using a TERMS_ETAG of "0", the structure could be the following: - $TERMS_DIR/en/0.pdf - $TERMS_DIR/en/0.html - $TERMS_DIR/en/0.txt @@ -104,12 +104,12 @@ TERMS_DIR - $TERMS_DIR/de/0.txt TERMS_ETAG - Basename of the file(s) in the TERMS_DIR with the current terms of service. The value is also used for the "Etag" in the HTTP request to control caching. Whenever the terms of service change, the TERMS_ETAG MUST also change, and old values MUST NOT be repeated. For example, the date or version number of the terms of service SHOULD be used for the Etag. If there are minor (i.e. spelling) fixes to the terms of service, the TERMS_ETAG probably SHOULD NOT be changed. However, whenever users must approve the new terms, the TERMS_ETAG MUST change. + Basename of the file(s) in the TERMS_DIR with the current terms of service. The value is also used for the "Etag" in the HTTP request to control caching. Whenever the terms of service change, the TERMS_ETAG MUST also change, and old values MUST NOT be repeated. For example, the date or version number of the terms of service SHOULD be used for the Etag. If there are minor (i.e. spelling) fixes to the terms of service, the TERMS_ETAG probably SHOULD NOT be changed. However, whenever users must approve the new terms, the TERMS_ETAG MUST change. PRIVACY_DIR - Works the same as TERMS_DIR, just for the privacy policy. + Works the same as TERMS_DIR, just for the privacy policy. PRIVACY_ETAG - Works the same as TERMS_ETAG, just for the privacy policy. + Works the same as TERMS_ETAG, just for the privacy policy. EXCHANGE DATABASE OPTIONS @@ -118,17 +118,17 @@ EXCHANGE DATABASE OPTIONS The following options must be in the section "[exchangedb]". DURATION_OVERLAP - How much should validity periods for coins overlap? - Should be long enough to avoid problems with - wallets picking one key and then due to network latency - another key being valid. The DURATION_WITHDRAW period - must be longer than this value. + How much should validity periods for coins overlap? + Should be long enough to avoid problems with + wallets picking one key and then due to network latency + another key being valid. The DURATION_WITHDRAW period + must be longer than this value. IDLE_RESERVE_EXPIRATION_TIME - After which time period should reserves be closed if they are idle? + After which time period should reserves be closed if they are idle? LEGAL_RESERVE_EXPIRATION_TIME - After what time do we forget about (drained) reserves during garbage collection? + After what time do we forget about (drained) reserves during garbage collection? EXCHANGE POSTGRES BACKEND DATABASE OPTIONS @@ -138,144 +138,33 @@ The following options must be in section “[exchangedb-postgres]” if the “postgres” plugin was selected for the database. CONFIG - How to access the database, i.e. “postgres:///taler” to use the - “taler” database. Testcases use “talercheck”. - -MERCHANT OPTIONS ----------------- - -The following options are from the “[merchant]” section and used by the -merchant backend. - -DB - Plugin to use for the database, i.e. “postgres” - -PORT - Port on which the HTTP server listens, i.e. 8080. - -WIRE_TRANSFER_DELAY - How quickly do we want the exchange to send us money? Note that wire - transfer fees will be higher if we ask for money to be wired often. - Given as a relative time, i.e. “5 s” - -DEFAULT_MAX_WIRE_FEE - Maximum wire fee we are willing to accept from exchanges. Given as a - Taler amount, i.e. “EUR:0.1” - -DEFAULT_MAX_DEPOSIT_FEE - Maximum deposit fee we are willing to cover. Given as a Taler amount, - i.e. “EUR:0.1” - -MERCHANT POSTGRES BACKEND DATABASE OPTIONS ------------------------------------------- - -The following options must be in section “[merchantdb-postgres]” if the -“postgres” plugin was selected for the database. - -CONFIG - How to access the database, i.e. “postgres:///taler” to use the - “taler” database. Testcases use “talercheck”. - -MERCHANT INSTANCES ------------------- - -The merchant configuration must specify a set of instances, containing -at least the “default” instance. The following options must be given in -each “[instance-NAME]” section. - -KEYFILE - Name of the file where the instance´s private key is to be stored, - i.e. “${TALER_CONFIG_HOME}/merchant/instance/name.priv” - -NAME - Human-readable name of the instance, i.e. “Kudos Inc.” - -Additionally, for instances that support tipping, the following options -are required. - -TIP_EXCHANGE - Base-URL of the exchange that holds the reserve for tipping, - i.e. “https://exchange.demo.taler.net/” - -TIP_EXCHANGE_PRIV_FILENAME - Filename with the private key granting access to the reserve, - i.e. “${TALER_CONFIG_HOME}/merchant/reserve/tip.priv” - -KNOWN EXCHANGES (for merchants and wallets) -------------------------------------------- - -The merchant configuration can include a list of known exchanges if the -merchant wants to specify that certain exchanges are explicitly trusted. -For each trusted exchange, a section [exchange-NAME] must exist, where -NAME is a merchant-given name for the exchange. The following options -must be given in each “[exchange-NAME]” section. - -BASE_URL - Base URL of the exchange, i.e. “https://exchange.demo.taler.net/” - -MASTER_KEY - Crockford Base32 encoded master public key, public version of the - exchange´s long-time offline signing key - -CURRENCY - Name of the currency for which this exchange is trusted, i.e. “KUDOS” - -KNOWN AUDITORS (for merchants and wallets) ------------------------------------------- - -The merchant configuration can include a list of known exchanges if the -merchant wants to specify that certain auditors are explicitly trusted. -For each trusted exchange, a section [auditor-NAME] must exist, where -NAME is a merchant-given name for the exchange. The following options -must be given in each “[auditor-NAME]” section. - -BASE_URL - Base URL of the auditor, i.e. “https://auditor.demo.taler.net/” - -AUDITOR_KEY - Crockford Base32 encoded auditor public key. - -CURRENCY - Name of the currency for which this auditor is trusted, i.e. “KUDOS” - -MERCHANT ACCOUNT OPTIONS ------------------------- - -PAYTO_URI - Specifies the payto://-URL of the account. The general format is - payto://METHOD/DETAILS. - -WIRE_RESPONSE (exchange and merchant) - Specifies the name of the file in which the wire details for this merchant - account should be located. Used by the Taler exchange service and the - taler-merchant-httpd (to generate and then use the file). - -HONOR_instance - Must be set to YES for the instances (where "instance" is the section - name of the instance) of the merchant backend that should allow - incoming wire transfers for this bank account. - -ACTIVE_instance - Must be set to YES for the instances (where “instance” is the section - name of the instance) of the merchant backend that should use this - bank account in new offers/contracts. Setting ACTIVE_instance to YES - requires also setting HONOR_instance to YES. + How to access the database, i.e. “postgres:///taler” to use the + “taler” database. Testcases use “talercheck”. EXCHANGE ACCOUNT OPTIONS ------------------------ An exchange (or merchant) can have multiple bank accounts. The following -options are for sections named “[account-SOMETHING]”. The SOMETHING is +options are for sections named “[exchange-account-SOMETHING]”. The SOMETHING is arbitrary and should be chosen to uniquely identify the bank account for the operator. PAYTO_URI - Specifies the payto://-URL of the account. The general format is - payto://METHOD/DETAILS. + Specifies the payto://-URL of the account. The general format is + ``payto://$METHOD/$DETAILS``. Examples: + ``payto://x-taler-bank/localhost:8899/Exchange`` or + ``payto://iban/GENODEF1SLR/DE67830654080004822650/`` or + ``payto://iban/DE67830654080004822650/`` (providing the BIC is optional). WIRE_GATEWAY_URL - URL of the wire gateway + URL of the wire gateway. Typically of the form + ``https://$HOSTNAME[:$PORT]/taler-wire-gateway/$USERNAME/`` + where $HOSTNAME is the hostname of the system running the bank + (such as the Taler Python bank or the Nexus) and $USERNAME is + the username of the exchange's bank account (usually matching + the ``USERNAME`` option used for authentication). Example: + ``https://bank.demo.taler.net/taler-wire-gateway/Exchange/`` WIRE_GATEWAY_AUTH_METHOD This option determines how the exchange (auditor/wirewatch/aggregator) @@ -288,38 +177,22 @@ PASSWORD Password for ``basic`` authentication with the wire gateway. WIRE_RESPONSE - Specifies the name of the file in which the /wire response for this - account should be located. Used by the Taler exchange service and the - taler-exchange-wire tool. + Specifies the name of the file in which the /wire response for this + account should be located. Used by the Taler exchange service and the + taler-exchange-wire tool. Example: + ``${TALER_DATA_HOME}/exchange/wire-sigs/SOMETHING.json``. Note that + the file names must differ between all of the exchange bank accounts. + It is suggested to use the section name for ``SOMETHING`` to ensure + uniqueness. ENABLE_DEBIT - Must be set to YES for the accounts that the - taler-exchange-aggregator should debit. Not used by merchants. + Must be set to YES for the accounts that the + taler-exchange-aggregator and taler-exchange-closer should debit. ENABLE_CREDIT - Must be set to YES for the accounts that the taler-exchange-wirewatch - should check for credits. It is yet uncertain if the merchant - implementation may check this flag as well. - - -TALER-BANK AUTHENTICATION OPTIONS (for accounts) ------------------------------------------------- - -The following authentication options are supported by the “taler-bank” -wire plugin. They must be specified in the “[account-]” section that -uses the “taler-bank” plugin. - -TALER_BANK_AUTH_METHOD - Authentication method to use. “none” or “basic” are currently - supported. - -USERNAME - Username to use for authentication. Used with the “basic” - authentication method. - -PASSWORD - Password to use for authentication. Used with the “basic” - authentication method. + Must be set to YES for the accounts that the taler-exchange-wirewatch + should check for credits. It is yet uncertain if the merchant + implementation may check this flag as well. EXCHANGE WIRE FEE OPTIONS @@ -330,17 +203,17 @@ named “[fees-METHOD]” state the (aggregate) wire transfer fee and the reserve closing fees charged by the exchange. Note that fees are specified using the name of the wire method, not by the plugin name. You need to replace “YEAR” in the option name by the calendar year for which -the fee should apply. Usually, fees should be given for serveral years +the fee should apply. Usually, fees should be given for several years in advance. WIRE-FEE-YEAR - Aggregate wire transfer fee merchants are charged in YEAR. Specified - as a Taler amount using the usual amount syntax - (CURRENCY:VALUE.FRACTION). + Aggregate wire transfer fee merchants are charged in YEAR. Specified + as a Taler amount using the usual amount syntax + (CURRENCY:VALUE.FRACTION). CLOSING-FEE-YEAR - Reserve closing fee customers are charged in YEAR. Specified as a - Taler amount using the usual amount syntax (CURRENCY:VALUE.FRACTION). + Reserve closing fee customers are charged in YEAR. Specified as a + Taler amount using the usual amount syntax (CURRENCY:VALUE.FRACTION). EXCHANGE COIN OPTIONS --------------------- @@ -359,8 +232,11 @@ DURATION_WITHDRAW DURATION_SPEND How long do clients have to spend these coins? +DURATION_LEGAL + How long does the exchange have to keep records for this denomination? + FEE_WITHDRAW - What fee is charged for withdrawl? + What fee is charged for withdrawal? FEE_DEPOSIT What fee is charged for depositing? @@ -375,6 +251,88 @@ FEE_REFUND RSA_KEYSIZE What is the RSA keysize modulos (in bits)? + +MERCHANT OPTIONS +---------------- + +The following options are from the “[merchant]” section and used by the +merchant backend. + +DB + Plugin to use for the database, i.e._“postgres” + +PORT + Port on which the HTTP server listens, i.e. 8080. + +LEGAL_PRESERVATION + How long do we keep data in the database for tax audits after the + transaction has completed? Default is 10 years. + +FORCE_AUDIT + Force the merchant to report every transaction to the auditor + (if the exchange has an auditor). Default is NO. Do not change + except for testing. + + +MERCHANT POSTGRES BACKEND DATABASE OPTIONS +------------------------------------------ + +The following options must be in section “[merchantdb-postgres]” if the +“postgres” plugin was selected for the database. + +CONFIG + How to access the database, i.e. “postgres:///taler” to use the + “taler” database. Testcases use “talercheck”. + + +KNOWN EXCHANGES (for merchants) +------------------------------- + +The merchant configuration can include a list of known exchanges if the +merchant wants to specify that certain exchanges are explicitly trusted. +For each trusted exchange, a section [merchant-exchange-$NAME] must exist, where +$NAME is a merchant-given name for the exchange. The following options +must be given in each “[exchange-$NAME]” section. + +EXCHANGE_BASE_URL + Base URL of the exchange, i.e. “https://exchange.demo.taler.net/” + +MASTER_KEY + Crockford Base32 encoded master public key, public version of the + exchange´s long-time offline signing key. Can be omitted, in that + case the exchange will NOT be trusted unless it is audited by + a known auditor. + Omitting the MASTER_KEY can be useful if we do not trust the exchange + without an auditor, but should pre-load the keys of this + particular exchange on startup instead of waiting for it to be + required by a client. + +CURRENCY + Name of the currency for which this exchange is used, i.e. “KUDOS”. + The entire section is ignored if the currency does not match the currency + we use, which must be given in the [taler] section. + +KNOWN AUDITORS (for merchants) +------------------------------ + +The merchant configuration can include a list of known exchanges if the +merchant wants to specify that certain auditors are explicitly trusted. +For each trusted exchange, a section [merchant-auditor-$NAME] must exist, where +$NAME is a merchant-given name for the auditor. The following options +must be given in each “[merchant-auditor-$NAME]” section. + +AUDITOR_BASE_URL + Base URL of the auditor, i.e. “https://auditor.demo.taler.net/” + +AUDITOR_KEY + Crockford Base32 encoded auditor public key. + +CURRENCY + Name of the currency for which this auditor is trusted, i.e. “KUDOS” + The entire section is ignored if the currency does not match the currency + we use, which must be given in the [taler] section. + + AUDITOR OPTIONS --------------- @@ -382,10 +340,11 @@ The following options must be in section “[auditor]” for the Taler auditor. DB - Plugin to use for the database, i.e. “postgres” + Plugin to use for the database, i.e. “postgres” AUDITOR_PRIV_FILE - Name of the file containing the auditor’s private key + Name of the file containing the auditor’s private key + AUDITOR POSTGRES BACKEND DATABASE OPTIONS ----------------------------------------- @@ -394,8 +353,9 @@ The following options must be in section “[auditordb-postgres]” if the “postgres” plugin was selected for the database. CONFIG - How to access the database, i.e. "postgres:///taler" to use the - "taler" database. Testcases use “talercheck”. + How to access the database, i.e. "postgres:///taler" to use the + "taler" database. Testcases use “talercheck”. + SEE ALSO ======== @@ -406,5 +366,5 @@ taler-exchange-keyup(1), taler-exchange-wire(1). BUGS ==== -Report bugs by using https://gnunet.org/bugs/ or by sending electronic +Report bugs by using https://bugs.taler.net/ or by sending electronic mail to <taler@gnu.org>. |