diff options
Diffstat (limited to 'man/taler.conf.5')
-rw-r--r-- | man/taler.conf.5 | 60 |
1 files changed, 30 insertions, 30 deletions
diff --git a/man/taler.conf.5 b/man/taler.conf.5 index 7fa821a2..f26239ba 100644 --- a/man/taler.conf.5 +++ b/man/taler.conf.5 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER.CONF" "5" "Jun 20, 2022" "0.9" "GNU Taler" +.TH "TALER.CONF" "5" "Jul 06, 2022" "0.9" "GNU Taler" .SH NAME taler.conf \- Taler configuration file . @@ -126,7 +126,7 @@ Port on which the HTTP server listens, e.g.\ 8080. .TP .B MASTER_PUBLIC_KEY Crockford Base32\-encoded master public key, public version of the -exchange\(aqs long\-time offline signing key. +exchange’s long\-time offline signing key. .TP .B MASTER_PRIV_FILE Location of the master private key on disk. Only used by tools that @@ -154,7 +154,7 @@ For how long should the taler\-exchange\-wirewatch sleep when it is idle before trying to look for more work? Default is 60 seconds. .TP .B AGGREGATOR_SHARD_SIZE -Which share of the range from [0,..2147483648] should be processed by one of the shards of the aggregator. Useful only for Taler exchanges with ultra high\-performance needs. When changing this value, you must stop all aggregators and run "taler\-exchange\-dbinit \-s" before resuming. Default is 2147483648 (no sharding). +Which share of the range from [0,..2147483648] should be processed by one of the shards of the aggregator. Useful only for Taler exchanges with ultra high\-performance needs. When changing this value, you must stop all aggregators and run “taler\-exchange\-dbinit \-s” before resuming. Default is 2147483648 (no sharding). .TP .B SIGNKEY_LEGAL_DURATION For how long are signatures with signing keys legally valid? @@ -168,12 +168,12 @@ How many requests should the HTTP server process at most before committing suici .B 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, e.g. "en/" or "fr/". +using the two\-character language code in lower case, e.g. “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 \fBTERMS_ETAG\fP\&. The extension defines the mime type. -Supported extensions include "html", "htm", "txt", "pdf", "jpg", "jpeg", -"png" and "gif". For example, using a \fBTERMS_ETAG\fP of "0", the structure +Supported extensions include “html”, “htm”, “txt”, “pdf”, “jpg”, “jpeg”, +“png” and “gif”. For example, using a \fBTERMS_ETAG\fP of “0”, the structure could be the following: .INDENT 7.0 .IP \(bu 2 @@ -192,7 +192,7 @@ $TERMS_DIR/de/0.txt .TP .B TERMS_ETAG Basename of the file(s) in the \fBTERMS_DIR\fP with the current terms of service. -The value is also used for the "Etag" in the HTTP request to control +The value is also used for the “Etag” in the HTTP request to control caching. Whenever the terms of service change, the \fBTERMS_ETAG\fP 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 @@ -207,18 +207,18 @@ Works the same as \fBTERMS_DIR\fP, just for the privacy policy. Works the same as \fBTERMS_ETAG\fP, just for the privacy policy. .TP .B KYC_MODE -Set to "NONE" to disable KYC for this exchange (but check with your lawyer first). -Set to "OAUTH2" to use OAuth2 for KYC. +Set to “NONE” to disable KYC for this exchange (but check with your lawyer first). +Set to “OAUTH2” to use OAuth2 for KYC. .TP .B KYC_WITHDRAW_LIMIT Maximum amount that can be withdrawn in KYC_WITHDRAW_PERIOD without needing KYC. -Only used if KYC_MODE is not "NONE". +Only used if KYC_MODE is not “NONE”. .TP .B KYC_WITHDRAW_PERIOD The time period over which transactions are considered for the KYC_WITHDRAW_LIMIT. -Only used if KYC_MODE is not "NONE". +Only used if KYC_MODE is not “NONE”. .TP .B KYC_WALLET_BALANCE_LIMIT Maximum amount that a wallet is allowed to hold without @@ -228,30 +228,30 @@ is no limit. .UNINDENT .SS EXCHANGE KYC OAUTH2 OPTIONS .sp -The following options must be in the section "[exchange\-kyc\-oauth2]". +The following options must be in the section “[exchange\-kyc\-oauth2]”. .INDENT 0.0 .TP .B KYC_OAUTH2_AUTH_URL -URL of the OAuth2 endpoint to be used for KYC checks. Requires KYC_ENABLED to be "OAUTH2". Example: "\fI\%http://localhost:8888/oauth/v2/login\fP" (or "/token") +URL of the OAuth2 endpoint to be used for KYC checks. Requires KYC_ENABLED to be “OAUTH2”. Example: “\fI\%http://localhost:8888/oauth/v2/login\fP” (or “/token”) .TP .B KYC_OAUTH2_LOGIN_URL -URL of the OAuth2 endpoint to be used for KYC checks. Requires KYC_ENABLED to be "OAUTH2". Example: "\fI\%http://localhost:8888/oauth/v2/login\fP" +URL of the OAuth2 endpoint to be used for KYC checks. Requires KYC_ENABLED to be “OAUTH2”. Example: “\fI\%http://localhost:8888/oauth/v2/login\fP” .TP .B KYC_INFO_URL -URL of the endpoint where the OAuth 2.0 token can be used to download the user\(aqs details. Requires KYC_ENABLED to be "OAUTH2". Example: "\fI\%http://localhost:8888/api/user/me\fP" +URL of the endpoint where the OAuth 2.0 token can be used to download the user’s details. Requires KYC_ENABLED to be “OAUTH2”. Example: “\fI\%http://localhost:8888/api/user/me\fP” .TP .B KYC_OAUTH2_CLIENT_ID -Client ID of the exchange when it talks to the KYC OAuth2 endpoint. Requires KYC_ENABLED to be "OAUTH2". +Client ID of the exchange when it talks to the KYC OAuth2 endpoint. Requires KYC_ENABLED to be “OAUTH2”. .TP .B KYC_OAUTH2_CLIENT_SECRET -Client secret of the exchange to use when talking to the KYC Oauth2 endpoint. Requires KYC_ENABLED to be "OAUTH2". +Client secret of the exchange to use when talking to the KYC Oauth2 endpoint. Requires KYC_ENABLED to be “OAUTH2”. .TP .B KYC_OAUTH2_POST_URL -URL to which the exchange will redirect the client\(aqs browser after successful authorization/login for the KYC process. +URL to which the exchange will redirect the client’s browser after successful authorization/login for the KYC process. .UNINDENT .SS EXCHANGE OFFLINE SIGNING OPTIONS .sp -The following options must be in the section "[exchange\-offline]". +The following options must be in the section “[exchange\-offline]”. .INDENT 0.0 .TP .B MASTER_PRIV_FILE @@ -277,7 +277,7 @@ this option will also be ignored. .UNINDENT .SS EXCHANGE RSA CRYPTO HELPER OPTIONS .sp -The following options must be in the section "[taler\-exchange\-secmod\-rsa]". +The following options must be in the section “[taler\-exchange\-secmod\-rsa]”. .INDENT 0.0 .TP .B LOOKAHEAD_SIGN @@ -304,7 +304,7 @@ Note that the \fBtaler\-exchange\-secmod\-rsa\fP also evaluates the \fB[coin_*]\ configuration sections described below. .SS EXCHANGE CS CRYPTO HELPER OPTIONS .sp -The following options must be in the section "[taler\-exchange\-secmod\-cs]". +The following options must be in the section “[taler\-exchange\-secmod\-cs]”. .INDENT 0.0 .TP .B LOOKAHEAD_SIGN @@ -331,7 +331,7 @@ Note that the \fBtaler\-exchange\-secmod\-cs\fP also evaluates the \fB[coin_*]\f configuration sections described below. .SS EXCHANGE EDDSA CRYPTO HELPER OPTIONS .sp -The following options must be in the section "[taler\-exchange\-secmod\-eddsa]". +The following options must be in the section “[taler\-exchange\-secmod\-eddsa]”. .INDENT 0.0 .TP .B LOOKAHEAD_SIGN @@ -358,7 +358,7 @@ On which path should the security module listen for signing requests? .UNINDENT .SS EXCHANGE DATABASE OPTIONS .sp -The following options must be in the section "[exchangedb]". +The following options must be in the section “[exchangedb]”. .INDENT 0.0 .TP .B IDLE_RESERVE_EXPIRATION_TIME @@ -415,7 +415,7 @@ URL of the wire gateway. Typically of the form \fBhttps://$HOSTNAME[:$PORT]/taler\-wire\-gateway/$USERNAME/\fP where $HOSTNAME is the hostname of the system running the bank (such as the Taler Python bank or the Nexus) and \fB$USERNAME\fP is -the username of the exchange\(aqs bank account (usually matching +the username of the exchange’s bank account (usually matching the \fBUSERNAME\fP option used for authentication). Example: \fBhttps://bank.demo.taler.net/taler\-wire\-gateway/Exchange/\fP\&. .TP @@ -470,12 +470,12 @@ 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. .TP .B CIPHER -What cryptosystem should be used? Must be set to either "CS" or "RSA". +What cryptosystem should be used? Must be set to either “CS” or “RSA”. The respective crypto\-helper will then generate the keys for this denomination. .TP .B RSA_KEYSIZE -What is the RSA keysize modulos (in bits)? Only used if "CIPHER=RSA". +What is the RSA keysize modulos (in bits)? Only used if “CIPHER=RSA”. .UNINDENT .SS MERCHANT OPTIONS .sp @@ -522,7 +522,7 @@ Base URL of the exchange, e.g.\ “\fI\%https://exchange.demo.taler.net/\fP” .TP .B MASTER_KEY Crockford Base32 encoded master public key, public version of the -exchange\(aqs long\-time offline signing key. Can be omitted, in that +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 \fBMASTER_KEY\fP can be useful if we do not trust the exchange @@ -581,12 +581,12 @@ The following options must be in section “[auditordb\-postgres]” if the .INDENT 0.0 .TP .B CONFIG -How to access the database, e.g.\ "postgres:///taler" to use the -"taler" database. Testcases use “talercheck”. +How to access the database, e.g.\ “postgres:///taler” to use the +“taler” database. Testcases use “talercheck”. .UNINDENT .SS Bank Options .sp -The following options must be in section "[bank]" for the taler\-fakebank\-run(1) command. They are not used by the exchange or LibEuFin! +The following options must be in section “[bank]” for the taler\-fakebank\-run(1) command. They are not used by the exchange or LibEuFin! .INDENT 0.0 .TP .B HTTP_PORT |