doc: rewrite.
This commit is contained in:
ng0
parent
6e33de941e
commit
0d8f503543
@ -1,34 +1,45 @@
|
|||||||
.TH TALER\-AUDITOR\-EXCHANGE 1 "Nov 3, 2018" "GNU Taler"
|
.Dd November 3, 2018
|
||||||
|
.Dd TALER-AUDITOR-EXCHANGE 1
|
||||||
.SH NAME
|
.Os
|
||||||
taler\-auditor\-exchange \- add or remove exchange from auditor's list
|
.Sh NAME
|
||||||
|
.Nm taler-auditor-exchange
|
||||||
.SH SYNOPSIS
|
.Nd
|
||||||
.B taler\-auditor\-exchange [--remove] -m EXCHANGE_KEY -u EXCHANGE_URL
|
add or remove exchange from auditor's list
|
||||||
.RI [ options ]
|
.Sh SYNOPSIS
|
||||||
.br
|
.Nm
|
||||||
|
.Op Fl h | \-help
|
||||||
.SH DESCRIPTION
|
.Op Fl r | \-remove
|
||||||
\fBtaler\-auditor\-exchange\fP is a command line tool to be used by an auditor to add or remove an exchange from the list of exchange's audited by the auditor. You must add an exchange to that list before signing denomination keys with taler\-auditor\-sign or trying to audit it with taler\-auditor or taler\-wire\-auditor. Afterwards the exchange will be visible via the /exchanges API of the taler\-auditor\-httpd.
|
.Op Fl m Ar MASTERKEY | Fl \-exchange-key= Ns Ar MASTERKEY
|
||||||
|
.Op Fl u Ar EXCHANGE_URL | Fl \-auditor-url= Ns Ar EXCHANGE_URL
|
||||||
.SH OPTIONS
|
.Sh DESCRIPTION
|
||||||
.B
|
.Nm
|
||||||
.IP "\-m MASTERKEY, \-\-exchange-key=MASTERKEY"
|
is a command line tool to be used by an auditor to add or remove an exchange from the list of exchange's audited by the auditor.
|
||||||
Public key of the exchange in Crockford base32 encoding, for example as generated by gnunet\-ecc \-p.
|
You must add an exchange to that list before signing denomination keys with taler-auditor-sign or trying to audit it with taler-auditor or taler-wire-auditor.
|
||||||
.B
|
Afterwards the exchange will be visible via the /exchanges API of the taler-auditor-httpd.
|
||||||
.IP "\-h, \-\-help"
|
.Bl -tag -width Ds
|
||||||
|
.It Fl m Ar MASTERKEY | Fl \-exchange-key= Ns Ar MASTERKEY
|
||||||
|
Public key of the exchange in Crockford base32 encoding, for example as generated by gnunet-ecc -p.
|
||||||
|
.It Fl h | \-help
|
||||||
Print short help on options.
|
Print short help on options.
|
||||||
.B
|
.It Fl u Ar EXCHANGE_URL | Fl \-auditor-url= Ns Ar EXCHANGE_URL
|
||||||
.IP "\-u URL, \-\-auditor-url=URL"
|
URL of the exchange.
|
||||||
URL of the exchange. The exchange's HTTP API must be available at this address.
|
The exchange's HTTP API must be available at this address.
|
||||||
.B
|
.It Fl r | \-remove
|
||||||
.IP "\-r, \-\-remove"
|
Instead of adding the exchange, remove it.
|
||||||
Instead of adding the exchange, remove it. Note that this will drop ALL data associated with that exchange, including existing auditing information. So use with extreme care!
|
Note that this will drop ALL data associated with that exchange, including existing auditing information.
|
||||||
|
So use with extreme care!
|
||||||
.SH BUGS
|
.Sh SEE ALSO
|
||||||
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 step). Furthermore, if we do verification, as a (less secure) convenience option, we should make \-m optional and obtain it from the base URL.
|
.Xr gnunet-ecc 1 ,
|
||||||
|
.Xr taler-auditor-sign 1 ,
|
||||||
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
|
.Xr taler.conf 5
|
||||||
|
.Sh BUGS
|
||||||
.SH "SEE ALSO"
|
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 step).
|
||||||
\fBtaler\-auditor\-sign\fP(1), \fBgnunet\-ecc\fP(1), \fBtaler.conf\fP(5)
|
Furthermore, if we do verification, as a (less secure) convenience option, we should make
|
||||||
|
.Fl
|
||||||
|
m
|
||||||
|
optional and obtain it from the base URL.
|
||||||
|
.Pp
|
||||||
|
Report bugs by using
|
||||||
|
.Lk https://gnunet.org/bugs/
|
||||||
|
or by sending electronic mail to
|
||||||
|
.Aq Mt taler@gnu.org .
|
||||||
|
|||||||
@ -1,40 +1,46 @@
|
|||||||
.TH TALER\-AUDITOR\-SIGN 1 "Mar 15, 2016" "GNU Taler"
|
.Dd
|
||||||
|
.Dt TALER\-AUDITOR\-SIGN 1 "Mar 15, 2016" "GNU Taler"
|
||||||
.SH NAME
|
.Os
|
||||||
taler\-auditor\-sign \- Sign exchange denomination as auditor.
|
.Sh NAME
|
||||||
|
.Nm taler\-auditor\-sign
|
||||||
.SH SYNOPSIS
|
.Nd
|
||||||
.B taler\-auditor\-sign
|
Sign exchange denomination as auditor.
|
||||||
.RI [ options ]
|
.Sh SYNOPSIS
|
||||||
.br
|
.Nm
|
||||||
|
.Op Fl a Ar FILE | Fl \-auditor-key= Ns Ar FILE
|
||||||
.SH DESCRIPTION
|
.Op Fl h | \-help
|
||||||
\fBtaler\-auditor\-sign\fP is a command line tool to be used by an auditor to sign that he is aware of certain keys being used by a exchange. Using this signature, the auditor affirms that he will verify that the exchange is properly accounting for those coins.
|
.Op Fl m Ar KEY | Fl \-exchange-key= Ns Ar KEY
|
||||||
|
.Op Fl u Ar URL | Fl \-auditor-url= Ns Ar URL
|
||||||
|
.Op Fl r Ar FILE | Fl \-exchange-request= Ns Ar FILE
|
||||||
|
.Op Fl o Ar FILE | Fl \-output= Ns Ar FILE
|
||||||
|
.Sh DESCRIPTION
|
||||||
|
.Nm
|
||||||
|
is a command line tool to be used by an auditor to sign that he is aware of certain keys being used by a exchange.
|
||||||
|
Using this signature, the auditor affirms that he will verify that the exchange is properly accounting for those coins.
|
||||||
|
.Pp
|
||||||
The exchange for which keys were signed must have been added to the auditor using taler\-auditor\-exchange first!
|
The exchange for which keys were signed must have been added to the auditor using taler\-auditor\-exchange first!
|
||||||
|
.Bl -tag -width Ds
|
||||||
.SH OPTIONS
|
.It Fl a Ar FILE | Fl \-auditor-key= Ns Ar FILE
|
||||||
.B
|
Location of the private EdDSA auditor key.
|
||||||
.IP "\-a FILE, \-\-auditor-key=FILE"
|
If it does not exist, it will be created.
|
||||||
Location of the private EdDSA auditor key. If it does not exist, it will be created.
|
.It Fl h | \-help
|
||||||
.B
|
|
||||||
.IP "\-h, \-\-help"
|
|
||||||
Print short help on options.
|
Print short help on options.
|
||||||
.B
|
.It Fl m Ar KEY | Fl \-exchange-key= Ns Ar KEY
|
||||||
.IP "\-m KEY, \-\-exchange-key=KEY"
|
Public key of the exchange in Crockford base32 encoding, for example as generated by gnunet-ecc -p.
|
||||||
Public key of the exchange in Crockford base32 encoding, for example as generated by gnunet\-ecc \-p.
|
.It Fl u Ar URL | Fl \-auditor-url= Ns Ar URL
|
||||||
.B
|
URL of the auditor.
|
||||||
.IP "\-u URL, \-\-auditor-url=URL"
|
Provides informative link for the user to learn more about the auditor.
|
||||||
URL of the auditor. Provides informative link for the user to learn more about the auditor.
|
.It Fl r Ar FILE | Fl \-exchange-request= Ns Ar FILE
|
||||||
.B
|
File with the exchange's denomination key signing request as generated by taler-exchange-keyup -o.
|
||||||
.IP "\-r FILE, \-\-exchange-request=FILE"
|
.It Fl o Ar FILE | Fl \-output= Ns Ar FILE
|
||||||
File with the exchange's denomination key signing request as generated by taler\-exchange\-keyup \-o.
|
|
||||||
.B
|
|
||||||
.IP "\-o FILE, \-\-output=FILE"
|
|
||||||
File where the auditor should write the EdDSA signature.
|
File where the auditor should write the EdDSA signature.
|
||||||
|
.Sh SEE ALSO
|
||||||
.SH BUGS
|
.Xr gnunet-ecc 1 ,
|
||||||
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
|
.Xr taler-auditor-exchange 1 ,
|
||||||
|
.Xr taler-exchange-keyup 1 ,
|
||||||
.SH "SEE ALSO"
|
.Xr taler.conf 5
|
||||||
\fBtaler\-auditor\-exchange\fP(1), \fBtaler\-exchange\-keyup\fP(1), \fBgnunet\-ecc\fP(1), \fBtaler.conf\fP(5)
|
.Sh BUGS
|
||||||
|
Report bugs by using
|
||||||
|
.Lk https://gnunet.org/bugs/
|
||||||
|
or by sending electronic mail to
|
||||||
|
.Aq Mt taler@gnu.org .
|
||||||
|
|||||||
@ -1,29 +1,43 @@
|
|||||||
.TH TALER\-AUDITOR 1 "Mar 20, 2017" "GNU Taler"
|
.Dd March 20, 2017
|
||||||
|
.Dt TALER-AUDITOR 1
|
||||||
.SH NAME
|
.Os
|
||||||
taler\-auditor \- Audit exchange.
|
.Sh NAME
|
||||||
|
.Nm taler-auditor
|
||||||
.SH SYNOPSIS
|
.Nd
|
||||||
.B taler\-auditor -m MASTER_KEY
|
Audit exchange
|
||||||
.RI [ options ]
|
.Sh SYNOPSIS
|
||||||
.br
|
.Nm
|
||||||
|
.Op Fl h | \-help
|
||||||
.SH DESCRIPTION
|
.Op Fl m Ar MASTER_KEY | Fl \-exchange-key= Ns Ar MASTER_KEY
|
||||||
\fBtaler\-auditor\fP is a command line tool to be used by an auditor to audit an exchange's database and calculate the current financial state of the exchange (including revenue, amount expected in escrow and risk exposure). The audit is incremental. The first audit must be performed with the \-r option to initialize the tables. The tool reports inconsistencies in the balance or incorrect cryptographic signatures found in the database. It does NOT check with the bank to see that the incoming and outgoing wire transfers that the bank claims to have matches the exchange's database.
|
.Op Fl r | \-reset
|
||||||
|
.Sh DESCRIPTION
|
||||||
.SH OPTIONS
|
.Nm
|
||||||
.B
|
is a command line tool to be used by an auditor to audit an exchange's database and calculate the current financial state of the exchange (including revenue, amount expected in escrow and risk exposure).
|
||||||
.IP "\-h, \-\-help"
|
The audit is incremental.
|
||||||
|
The first audit must be performed with the
|
||||||
|
.Fl r
|
||||||
|
option to initialize the tables.
|
||||||
|
The tool reports inconsistencies in the balance or incorrect cryptographic signatures found in the database.
|
||||||
|
It does NOT check with the bank to see that the incoming and outgoing wire transfers that the bank claims to have matches the exchange's database.
|
||||||
|
Its options are as follows.
|
||||||
|
.Bl -tag -wdith Ds
|
||||||
|
.It Fl h | \-help
|
||||||
Print short help on options.
|
Print short help on options.
|
||||||
.B
|
.It Fl m Ar KEY | Fl \-exchange-key= Ns Ar KEY
|
||||||
.IP "\-m KEY, \-\-exchange-key=KEY"
|
Public master key of the exchange in Crockford base32 encoding, for example as generated by gnunet-ecc -p.
|
||||||
Public master key of the exchange in Crockford base32 encoding, for example as generated by gnunet\-ecc \-p. If this option is missing, taler\-auditor will use the MASTER_PUBLIC_KEY value from the "exchange" section of the configuration.
|
If this option is missing, taler-auditor will use the MASTER_PUBLIC_KEY value from the "exchange" section of the configuration.
|
||||||
.B
|
.It Fl r | \-reset
|
||||||
.IP "\-r, \-\-reset"
|
Reset the audit, starts everything from the beginning.
|
||||||
Reset the audit, starts everything from the beginning. Useful for testing and required for the first audit to setup auditor's tables. Note that if (just) the exchange key changes, the \-r option should not be used again.
|
Useful for testing and required for the first audit to setup auditor's tables.
|
||||||
|
Note that if (just) the exchange key changes, the
|
||||||
.SH BUGS
|
.Fl r
|
||||||
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
|
option should not be used again.
|
||||||
|
.Sh SEE ALSO
|
||||||
.SH "SEE ALSO"
|
.Xr gnunet-ecc 1 ,
|
||||||
\fBtaler\-auditor\-sign\fP(1), \fBgnunet\-ecc\fP(1), \fBtaler.conf\fP(5)
|
.Xr taler-auditor-sign 1 ,
|
||||||
|
.Xr taler.conf 5
|
||||||
|
.Sh BUGS
|
||||||
|
Report bugs by using
|
||||||
|
.Lk https://bugs.gnunet.org
|
||||||
|
or by sending electronic mail to
|
||||||
|
.Aq Mt taler@gnu.org .
|
||||||
|
|||||||
@ -1,50 +1,55 @@
|
|||||||
.TH TALER\-BANK\-TRANSFER 1 "Dec 14, 2017" "GNU Taler"
|
.Dd December 14, 2017
|
||||||
|
.Dt TALER-BANK-TRANSFER 1
|
||||||
.SH NAME
|
.Os
|
||||||
taler\-bank\-transfer \- Trigger a transfer at the bank
|
.Sh NAME
|
||||||
|
.Nm taler-bank-transfer
|
||||||
.SH SYNOPSIS
|
.Nd
|
||||||
.B taler\-bank\-transfer
|
trigger a transfer at the bank
|
||||||
.RI [ options ]
|
.Sh SYNOPSIS
|
||||||
.br
|
.Nm
|
||||||
|
.Op Fl a Ar VALUE | Fl \-amount= Ns Ar VALUE
|
||||||
.SH DESCRIPTION
|
.Op Fl b Ar URL | Fl \-bank= Ns Ar URL
|
||||||
\fBtaler\-bank\-transfer\fP is a command line tool to trigger bank transfers.
|
.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
|
||||||
|
.Op Fl h | \-help
|
||||||
.SH OPTIONS
|
.Op Fl D Ar ACCOUNT | Fl \-debit= Ns Ar ACCOUNT
|
||||||
.B
|
.Op Fl C Ar ACCOUNT | Fl \-credit= Ns Ar ACCOUNT
|
||||||
.IP "\-a VALUE, \-\-amount=VALUE"
|
.Op Fl s Ar STRING | Fl \-subject= Ns Ar STRING
|
||||||
Amount to transfer. Given in the Taler\-typical format of CURRENCY:VALUE.FRACTION
|
.Op Fl u Ar USERNAME | Fl \-user= Ns Ar USERNAME
|
||||||
.B
|
.Op Fl p Ar PASSPHRASE | Fl \-pass= Ns Ar PASSPHRASE
|
||||||
.IP "\-b URL, \-\-bank=URL"
|
.Op Fl v | \-version
|
||||||
|
.Sh DESCRIPTION
|
||||||
|
.Nm
|
||||||
|
is a command line tool to trigger bank transfers.
|
||||||
|
.Bl -tag -width Ds
|
||||||
|
.It Fl a Ar VALUE | Fl \-amount= Ns Ar VALUE
|
||||||
|
Amount to transfer.
|
||||||
|
Given in the Taler\-typical format of CURRENCY:VALUE.FRACTION
|
||||||
|
.It Fl b Ar URL | Fl \-bank= Ns Ar URL
|
||||||
URL at which the bank is operation.
|
URL at which the bank is operation.
|
||||||
.B
|
.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
|
||||||
.IP "\-c FILENAME, \-\-config=FILENAME"
|
|
||||||
Use the given configuration file.
|
Use the given configuration file.
|
||||||
.B
|
.It Fl h | \-help
|
||||||
.IP "\-h, \-\-help"
|
|
||||||
Print short help on options.
|
Print short help on options.
|
||||||
.B
|
.It Fl D Ar ACCOUNT | Fl \-debit= Ns Ar ACCOUNT
|
||||||
.IP "\-D ACCOUNT, \-\-debit=ACCOUNT"
|
The money should be debited from ACCOUNT.
|
||||||
The money should be debited from ACCOUNT. Specifies the number of the account.
|
Specifies the number of the account.
|
||||||
.B
|
.It Fl C Ar ACCOUNT | Fl \-credit= Ns Ar ACCOUNT
|
||||||
.IP "\-C ACCOUNT, \-\-credit=ACCOUNT"
|
The money should be credited to ACCOUNT.
|
||||||
The money should be credited to ACCOUNT. Specifies the number of the account.
|
Specifies the number of the account.
|
||||||
.B
|
.It Fl s Ar STRING | Fl \-subject= Ns Ar STRING
|
||||||
.IP "\-s STRING, \-\-subject=STRING"
|
|
||||||
Use STRING for the wire transfer subject.
|
Use STRING for the wire transfer subject.
|
||||||
.B
|
.It Fl u Ar USERNAME | Fl \-user= Ns Ar USERNAME
|
||||||
.IP "\-u USERNAME, \-\-user=USERNAME"
|
|
||||||
Specifies the username for authentication.
|
Specifies the username for authentication.
|
||||||
.B
|
.It Fl p Ar PASSPHRASE | Fl \-pass= Ns Ar PASSPHRASE
|
||||||
.IP "\-p PASSPHRASE, \-\-pass=PASSPHRASE"
|
|
||||||
Specifies the pass phrase for authentication.
|
Specifies the pass phrase for authentication.
|
||||||
.B
|
.It Fl v | \-version
|
||||||
.IP "\-v, \-\-version"
|
|
||||||
Print version information.
|
Print version information.
|
||||||
|
.El
|
||||||
.SH BUGS
|
.Sh SEE ALSO
|
||||||
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
|
.Xr taler-bank-manage 1 ,
|
||||||
|
.Xr taler.conf 5
|
||||||
.SH "SEE ALSO"
|
.Sh BUGS
|
||||||
\fBtaler\-bank\-manage\fP(1), \fBtaler.conf\fP(5)
|
Report bugs by using
|
||||||
|
.Lk https://gnunet.org/bugs/
|
||||||
|
or by sending electronic mail to
|
||||||
|
.Aq Mt taler@gnu.org
|
||||||
|
|||||||
@ -1,63 +1,74 @@
|
|||||||
.TH TALER\-CONFIG\-GENERATE 1 "May 5, 2016" "GNU Taler"
|
.Dd May 5, 2016
|
||||||
|
.Dt TALER-CONFIG-GENERATE 1
|
||||||
.SH NAME
|
.Os
|
||||||
taler\-config\-generate \- tool to simplify Taler configuration generation
|
.Sh NAME
|
||||||
|
.Nm taler-config-generate
|
||||||
.SH SYNOPSIS
|
.Nd
|
||||||
.B taler\-config\-generate
|
tool to simplify Taler configuration generation
|
||||||
.RI [ options ]
|
.Os
|
||||||
.br
|
.Sh SYNOPSIS
|
||||||
|
.Nm
|
||||||
.SH DESCRIPTION
|
.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
|
||||||
\fBtaler\-config\-generate\fP can be used to generate configuration files for the Taler exchange or Taler merchants
|
.Op Fl C Ar CURRENCY | Fl \-currency= Ns Ar CURRENCY
|
||||||
|
.Op Fl e | \-exchange
|
||||||
.SH OPTIONS
|
.Op Fl f Ar AMOUNT | \-wirefee= Ns Ar AMOUNT
|
||||||
.B
|
.Op Fl m | \-merchant
|
||||||
.IP "\-c FILENAME, \-\-config=FILENAME"
|
.Op Fl t | \-trusted
|
||||||
Location where to write the generated configuration. Existing file will be updated, not overwritten.
|
.Op Fl w Ar WIREFORMAT | Fl \-wire Ar WIREFORMAT
|
||||||
.B
|
.Op Fl j Ar JSON | Fl \-wire-json-merchant= Ns Ar JSON
|
||||||
.IP "\-C CURRENCY, \-\-currency=CURRENCY"
|
.Op Fl J Ar JSON | Fl \-wire-json-exchange= Ns Ar JSON
|
||||||
|
.Op Fl \-bank-uri
|
||||||
|
.Op Fl \-exchange-bank-account
|
||||||
|
.Op Fl \-merchant-bank-account
|
||||||
|
.Op Fl h | \-help
|
||||||
|
.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
|
||||||
|
.Op Fl v | \-version
|
||||||
|
.Sh DESCRIPTION
|
||||||
|
.Nm
|
||||||
|
can be used to generate configuration files for the Taler exchange or Taler merchants.
|
||||||
|
.Bl -tag -width Ds
|
||||||
|
.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
|
||||||
|
Location where to write the generated configuration.
|
||||||
|
Existing file will be updated, not overwritten.
|
||||||
|
.It Fl C Ar CURRENCY | Fl \-currency= Ns Ar CURRENCY
|
||||||
Which currency should we use in the configuration.
|
Which currency should we use in the configuration.
|
||||||
.B
|
.It Fl e | \-exchange
|
||||||
.IP "\-e, \-\-exchange"
|
|
||||||
Generate configuration for a Taler exchange.
|
Generate configuration for a Taler exchange.
|
||||||
.B
|
.It Fl f Ar AMOUNT | \-wirefee= Ns Ar AMOUNT
|
||||||
.IP "\-f AMOUNT, \-\-wirefee=AMOUNT"
|
|
||||||
Setup wire transfer fees for the next 5 years for the exchange (for all wire methods).
|
Setup wire transfer fees for the next 5 years for the exchange (for all wire methods).
|
||||||
.B
|
.It Fl m | \-merchant
|
||||||
.IP "\-m, \-\-merchant"
|
|
||||||
Generate configuration for a Taler merchant.
|
Generate configuration for a Taler merchant.
|
||||||
.B
|
.It Fl t | \-trusted
|
||||||
.IP "\-t, \-\-trusted"
|
Setup current exchange as trusted with current merchant.
|
||||||
Setup current exchange as trusted with current merchant. Generally only useful when configuring for testcases.
|
Generally only useful when configuring for testcases.
|
||||||
.B
|
.It Fl w Ar WIREFORMAT | Fl \-wire Ar WIREFORMAT
|
||||||
.IP "\-w WIREFORMAT, \-\-wire WIREFORMAT"
|
|
||||||
Specifies which wire format to use (i.e. "test" or "sepa")
|
Specifies which wire format to use (i.e. "test" or "sepa")
|
||||||
.B
|
.It Fl j Ar JSON | Fl \-wire-json-merchant= Ns Ar JSON
|
||||||
.IP "\-j JSON, \-\-wire-json-merchant=JSON"
|
|
||||||
Wire configuration to use for the merchant.
|
Wire configuration to use for the merchant.
|
||||||
.B
|
.It Fl J Ar JSON | Fl \-wire-json-exchange= Ns Ar JSON
|
||||||
.IP "\-J JSON, \-\-wire-json-exchange=JSON"
|
|
||||||
Wire configuration to use for the exchange.
|
Wire configuration to use for the exchange.
|
||||||
.B
|
.It Fl \-bank-uri
|
||||||
.IP "\-\-bank-uri"
|
Alternative to specify wire configuration to use for the exchange and merchant for the "test" wire method.
|
||||||
Alternative to specify wire configuration to use for the exchange and merchant for the "test" wire method. Only useful if WIREFORMAT was set to "test". Specifies the URI of the bank.
|
Only useful if WIREFORMAT was set to "test".
|
||||||
.B
|
Specifies the URI of the bank.
|
||||||
.IP "\-\-exchange-bank-account"
|
.It Fl \-exchange-bank-account
|
||||||
Alternative to specify wire configuration to use for the exchange for the "test" wire method. Only useful if WIREFORMAT was set to "test". Specifies the bank account number of the exchange.
|
Alternative to specify wire configuration to use for the exchange for the "test" wire method.
|
||||||
.B
|
Only useful if WIREFORMAT was set to "test".
|
||||||
.IP "\-\-merchant-bank-account"
|
Specifies the bank account number of the exchange.
|
||||||
Alternative to specify wire configuration to use for the merchant for the "test" wire method. Only useful if WIREFORMAT was set to "test". Specifies the bank account number of the merchant.
|
.It Fl \-merchant-bank-account
|
||||||
.B
|
Alternative to specify wire configuration to use for the merchant for the "test" wire method.
|
||||||
.IP "\-h, \-\-help"
|
Only useful if WIREFORMAT was set to "test".
|
||||||
|
Specifies the bank account number of the merchant.
|
||||||
|
.It Fl h | \-help
|
||||||
Shows this man page.
|
Shows this man page.
|
||||||
.B
|
.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
|
||||||
.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
|
Use LOGLEVEL for logging.
|
||||||
Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
|
Valid values are DEBUG, INFO, WARNING and ERROR.
|
||||||
.B
|
.It Fl v | \-version
|
||||||
.IP "\-v, \-\-version"
|
|
||||||
Print GNUnet version number.
|
Print GNUnet version number.
|
||||||
|
.El
|
||||||
|
.Sh BUGS
|
||||||
.SH BUGS
|
Report bugs by using
|
||||||
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
|
.Lk https://gnunet.org/bugs/
|
||||||
|
or by sending electronic mail to
|
||||||
|
.Aq Mt taler@gnu.org .
|
||||||
|
|||||||
@ -1,32 +1,37 @@
|
|||||||
.TH TALER\-EXCHANGE\-AGGREGATOR 1 "Mar 30, 2016" "GNU Taler"
|
.Dd Mar 30, 2016
|
||||||
|
.Dt TALER-EXCHANGE-AGGREGATOR 1
|
||||||
.SH NAME
|
.Os
|
||||||
taler\-exchange\-aggregator \- Aggregate and execute exchange transactions
|
.Sh NAME
|
||||||
|
.Nm taler-exchange-aggregator
|
||||||
.SH SYNOPSIS
|
.Nd
|
||||||
.B taler\-exchange\-aggregator
|
Aggregate and execute exchange transactions
|
||||||
.RI [ options ]
|
.Sh SYNOPSIS
|
||||||
.br
|
.Nm
|
||||||
|
.Op Fl d Ar DIRNAME | Fl \-exchange-dir= Ns Ar DIRNAME
|
||||||
.SH DESCRIPTION
|
.Op Fl h | \-help
|
||||||
\fBtaler\-exchange\-aggregator\fP is a command line tool to run pending transactions from the Taler exchange.
|
.Op Fl t | \-test
|
||||||
|
.Op Fl v | \-version
|
||||||
.SH OPTIONS
|
.Sh DESCRIPTION
|
||||||
.B
|
.Nm
|
||||||
.IP "\-d DIRNAME, \-\-exchange-dir=DIRNAME"
|
is a command line tool to run pending transactions from the Taler exchange.
|
||||||
Use the configuration and other resources for the exchange to operate from DIRNAME.
|
.Bl -tag -width Ds
|
||||||
.B
|
.It Fl d Ar DIRNAME | Fl \-exchange-dir= Ns Ar DIRNAME
|
||||||
.IP "\-h, \-\-help"
|
Use the configuration and other resources for the exchange to operate from
|
||||||
|
.Ar DIRNAME .
|
||||||
|
.It Fl h | \-help
|
||||||
Print short help on options.
|
Print short help on options.
|
||||||
.B
|
.It Fl t | \-test
|
||||||
.IP "\-t, \-\-test"
|
|
||||||
Run in test mode and exit when idle.
|
Run in test mode and exit when idle.
|
||||||
.B
|
.It Fl v | \-version
|
||||||
.IP "\-v, \-\-version"
|
|
||||||
Print version information.
|
Print version information.
|
||||||
.B
|
.El
|
||||||
.SH BUGS
|
.Sh SEE ALSO
|
||||||
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
|
.Xr taler-exchange-dbinit 1 ,
|
||||||
|
.Xr taler-exchange-keyup 1 ,
|
||||||
.SH "SEE ALSO"
|
.Xr taler-exchange-httpd 1 ,
|
||||||
\fBtaler\-exchange\-dbinit\fP(1), \fBtaler\-exchange\-keyup\fP(1), \fBtaler\-exchange\-httpd\fP(1), \fBtaler.conf\fP(5)
|
.Xr taler.conf 5 .
|
||||||
|
.Sh BUGS
|
||||||
|
Report bugs by using
|
||||||
|
.Lk https://gnunet.org/bugs/
|
||||||
|
or by sending electronic mail to
|
||||||
|
.Aq Mt taler@gnu.org .
|
||||||
|
|||||||
@ -1,41 +1,44 @@
|
|||||||
.TH TALER\-EXCHANGE\-BENCHMARK 1 "Jul 25, 2018" "GNU Taler"
|
.Dd July 25, 2018
|
||||||
|
.Dt TALER-EXCHANGE-BENCHMARK 1
|
||||||
.SH NAME
|
.Os
|
||||||
taler\-exchange\-benchmark \- Measure exchange performance.
|
.Sh NAME
|
||||||
|
.Nm taler-exchange-benchmark
|
||||||
.SH SYNOPSIS
|
.Nd
|
||||||
.B taler\-exchange\-benchmark
|
Measure exchange performance
|
||||||
.RI [ options ]
|
.Sh SYNOPSIS
|
||||||
.br
|
.Nm
|
||||||
|
.Op Fl c Ar CONFIG_FILENAME | Fl \-config= Ns Ar CONFIG_FILENAME
|
||||||
.SH DESCRIPTION
|
.Op Fl b Ar BANK_URL | Fl --bank-url= Ns Ar BANK_URL
|
||||||
\fBtaler\-exchange\-benchmark\fP is a command line tool to measure the time spent to serve withdrawals/deposits/refreshes. It usually needs a dedicate configuration file where all the services - the exchange and the (fake)bank - listen to URLs not subject to any reverse proxy, as say Nginx. Moreover, the benchmark runs on a "volatile" database, that means that table are always erased during a single benchmark run.
|
.Op Fl n Ar HOWMANY_COINS | Fl \-coins-number= Ns Ar HOWMANY_COINS
|
||||||
|
.Op Fl l Ar LOGLEVEL | Fl \-log\-level= Ns Ar LOGLEVEL
|
||||||
.SH OPTIONS
|
.Op Fl h | \-help
|
||||||
|
.Sh DESCRIPTION
|
||||||
.B
|
.Nm
|
||||||
.IP "\-c CONFIG_FILENAME, \-\-config=CONFIG_FILENAME"
|
is a command line tool to measure the time spent to serve withdrawals/deposits/refreshes.
|
||||||
|
It usually needs a dedicate configuration file where all the services - the exchange and the (fake)bank - listen to URLs not subject to any reverse proxy, as say Nginx.
|
||||||
|
Moreover, the benchmark runs on a "volatile" database, that means that table are always erased during a single benchmark run.
|
||||||
|
.Bl -tag -width Ds
|
||||||
|
.It Fl c Ar CONFIG_FILENAME | Fl \-config= Ns Ar CONFIG_FILENAME
|
||||||
(Mandatory) Use CONFIG_FILENAME.
|
(Mandatory) Use CONFIG_FILENAME.
|
||||||
|
.It Fl b Ar BANK_URL | Fl --bank-url= Ns Ar BANK_URL
|
||||||
.B
|
(Mandatory) The URL where the fakebank listens at.
|
||||||
.IP "\-b BANK_URL, --bank-url=BANK_URL"
|
Must match the host component in the exchange's escrow account "payto" URL.
|
||||||
(Mandatory) The URL where the fakebank listens at. Must match the host component in the exchange's escrow account "payto" URL.
|
.It Fl n Ar HOWMANY_COINS | Fl \-coins-number= Ns Ar HOWMANY_COINS
|
||||||
|
Defaults to 1.
|
||||||
.B
|
Specifies how many coins this benchmark should withdraw and spend.
|
||||||
.IP "\-n HOWMANY_COINS, \-\-coins-number=HOWMANY_COINS"
|
After being spent, each coin will be refreshed with a REFRESH_PROBABILITY probability, which is (hardcoded as) 0.1; future versions of this tool should offer this parameter as a CLI option.
|
||||||
Defaults to 1. Specifies how many coins this benchmark should withdraw and spend. After being spent, each coin will be refreshed with a REFRESH_PROBABILITY probability, which is (hardcoded as) 0.1; future versions of this tool should offer this parameter as a CLI option.
|
.It Fl l Ar LOGLEVEL | Fl \-log\-level= Ns Ar LOGLEVEL
|
||||||
|
|
||||||
.B
|
|
||||||
.IP "\-l LOGLEVEL, \-\-log\-level=LOGLEVEL"
|
|
||||||
GNUnet-compatible log level, takes values "ERROR/WARNING/INFO/DEBUG"
|
GNUnet-compatible log level, takes values "ERROR/WARNING/INFO/DEBUG"
|
||||||
|
.It Fl h | \-help
|
||||||
.B
|
|
||||||
.IP "\-h, \-\-help"
|
|
||||||
Prints a compiled-in help text.
|
Prints a compiled-in help text.
|
||||||
|
.El
|
||||||
.B
|
.Sh SEE ALSO
|
||||||
.SH BUGS
|
.Xr taler-exchange-dbinit 1 ,
|
||||||
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
|
.Xr taler-exchange-keyup 1 ,
|
||||||
|
.Xr taler-exchange-httpd 1 ,
|
||||||
.SH "SEE ALSO"
|
.Xr taler.conf 5
|
||||||
\fBtaler\-exchange\-dbinit\fP(1), \fBtaler\-exchange\-keyup\fP(1), \fBtaler\-exchange\-httpd\fP(1), \fBtaler.conf\fP(5)
|
.Sh BUGS
|
||||||
|
Report bugs by using
|
||||||
|
.Lk https://gnunet.org/bugs/
|
||||||
|
or by sending electronic mail to
|
||||||
|
.Aq Mt taler@gnu.org .
|
||||||
|
|||||||
472
doc/taler.conf.5
472
doc/taler.conf.5
@ -1,226 +1,248 @@
|
|||||||
.TH TALER.CONF 5 "Mar 20, 2018" "GNU Taler"
|
.\" -*- mode: nroff -*-
|
||||||
|
.Dd March 20, 2018
|
||||||
.SH NAME
|
.Dt TALER.CONF 5
|
||||||
taler.conf \- Taler configuration file.
|
.Os
|
||||||
|
.Sh NAME
|
||||||
.SH SYNOPSIS
|
.Nm taler.conf
|
||||||
.B taler.conf
|
.Nd
|
||||||
|
Taler configuration file.
|
||||||
.SH DESCRIPTION
|
.Sh DESCRIPTION
|
||||||
|
The basic structure of the configuration file is the following.
|
||||||
The basic structure of the configuration file is the following. The file is split into sections. Every section begins with "[SECTIONNAME]" and contains a number of options of the form "OPTION=VALUE". Empty lines and lines beginning with a "#" are treated as comments. Files containing default values for many of the options described below are installed under $TALER\_PREFIX/share/taler/config.d/. The configuration file given with \-c to Taler binaries overrides these defaults.
|
The file is split into sections.
|
||||||
|
Every section begins with "[SECTIONNAME]" and contains a number of options of the form "OPTION=VALUE".
|
||||||
.SH GLOBAL OPTIONS
|
Empty lines and lines beginning with a "#" are treated as comments.
|
||||||
|
Files containing default values for many of the options described below are installed under $TALER\_PREFIX/share/taler/config.d/.
|
||||||
|
The configuration file given with
|
||||||
|
.Fl c
|
||||||
|
to Taler binaries overrides these defaults.
|
||||||
|
.Ss GLOBAL OPTIONS
|
||||||
The following options are from the "[taler]" section and used by virtually all Taler components.
|
The following options are from the "[taler]" section and used by virtually all Taler components.
|
||||||
|
.Bl -tag -width Ds
|
||||||
.IP CURRENCY
|
.It CURRENCY
|
||||||
Name of the currency, i.e. "EUR" for Euro.
|
Name of the currency, i.e. "EUR" for Euro.
|
||||||
|
.El
|
||||||
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:
|
.Pp
|
||||||
|
The "[PATHS]" section is special in that it contains paths that can be referenced using "$" in other configuration values that specify filenames.
|
||||||
.IP TALER_HOME
|
For Taler, it commonly contains the following paths:
|
||||||
Home directory of the user, usually "${HOME}". Can be overwritten by testcases by setting ${TALER_TEST_HOME}.
|
.Bl -tag -width Ds
|
||||||
.IP TALER_DATA_HOME
|
.It TALER_HOME
|
||||||
Where should Taler store its long-term data. Usually "${TALER_HOME}/.local/share/taler/"
|
Home directory of the user, usually "${HOME}".
|
||||||
.IP TALER_CONFIG_HOME
|
Can be overwritten by testcases by setting ${TALER_TEST_HOME}.
|
||||||
Where is the Taler configuration kept. Usually "${TALER_HOME}/.config/taler/"
|
.It TALER_DATA_HOME
|
||||||
.IP TALER_CACHE_HOME
|
Where should Taler store its long-term data. Usually "${TALER_HOME}/.local/share/taler/"
|
||||||
Where should Taler store cached data. Usually "${TALER_HOME}/.cache/taler/"
|
.It TALER_CONFIG_HOME
|
||||||
.IP TALER_RUNTIME_DIR
|
Where is the Taler configuration kept.
|
||||||
Where should Taler store system runtime data (like UNIX domain sockets). Usually "${TMP}/taler-system-runtime".
|
Usually "${TALER_HOME}/.config/taler/"
|
||||||
|
.It TALER_CACHE_HOME
|
||||||
.SH EXCHANGE OPTIONS
|
Where should Taler store cached data.
|
||||||
|
Usually "${TALER_HOME}/.cache/taler/"
|
||||||
The following options are from the "[exchange]" section and used by most exchange tools:
|
.It TALER_RUNTIME_DIR
|
||||||
|
Where should Taler store system runtime data (like UNIX domain sockets).
|
||||||
.IP DB
|
Usually "${TMP}/taler-system-runtime".
|
||||||
Plugin to use for the database, i.e. "postgres"
|
.El
|
||||||
.IP PORT
|
.Ss EXCHANGE OPTIONS
|
||||||
Port on which the HTTP server listens, i.e. 8080.
|
The following options are from the "[exchange]" section and used by most exchange tools.
|
||||||
.IP MASTER_PUBLIC_KEY
|
.Bl -tag -width Ds
|
||||||
Crockford Base32-encoded master public key, public version of the exchange\'s long\-time offline signing key.
|
.It DB
|
||||||
.IP MASTER_PRIV_FILE
|
Plugin to use for the database, i.e. "postgres"
|
||||||
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).
|
.It PORT
|
||||||
.IP BASE_URL
|
Port on which the HTTP server listens, i.e. 8080.
|
||||||
Specifies the base URL under which the exchange can be reached. Added to wire transfers to enable tracking by merchants.
|
.It MASTER_PUBLIC_KEY
|
||||||
.IP SIGNKEY_DURATION
|
Crockford Base32-encoded master public key, public version of the exchange\'s long\-time offline signing key.
|
||||||
For how long is a signing key valid?
|
.It MASTER_PRIV_FILE
|
||||||
.IP LEGAL_DURATION
|
Location of the master private key on disk.
|
||||||
For how long are signatures with signing keys legally valid?
|
Only used by tools that can be run offline (as the master key is for offline signing).
|
||||||
.IP LOOKAHEAD_SIGN
|
.It BASE_URL
|
||||||
How long do we generate denomination and signing keys ahead of time?
|
Specifies the base URL under which the exchange can be reached.
|
||||||
.IP LOOKAHEAD_PROVIDE
|
Added to wire transfers to enable tracking by merchants.
|
||||||
How long into the future do we provide signing and denomination keys to clients?
|
.It SIGNKEY_DURATION
|
||||||
|
For how long is a signing key valid?
|
||||||
|
.It LEGAL_DURATION
|
||||||
|
For how long are signatures with signing keys legally valid?
|
||||||
.SH EXCHANGE POSTGRES BACKEND DATABASE OPTIONS
|
.It LOOKAHEAD_SIGN
|
||||||
|
How long do we generate denomination and signing keys ahead of time?
|
||||||
The following options must be in section "[exchangedb\-postgres]" if the "postgres" plugin was selected for the database:
|
.It LOOKAHEAD_PROVIDE
|
||||||
|
How long into the future do we provide signing and denomination keys to clients?
|
||||||
.IP CONFIG
|
.El
|
||||||
How to access the database, i.e. "postgres:///taler" to use the "taler" database. Testcases use "talercheck".
|
.Ss EXCHANGE POSTGRES BACKEND DATABASE OPTIONS
|
||||||
|
The following options must be in section "[exchangedb\-postgres]" if the "postgres" plugin was selected for the database.
|
||||||
|
.Bl -tag -width Ds
|
||||||
.SH MERCHANT OPTIONS
|
.It CONFIG
|
||||||
|
How to access the database, i.e. "postgres:///taler" to use the "taler" database.
|
||||||
The following options are from the "[merchant]" section and used by the merchant backend:
|
Testcases use "talercheck".
|
||||||
|
.El
|
||||||
.IP DB
|
.Ss MERCHANT OPTIONS
|
||||||
Plugin to use for the database, i.e. "postgres"
|
The following options are from the "[merchant]" section and used by the merchant backend.
|
||||||
.IP PORT
|
.Bl -tag -width Ds
|
||||||
Port on which the HTTP server listens, i.e. 8080.
|
.It DB
|
||||||
.IP WIRE_TRANSFER_DELAY
|
Plugin to use for the database, i.e. "postgres"
|
||||||
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"
|
.It PORT
|
||||||
.IP DEFAULT_MAX_WIRE_FEE
|
Port on which the HTTP server listens, i.e. 8080.
|
||||||
Maximum wire fee we are willing to accept from exchanges. Given as a Taler amount, i.e. "EUR:0.1"
|
.It WIRE_TRANSFER_DELAY
|
||||||
.IP DEFAULT_MAX_DEPOSIT_FEE
|
How quickly do we want the exchange to send us money?
|
||||||
Maximum deposit fee we are willing to cover. Given as a Taler amount, i.e. "EUR:0.1"
|
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"
|
||||||
|
.It DEFAULT_MAX_WIRE_FEE
|
||||||
.SH MERCHANT POSTGRES BACKEND DATABASE OPTIONS
|
Maximum wire fee we are willing to accept from exchanges.
|
||||||
|
Given as a Taler amount, i.e. "EUR:0.1"
|
||||||
The following options must be in section "[merchantdb\-postgres]" if the "postgres" plugin was selected for the database:
|
.It DEFAULT_MAX_DEPOSIT_FEE
|
||||||
|
Maximum deposit fee we are willing to cover.
|
||||||
.IP CONFIG
|
Given as a Taler amount, i.e. "EUR:0.1"
|
||||||
How to access the database, i.e. "postgres:///taler" to use the "taler" database. Testcases use "talercheck".
|
.El
|
||||||
|
.Ss MERCHANT POSTGRES BACKEND DATABASE OPTIONS
|
||||||
.SH MERCHANT INSTANCES
|
The following options must be in section "[merchantdb\-postgres]" if the "postgres" plugin was selected for the database.
|
||||||
|
.Bl -tag -width Ds
|
||||||
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:
|
.It CONFIG
|
||||||
|
How to access the database, i.e. "postgres:///taler" to use the "taler" database.
|
||||||
.IP KEYFILE
|
Testcases use "talercheck".
|
||||||
Name of the file where the instance\'s private key is to be stored, i.e. "${TALER_CONFIG_HOME}/merchant/instance/name.priv"
|
.El
|
||||||
.IP NAME
|
.Ss MERCHANT INSTANCES
|
||||||
Human-readable name of the instance, i.e. "Kudos Inc."
|
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.
|
||||||
Additionally, for instances that support tipping, the following options are required:
|
.Bl -tag -width Ds
|
||||||
|
.It KEYFILE
|
||||||
.IP TIP_EXCHANGE
|
Name of the file where the instance\'s private key is to be stored, i.e. "${TALER_CONFIG_HOME}/merchant/instance/name.priv"
|
||||||
Base-URL of the exchange that holds the reserve for tipping, i.e. "https://exchange.demo.taler.net/"
|
.It NAME
|
||||||
.IP TIP_EXCHANGE_PRIV_FILENAME
|
Human-readable name of the instance, i.e. "Kudos Inc."
|
||||||
Filename with the private key granting access to the reserve, i.e. "${TALER_CONFIG_HOME}/merchant/reserve/tip.priv"
|
.El
|
||||||
|
Additionally, for instances that support tipping, the following options are required.
|
||||||
|
.Bl -tag -width Ds
|
||||||
.SH KNOWN EXCHANGES (for merchants and wallets)
|
.It TIP_EXCHANGE
|
||||||
|
Base-URL of the exchange that holds the reserve for tipping, i.e. "https://exchange.demo.taler.net/"
|
||||||
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:
|
.It TIP_EXCHANGE_PRIV_FILENAME
|
||||||
|
Filename with the private key granting access to the reserve, i.e. "${TALER_CONFIG_HOME}/merchant/reserve/tip.priv"
|
||||||
.IP BASE_URL
|
.El
|
||||||
Base URL of the exchange, i.e. "https://exchange.demo.taler.net/"
|
.Ss KNOWN EXCHANGES (for merchants and wallets)
|
||||||
.IP MASTER_KEY
|
The merchant configuration can include a list of known exchanges if the merchant wants to specify that certain exchanges are explicitly trusted.
|
||||||
Crockford Base32 encoded master public key, public version of the exchange\'s long\-time offline signing key
|
For each trusted exchange, a section [exchange-NAME] must exist, where NAME is a merchant-given name for the exchange.
|
||||||
.IP CURRENCY
|
The following options must be given in each "[exchange-NAME]" section.
|
||||||
Name of the currency for which this exchange is trusted, i.e. "KUDOS"
|
.Bl -tag -width Ds
|
||||||
|
.It BASE_URL
|
||||||
|
Base URL of the exchange, i.e. "https://exchange.demo.taler.net/"
|
||||||
.SH KNOWN AUDITORS (for merchants and wallets)
|
.It MASTER_KEY
|
||||||
|
Crockford Base32 encoded master public key, public version of the exchange\'s long\-time offline signing key
|
||||||
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:
|
.It CURRENCY
|
||||||
|
Name of the currency for which this exchange is trusted, i.e. "KUDOS"
|
||||||
.IP BASE_URL
|
.El
|
||||||
Base URL of the auditor, i.e. "https://auditor.demo.taler.net/"
|
.Ss KNOWN AUDITORS (for merchants and wallets)
|
||||||
.IP AUDITOR_KEY
|
The merchant configuration can include a list of known exchanges if the merchant wants to specify that certain auditors are explicitly trusted.
|
||||||
Crockford Base32 encoded auditor public key.
|
For each trusted exchange, a section [auditor-NAME] must exist, where NAME is a merchant-given name for the exchange.
|
||||||
.IP CURRENCY
|
The following options must be given in each "[auditor-NAME]" section.
|
||||||
Name of the currency for which this auditor is trusted, i.e. "KUDOS"
|
.Bl -tag -width Ds
|
||||||
|
.It BASE_URL
|
||||||
|
Base URL of the auditor, i.e. "https://auditor.demo.taler.net/"
|
||||||
|
.It AUDITOR_KEY
|
||||||
.SH ACCOUNT OPTIONS (for exchanges and merchants)
|
Crockford Base32 encoded auditor public key.
|
||||||
|
.It CURRENCY
|
||||||
An exchange (or merchant) can have multiple bank accounts. The following options are for sections named "[account-SOMETHING]". The SOMETHING is arbitrary and should be chosen to uniquely identify the bank account for the operator. Additional authentication options may need to be specified in the account section depending on the PLUGIN used.
|
Name of the currency for which this auditor is trusted, i.e. "KUDOS"
|
||||||
|
.El
|
||||||
.IP URL
|
.Ss ACCOUNT OPTIONS (for exchanges and merchants)
|
||||||
Specifies the payto://-URL of the account. The general format is payto://METHOD/DETAILS. This option is used for exchanges and merchants.
|
An exchange (or merchant) can have multiple bank accounts.
|
||||||
.IP WIRE_RESPONSE
|
The following options are for sections named "[account-SOMETHING]".
|
||||||
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 and the taler\-merchant\-httpd (to generate the files).
|
The SOMETHING is arbitrary and should be chosen to uniquely identify the bank account for the operator.
|
||||||
.IP PLUGIN
|
Additional authentication options may need to be specified in the account section depending on the PLUGIN used.
|
||||||
Name of the plugin can be used to access the account (i.e. "taler-bank" or "ebics"). Used by the merchant backend for back office operations (i.e. to identify incoming wire transfers) and by the exchange.
|
.Bl -tag -width Ds
|
||||||
.IP ENABLE_DEBIT
|
.It URL
|
||||||
Must be set to YES for the accounts that the taler\-exchange\-aggregator should debit. Not used by merchants.
|
Specifies the payto://-URL of the account.
|
||||||
.IP ENABLE_CREDIT
|
The general format is payto://METHOD/DETAILS.
|
||||||
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.)
|
This option is used for exchanges and merchants.
|
||||||
.IP HONOR_instance
|
.It WIRE_RESPONSE
|
||||||
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.
|
Specifies the name of the file in which the /wire response for this account should be located.
|
||||||
.IP ACTIVE_instance
|
Used by the Taler exchange service and the taler\-exchange\-wire tool and the taler\-merchant\-httpd (to generate the files).
|
||||||
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 ENABLE_instance to YES.
|
.It PLUGIN
|
||||||
|
Name of the plugin can be used to access the account (i.e. "taler-bank" or "ebics").
|
||||||
|
Used by the merchant backend for back office operations (i.e. to identify incoming wire transfers) and by the exchange.
|
||||||
.SH TALER-BANK AUTHENTICATION OPTIONS (for accounts)
|
.It ENABLE_DEBIT
|
||||||
|
Must be set to YES for the accounts that the taler\-exchange\-aggregator should debit.
|
||||||
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.
|
Not used by merchants.
|
||||||
|
.It ENABLE_CREDIT
|
||||||
.IP TALER_BANK_AUTH_METHOD
|
Must be set to YES for the accounts that the taler\-exchange\-wirewatch should check for credits.
|
||||||
Authentication method to use. "none" or "basic" are currently supported.
|
It is yet uncertain if the merchant implementation may check this flag as well.
|
||||||
.IP USERNAME
|
.It HONOR_instance
|
||||||
Username to use for authentication. Used with the "basic" authentication method.
|
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.
|
||||||
.IP PASSWORD
|
.It ACTIVE_instance
|
||||||
Password to use for authentication. Used with the "basic" authentication method.
|
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 ENABLE_instance to YES.
|
||||||
.SH EBICS AUTHENTICATION OPTIONS
|
.El
|
||||||
|
.Ss TALER-BANK AUTHENTICATION OPTIONS (for accounts)
|
||||||
The following authentication options are supported by the "ebics" wire plugin. They must be specified in the "[account-]" section that uses the "ebics" plugin.
|
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.
|
||||||
.IP NONE
|
.Bl -tag -width Ds
|
||||||
Currently the "ebics" implementation is incomplete and does not support authentication.
|
.It TALER_BANK_AUTH_METHOD
|
||||||
|
Authentication method to use.
|
||||||
|
"none" or "basic" are currently supported.
|
||||||
.SH EXCHANGE WIRE FEE OPTIONS
|
.It USERNAME
|
||||||
|
Username to use for authentication.
|
||||||
For each supported wire method (i.e. "x-taler-bank" or "sepa"), sections 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 in advance.
|
Used with the "basic" authentication method.
|
||||||
|
.It PASSWORD
|
||||||
.IP WIRE-FEE-YEAR
|
Password to use for authentication.
|
||||||
Aggregate wire transfer fee merchants are charged in YEAR. Specified as a Taler amount using the usual amount syntax (CURRENCY:VALUE.FRACTION).
|
Used with the "basic" authentication method.
|
||||||
.IP CLOSING-FEE-YEAR
|
.Ss EBICS AUTHENTICATION OPTIONS
|
||||||
Reserve closing fee customers are charged in YEAR. Specified as a Taler amount using the usual amount syntax (CURRENCY:VALUE.FRACTION).
|
The following authentication options are supported by the "ebics" wire plugin.
|
||||||
|
They must be specified in the "[account-]" section that uses the "ebics" plugin.
|
||||||
|
.Bl -tag -width Ds
|
||||||
.SH EXCHANGE COIN OPTIONS
|
.It NONE
|
||||||
|
Currently the "ebics" implementation is incomplete and does not support authentication.
|
||||||
The following options must be in sections starting with "[coin_]" and are used by taler\-exchange\-keyup to create denomination keys:
|
.El
|
||||||
|
.Ss EXCHANGE WIRE FEE OPTIONS
|
||||||
.IP VALUE
|
For each supported wire method (i.e. "x-taler-bank" or "sepa"), sections named "[fees-METHOD]" state the (aggregate) wire transfer fee and the reserve closing fees charged by the exchange.
|
||||||
Value of the coin, i.e. "EUR:1.50" for 1 Euro and 50 Cents (per coin).
|
Note that fees are specified using the name of the wire method, not by the plugin name.
|
||||||
.IP DURATION_OVERLAP
|
You need to replace "YEAR" in the option name by the calendar year for which the fee should apply.
|
||||||
How much should validity periods for these coins overlap?
|
Usually, fees should be given for serveral years in advance.
|
||||||
.IP DURATION_WITHDRAW
|
.Bl -tag -width Ds
|
||||||
How long should the same key be used for clients to withdraw coins of this value?
|
.It WIRE-FEE-YEAR
|
||||||
.IP DURATION_SPEND
|
Aggregate wire transfer fee merchants are charged in YEAR.
|
||||||
How long do clients have to spend these coins?
|
Specified as a Taler amount using the usual amount syntax (CURRENCY:VALUE.FRACTION).
|
||||||
.IP FEE_WITHDRAW
|
.It CLOSING-FEE-YEAR
|
||||||
What fee is charged for withdrawl?
|
Reserve closing fee customers are charged in YEAR.
|
||||||
.IP FEE_DEPOSIT
|
Specified as a Taler amount using the usual amount syntax (CURRENCY:VALUE.FRACTION).
|
||||||
What fee is charged for depositing?
|
.El
|
||||||
.IP FEE_REFRESH
|
.Ss EXCHANGE COIN OPTIONS
|
||||||
What fee is charged for refreshing?
|
The following options must be in sections starting with "[coin_]" and are used by taler\-exchange\-keyup to create denomination keys.
|
||||||
.IP FEE_REFUND
|
.Bl -tag -width Ds
|
||||||
What fee is charged for refunds? When a coin is refunded, the deposit fee is returned. Instead, the refund fee is charged to the customer.
|
.It VALUE
|
||||||
.IP RSA_KEYSIZE
|
Value of the coin, i.e. "EUR:1.50" for 1 Euro and 50 Cents (per coin).
|
||||||
What is the RSA keysize modulos (in bits)?
|
.It DURATION_OVERLAP
|
||||||
|
How much should validity periods for these coins overlap?
|
||||||
|
.It DURATION_WITHDRAW
|
||||||
.SH AUDITOR OPTIONS
|
How long should the same key be used for clients to withdraw coins of this value?
|
||||||
|
.It DURATION_SPEND
|
||||||
The following options must be in section "[auditor]" for the Taler auditor:
|
How long do clients have to spend these coins?
|
||||||
|
.It FEE_WITHDRAW
|
||||||
.IP DB
|
What fee is charged for withdrawl?
|
||||||
Plugin to use for the database, i.e. "postgres"
|
.It FEE_DEPOSIT
|
||||||
.IP AUDITOR_PRIV_FILE
|
What fee is charged for depositing?
|
||||||
Name of the file containing the auditor's private key
|
.It FEE_REFRESH
|
||||||
|
What fee is charged for refreshing?
|
||||||
|
.It FEE_REFUND
|
||||||
.SH AUDITOR POSTGRES BACKEND DATABASE OPTIONS
|
What fee is charged for refunds?
|
||||||
|
When a coin is refunded, the deposit fee is returned.
|
||||||
The following options must be in section "[auditordb\-postgres]" if the "postgres" plugin was selected for the database:
|
Instead, the refund fee is charged to the customer.
|
||||||
|
.It RSA_KEYSIZE
|
||||||
.IP CONFIG
|
What is the RSA keysize modulos (in bits)?
|
||||||
How to access the database, i.e. "postgres:///taler" to use the "taler" database. Testcases use "talercheck".
|
.El
|
||||||
|
.Ss AUDITOR OPTIONS
|
||||||
|
The following options must be in section "[auditor]" for the Taler auditor.
|
||||||
.SH BUGS
|
.Bl -tag -width Ds
|
||||||
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <taler@gnu.org>
|
.It DB
|
||||||
|
Plugin to use for the database, i.e. "postgres"
|
||||||
.SH "SEE ALSO"
|
.It AUDITOR_PRIV_FILE
|
||||||
\fBtaler\-exchange\-httpd\fP(1), \fBtaler\-exchange\-keyup\fP(1), \fBtaler\-exchange\-dbinit\fP(1), \fBtaler\-exchange\-wire(1)
|
Name of the file containing the auditor's private key
|
||||||
|
.El
|
||||||
|
.Ss AUDITOR POSTGRES BACKEND DATABASE OPTIONS
|
||||||
|
The following options must be in section "[auditordb\-postgres]" if the "postgres" plugin was selected for the database.
|
||||||
|
.Bl -tag -width Ds
|
||||||
|
.It CONFIG
|
||||||
|
How to access the database, i.e. "postgres:///taler" to use the "taler" database.
|
||||||
|
Testcases use "talercheck".
|
||||||
|
.El
|
||||||
|
.Sh SEE ALSO
|
||||||
|
.Xr taler-exchange-dbinit 1 ,
|
||||||
|
.Xr taler-exchange-httpd 1 ,
|
||||||
|
.Xr taler-exchange-keyup 1 ,
|
||||||
|
.Xr taler-exchange-wire 1 .
|
||||||
|
.Sh BUGS
|
||||||
|
Report bugs by using
|
||||||
|
.Lk https://gnunet.org/bugs/
|
||||||
|
or by sending electronic mail to
|
||||||
|
.Aq Mt taler@gnu.org .
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user