diff options
Diffstat (limited to 'man/taler.conf.5')
| -rw-r--r-- | man/taler.conf.5 | 97 |
1 files changed, 78 insertions, 19 deletions
diff --git a/man/taler.conf.5 b/man/taler.conf.5 index eb541d7f..12a4e553 100644 --- a/man/taler.conf.5 +++ b/man/taler.conf.5 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "TALER.CONF" "5" "Sep 24, 2023" "0.9" "GNU Taler" +.TH "TALER.CONF" "5" "Nov 27, 2023" "0.9" "GNU Taler" .SH NAME taler.conf \- Taler configuration file .SH DESCRIPTION @@ -44,7 +44,7 @@ whitespace around the \fB=\fP (equal sign). Section names and options are .sp The values, however, are \fIcase\-sensitive\fP\&. In particular, boolean values are one of \fBYES\fP or \fBNO\fP\&. Values can include whitespace by surrounding the -entire value with \fB\(dq\fP (double quote). Note, however, that there are no +entire value with \fB"\fP (double quote). Note, however, that there are no escape characters in such strings; all characters between the double quotes (including other double quotes) are taken verbatim. .sp @@ -121,7 +121,8 @@ comments from the configuration file! .SS GLOBAL OPTIONS .sp The following options are from the “[taler]” section and used by -virtually all Taler components. +virtually all Taler components. Note: work is ongoing to obsolete +these options, but for now they are in use. .INDENT 0.0 .TP .B CURRENCY @@ -157,6 +158,60 @@ Usually “${TALER_HOME}/.cache/taler/”. Where should Taler store system runtime data (like UNIX domain sockets). Usually “${TMP}/taler\-system\-runtime”. .UNINDENT +.SS CURRENCY SPECIFICATIONS +.sp +Sections with a name of the form “[currency\-$NAME]” (where “$NAME” could +be any unique string) are used to specify details about how currencies +should be handled (and in particularly rendered) by the user interface. +A detailed motivation for this section can be found in DD51. +Different components can have different rules for the same currency. For +example, a bank or merchant may decide to render Euros or Dollars with +always exactly two fractional decimals, while an Exchange for the same +currency may support additional decimals. The required options in each +currency specification section are: +.INDENT 0.0 +.TP +.B ENABLED +Set to YES or NO. If set to NO, the currency specification +section is ignored. Can be used to disable currencies or +select alternative sections for the same CODE with different +choices. +.TP +.B CODE +Code name for the currency. Can be at most 11 characters, +only the letters A\-Z are allowed. Primary way to identify +the currency in the protocol. +.TP +.B NAME +Long human\-readable name for the currency. No restrictions, +but should match the official name in English. +.TP +.B FRACTIONAL_INPUT_DIGITS +Number of fractional digits that users are allowed to enter +manually in the user interface. +.TP +.B FRACTIONAL_NORMAL_DIGITS +Number of fractional digits that will be rendered normally +(in terms of size and placement). Digits shown beyond this +number will typically be rendered smaller and raised (if +possible). +.TP +.B FRACTIONAL_TRAILING_ZERO_DIGITS +Number of fractional digits to pad rendered amounts with +even if these digits are all zero. For example, use 2 to +render 1 USD as $1.00. +.TP +.B ALT_UNIT_NAMES +JSON map determining how to encode very large or very tiny +amounts in this currency. Maps a base10 logarithm to the +respective currency symbol. Must include at least an +entry for 0 (currency unit). For example, use +{“0”:”€”} for Euros or “{“0”:”$”} for Dollars. You could +additionally use {“0”:”€”,”3”:”k€”} to render 3000 EUR +as 3k€. For BTC a typical map would be +{“0”:”BTC”,”\-3”:”mBTC”}, informing the UI to render small +amounts in milli\-Bitcoin (mBTC). +.UNINDENT .SS EXCHANGE OPTIONS .sp The following options are from the “[exchange]” section and used by most @@ -199,25 +254,20 @@ that rewards are allowed. The option merely announces that rewards is enabled or disabled, and protocol\-compliant merchant backends will then enable or disable the feature accordingly. .TP -.B CURRENCY_FRACTION_DIGITS -How many digits should amounts be rendered -with by default. Small capitals should -be used to render fractions beyond the number -given here (like on gas stations). Defaults to 0. -For EUR and USD, the value would be 2, while for -JPY it would be 0. -.TP .B STEFAN_ABS -Absolte amount to use in the STEFAN fee approximation -curve (see DD47). Defaults to 0 if not specified. +Absolte amount to add as an offset in the STEFAN fee approximation +curve (see DD47). Defaults to CURRENCY:0 if not specified. .TP .B STEFAN_LOG -Logarithmic factor to use in the STEFAN fee approximation -curve (see DD47). Defaults to 0 if not specified. +Amount to multiply by the base\-2 logarithm of the total amount +divided by the amount of the smallest denomination +in the STEFAN fee approximation curve (see DD47). +Defaults to CURRENCY:0 if not specified. .TP .B STEFAN_LIN -Linear factor to use in the STEFAN fee approximation -curve (see DD47). Defaults to 0 if not specified. +Linear floating point factor to be multiplied by the total amount +to use in the STEFAN fee approximation curve (see DD47). +Defaults to 0.0 if not specified. .TP .B BASE_URL The base URL under which the exchange can be reached. @@ -319,7 +369,7 @@ The following options must be in the section “[kyc\-provider\-XXX]” sections Duration (e.g. “12 months”) of the validity of the performed KYC check. Can be “forever”. .TP .B KYC_OAUTH2_AUTHORIZE_URL -URL of the OAuth2 endpoint to be used for KYC checks. The authorize URL is where the exchange will redirect the client to begin the authorization process. Example: “\fI\%http://localhost:8888/oauth/v2/authorize\fP”. To use the plugin in combination with the Challenger service’s \fB/setup\fP step, append “#setup”, thus “\fI\%https://challenger.example.com/authorize#setup\fP”. Here, “#setup” is not a fragment but merely a hint to the logic to determine the full authorization URL via the \fB/setup\fP handler. +URL of the OAuth2 endpoint to be used for KYC checks. The authorize URL is where the exchange will redirect the client to begin the authorization process. Example: “\fI\%http://localhost:8888/oauth/v2/authorize\fP”. To use the plugin in combination with the Challenger service’s \fB/setup\fP step, append “#setup”, thus “\fI\%https://challenger.example.com/authorize#setup\fP”. Here, “#setup” is not a fragment but merely a hint to the logic to determine the full authorization URL via the \fB/setup/$CLIENT_ID\fP handler. .TP .B KYC_OAUTH2_TOKEN_URL URL of the OAuth2 endpoint to be used for KYC checks. This is where the server will ultimately send the authorization token from the client and obtain its access token (which currently must be a “bearer” token). Example: “\fI\%http://localhost:8888/oauth/v2/token\fP” (or just “/token”) @@ -335,6 +385,9 @@ Client secret of the exchange to use when talking to the KYC Oauth2 endpoint. .TP .B KYC_OAUTH2_POST_URL URL to which the exchange will redirect the client’s browser after successful authorization/login for the KYC process. Example: “\fI\%http://example.com/thank\-you\fP” +.TP +.B KYC_OAUTH2_CONVERTER_HELPER +Helper to convert JSON with KYC data returned by the OAuth2.0 info endpoint into GNU Taler internal format. Specific to the OAuth 2.0 provider. .UNINDENT .SS EXCHANGE KYC KYCAID OPTIONS .sp @@ -621,7 +674,7 @@ Password for \fBbasic\fP authentication with the wire gateway. .UNINDENT .SS EXCHANGE COIN OPTIONS .sp -The following options must be in sections starting with \fB\(dq[coin_]\(dq\fP and are +The following options must be in sections starting with \fB"[coin_]"\fP and are largely used by \fBtaler\-exchange\-httpd\fP to determine the meta data for the denomination keys. Some of the options are used by the \fBtaler\-exchange\-secmod\-rsa\fP to determine which RSA keys to create (and of @@ -684,6 +737,9 @@ Plugin to use for the database, e.g._“postgres”. .B SERVE Should the HTTP server listen on a UNIX domain socket (set option to “unix”) or on a TCP socket (set option to “tcp”)? .TP +.B BASE_URL +Which base URL should the merchant backend assume for itself in the protocol. Optional. If not given, the base URL will be constructed from X\-Forwarded\-Host, X\-Forwarded\-Port and X\-Forwarded\-Prefix headers that a reverse\-proxy should be setting. +.TP .B UNIXPATH Path to listen on if we “SERVE” is set to “unix”. .TP @@ -741,6 +797,9 @@ required by a client. Name of the currency for which this exchange is used, e.g.\ “KUDOS”. The entire section is ignored if the currency does not match the currency we use, which must be given in the \fB[taler]\fP section. +.TP +.B DISABLED +Set to YES to disable this exchange. Optional option, defaults to NO. .UNINDENT .SS AUDITOR OPTIONS .sp |