diff options
45 files changed, 656 insertions, 52 deletions
diff --git a/man/challenger-config.1 b/man/challenger-config.1 new file mode 100644 index 00000000..71361f60 --- /dev/null +++ b/man/challenger-config.1 @@ -0,0 +1,123 @@ +.\" Man page generated from reStructuredText. +. +.TH "CHALLENGER-CONFIG" "1" "Apr 16, 2023" "0.9" "GNU Taler" +.SH NAME +challenger-config \- manipulate Challenger configuration files +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +\fBchallenger\-config\fP +[\fB\-b\fP\ \fIbackend\fP\ |\ \fB\-\-supported\-backend=\fP\fIbackend\fP] +[\fB\-c\fP\ \fIfilename\fP\ |\ \fB\-\-config=\fP\fIfilename\fP] +[\fB\-f\fP\ |\ \fB\-\-filename\fP] +[\fB\-F\fP\ |\ \fB\-\-full\fP] +[\fB\-h\fP\ |\ \fB\-\-help\fP] +[\fB\-L\fP\ \fIloglevel\fP\ |\ \fB\-\-loglevel=\fP\fIloglevel\fP] +[\fB\-l\fP\ \fIfilename\fP\ |\ \fB\-\-logfile=\fP\fIfilename\fP] +[\fB\-o\fP\ \fIoption\fP\ |\ \fB\-\-option=\fP\fIoption\fP] +[\fB\-r\fP\ |\ \fB\-\-rewrite\fP] +[\fB\-S\fP\ |\ \fB\-\-list\-sections\fP] +[\fB\-s\fP\ \fIsection\fP\ |\ \fB\-\-section=\fP\fIsection\fP] +[\fB\-V\fP\ \fIvalue\fP\ |\ \fB\-\-value=\fP\fIvalue\fP] +[\fB\-v\fP\ |\ \fB\-\-version\fP] +.SH DESCRIPTION +.sp +\fBchallenger\-config\fP can be used to read or modify Challenger configuration files. +.INDENT 0.0 +.TP +\fB\-b\fP \fIBACKEND\fP | \fB\-\-supported\-backend=\fP\fIBACKEND\fP +Tests whether the specified \fIBACKEND\fP is supported by the current installation. +The backend must match the name of a plugin, i.e. "namestore_postgres" for +the PostgreSQL database backend of the "NAMESTORE" service. If \fIBACKEND\fP is +supported, challenger\-config will return a status code of 0 (success), otherwise +77 (unsupported). When this option is specified, no other options may be +specified. Specifying this option together with other options will cause +challenger\-config to return a status code of 1 (error). +.TP +\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +Use the configuration file \fIFILENAME\fP\&. +.TP +\fB\-f\fP | \fB\-\-filename\fP +Try to perform expansions as if the option values represent filenames (will +also be applied even if the option is not really a filename). +.TP +\fB\-F\fP | \fB\-\-full\fP +Write the full configuration file, not just the differences to the defaults. +.TP +\fB\-h\fP | \fB\-\-help\fP +Print short help on options. +.TP +\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +Use \fILOGLEVEL\fP for logging. +Valid values are \fBDEBUG\fP, \fBINFO\fP, \fBWARNING\fP, and \fBERROR\fP\&. +.TP +\fB\-l\fP \fIFILENAME\fP | \fB\-\-logfile=\fP\fIFILENAME\fP +Send logging output to \fIFILENAME\fP\&. +.TP +\fB\-o\fP \fIOPTION\fP | \fB\-\-option=\fP\fIOPTION\fP +Which configuration option should be accessed or edited. Required to set a +value. If not given, all values of a given section will be printed in the +format "OPTION = VALUE". +.TP +\fB\-r\fP | \fB\-\-rewrite\fP +Write the configuration file even if nothing changed. Will remove all comments! +.TP +\fB\-S\fP | \fB\-\-list\-sections\fP +List available configuration sections for use with \fB\-\-section\fP\&. +.TP +\fB\-s\fP \fISECTION\fP | \fB\-\-section=\fP\fISECTION\fP +Which configuration section should be accessed or edited. +Required option. +.TP +\fB\-V\fP \fIVALUE\fP | \fB\-\-value=\fP\fIVALUE\fP +Configuration value to store in the given section under the given option. +Must only be given together with \fB\-s\fP and \fB\-o\fP options. +.INDENT 7.0 +.TP +.B Note: +Changing the configuration file with \fB\-V\fP will remove comments +and may reorder sections and remove \fB@INLINE@\fP directives. +.UNINDENT +.TP +\fB\-v\fP | \fB\-\-version\fP +Print GNU Taler version number. +.UNINDENT +.SH SEE ALSO +.sp +challenger\-dbinit(1), challenger\-httpd(1), challenger.conf(5). +.SH BUGS +.sp +Report bugs by using \fI\%https://bugs.taler.net\fP or by sending electronic +mail to <\fI\%taler@gnu.org\fP>. +.SH AUTHOR +GNU Taler contributors +.SH COPYRIGHT +2014-2022 Taler Systems SA (GPLv3+ or GFDL 1.3+) +.\" Generated by docutils manpage writer. +. diff --git a/man/challenger-dbinit.1 b/man/challenger-dbinit.1 new file mode 100644 index 00000000..680f35c2 --- /dev/null +++ b/man/challenger-dbinit.1 @@ -0,0 +1,84 @@ +.\" Man page generated from reStructuredText. +. +.TH "CHALLENGER-DBINIT" "1" "Apr 16, 2023" "0.9" "GNU Taler" +.SH NAME +challenger-dbinit \- initialize the Challenger database +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +\fBchallenger\-dbinit\fP +[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP] +[\fB\-g\fP\ |\ \fB\-\-garbagecollect\fP] +[\fB\-h\fP\ |\ \fB\-\-help\fP] +[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-log=\fP\fILOGLEVEL\fP] +[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB\-\-logfile=\fP\fIFILENAME\fP] +[\fB\-r\fP\ |\ \fB\-\-reset\fP] +[\fB\-v\fP\ |\ \fB\-\-version\fP] +.SH DESCRIPTION +.sp +\fBchallenger\-dbinit\fP is a command\-line tool to initialize the Challenger database. +.sp +Its options are as follows: +.INDENT 0.0 +.TP +\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +Use the configuration and other resources for the Challenger commands +to operate from \fIFILENAME\fP\&. +.TP +\fB\-g\fP | \fB\-\-garbagecollect\fP +Remove state data from database. +.TP +\fB\-h\fP | \fB\-\-help\fP +Print short help on options. +.TP +\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-log=\fP\fILOGLEVEL\fP +Configure logging to use \fILOGLEVEL\fP\&. +.TP +\fB\-l\fP \fIFILENAME\fP | \fB\-\-logfile=\fP\fIFILENAME\fP +Configure logging to write logs to \fIFILENAME\fP\&. +.TP +\fB\-r\fP | \fB\-\-reset\fP +Reset database. (\fBDANGEROUS\fP: All existing data is lost!) +.TP +\fB\-v\fP | \fB–version\fP +Print version information. +.UNINDENT +.SH SEE ALSO +.sp +challenger\-config(1), challenger\-httpd(1), challenger.conf(5). +.SH BUGS +.sp +Report bugs by using \fI\%https://bugs.taler.net\fP or by sending electronic +mail to <\fI\%taler@gnu.org\fP>. +.SH AUTHOR +GNU Taler contributors +.SH COPYRIGHT +2014-2022 Taler Systems SA (GPLv3+ or GFDL 1.3+) +.\" Generated by docutils manpage writer. +. diff --git a/man/challenger-httpd.1 b/man/challenger-httpd.1 new file mode 100644 index 00000000..df495a32 --- /dev/null +++ b/man/challenger-httpd.1 @@ -0,0 +1,80 @@ +.\" Man page generated from reStructuredText. +. +.TH "CHALLENGER-HTTPD" "1" "Apr 16, 2023" "0.9" "GNU Taler" +.SH NAME +challenger-httpd \- provide the Challenger HTTP interface +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +\fBchallenger\-httpd\fP +[\fB\-C\fP\ |\ \fB\-\-connection\-close\fP] +[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP] +[\fB\-h\fP\ |\ \fB\-\-help\fP] +[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-log=\fP\fILOGLEVEL\fP] +[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB\-\-logfile=\fP\fIFILENAME\fP] +[\fB\-v\fP\ |\ \fB\-\-version\fP] +.SH DESCRIPTION +.sp +\fBchallenger\-httpd\fP is a command\-line tool to provide the Challenger HTTP interface. +.sp +Its options are as follows: +.INDENT 0.0 +.TP +\fB\-C\fP | \fB\-\-connection\-close\fP +Force HTTP connections to be closed after each request. +.TP +\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +Use the configuration and other resources for the Challenger commands +to operate from \fIFILENAME\fP\&. +.TP +\fB\-h\fP | \fB\-\-help\fP +Print short help on options. +.TP +\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-log=\fP\fILOGLEVEL\fP +Configure logging to use \fILOGLEVEL\fP\&. +.TP +\fB\-l\fP \fIFILENAME\fP | \fB\-\-logfile=\fP\fIFILENAME\fP +Configure logging to write logs to \fIFILENAME\fP\&. +.TP +\fB\-v\fP | \fB–version\fP +Print version information. +.UNINDENT +.SH SEE ALSO +.sp +challenger\-config(1), challenger\-dbinit(1), challenger.conf(5). +.SH BUGS +.sp +Report bugs by using \fI\%https://bugs.taler.net\fP or by sending electronic +mail to <\fI\%taler@gnu.org\fP>. +.SH AUTHOR +GNU Taler contributors +.SH COPYRIGHT +2014-2022 Taler Systems SA (GPLv3+ or GFDL 1.3+) +.\" Generated by docutils manpage writer. +. diff --git a/man/libeufin-nexus.1 b/man/libeufin-nexus.1 index c5ac89f5..f008200d 100644 --- a/man/libeufin-nexus.1 +++ b/man/libeufin-nexus.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "LIBEUFIN-NEXUS" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "LIBEUFIN-NEXUS" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME libeufin-nexus \- service to interface to various bank access APIs . diff --git a/man/libeufin-sandbox.1 b/man/libeufin-sandbox.1 index 32e8bc7c..e0b0ce09 100644 --- a/man/libeufin-sandbox.1 +++ b/man/libeufin-sandbox.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "LIBEUFIN-SANDBOX" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "LIBEUFIN-SANDBOX" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME libeufin-sandbox \- simulate core banking system with EBICS access to bank accounts . @@ -84,6 +84,15 @@ The following sections describe each command in detail. This command takes argument \fBNAME\fP and creates a demobank with that name. .sp Option \fB\-\-currency CUR\fP (default: \fBEUR\fP) specifes another currency. +Option \fB\-\-captcha\-url $URL\fP specifies where the wallet user is going +to be redirected to confirm the withdrawal operation. This $URL should +point to the bank frontend. More precisely to the UI that let the user +finish a withdrawal operation that needs to be confirmed. Example of +this value may be "\fI\%https://bank.domain/#/operation\fP/{wopid}" where +"\fI\%https://bank.domain\fP" returns the demobank SPA and the demobank view under +the route "/operation/{wopid}" will show the status of the operation id {wopid}. +Note that "{wopid}" is literally in the \-\-captcha\-url config and replaced at +runtime by the sandbox server. Option \fB\-\-bank\-debt\-limit N\fP (default: 1000000) specifies that the bank debt limit should be N (units of currency). Similarly, option \fB\-\-users\-debt\-limit N\fP (default: 1000) specifies diff --git a/man/sync-config.1 b/man/sync-config.1 index 83c69ed8..1f993265 100644 --- a/man/sync-config.1 +++ b/man/sync-config.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SYNC-CONFIG" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "SYNC-CONFIG" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME sync-config \- manipulate Sync configuration files . diff --git a/man/sync-dbinit.1 b/man/sync-dbinit.1 index e3b524e7..9560636b 100644 --- a/man/sync-dbinit.1 +++ b/man/sync-dbinit.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SYNC-DBINIT" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "SYNC-DBINIT" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME sync-dbinit \- initialize the Sync database . diff --git a/man/sync-httpd.1 b/man/sync-httpd.1 index 851dbe14..8bef520e 100644 --- a/man/sync-httpd.1 +++ b/man/sync-httpd.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SYNC-HTTPD" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "SYNC-HTTPD" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME sync-httpd \- provide the Sync HTTP interface . diff --git a/man/sync.conf.5 b/man/sync.conf.5 index f5fe6126..e0e49262 100644 --- a/man/sync.conf.5 +++ b/man/sync.conf.5 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SYNC.CONF" "5" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "SYNC.CONF" "5" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME sync.conf \- Sync configuration file . diff --git a/man/taler-auditor-dbinit.1 b/man/taler-auditor-dbinit.1 index a33aa48f..f35f69f9 100644 --- a/man/taler-auditor-dbinit.1 +++ b/man/taler-auditor-dbinit.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-AUDITOR-DBINIT" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-AUDITOR-DBINIT" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-auditor-dbinit \- setup auditor database . diff --git a/man/taler-auditor-exchange.1 b/man/taler-auditor-exchange.1 index a5c32169..ff242f2d 100644 --- a/man/taler-auditor-exchange.1 +++ b/man/taler-auditor-exchange.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-AUDITOR-EXCHANGE" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-AUDITOR-EXCHANGE" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-auditor-exchange \- add or remove exchange from auditor’s list . diff --git a/man/taler-auditor-httpd.1 b/man/taler-auditor-httpd.1 index d1ceedb5..6e109ebd 100644 --- a/man/taler-auditor-httpd.1 +++ b/man/taler-auditor-httpd.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-AUDITOR-HTTPD" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-AUDITOR-HTTPD" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-auditor-httpd \- HTTP server providing a RESTful API to access a Taler auditor . diff --git a/man/taler-auditor-offline.1 b/man/taler-auditor-offline.1 index 23483a68..abcaf14f 100644 --- a/man/taler-auditor-offline.1 +++ b/man/taler-auditor-offline.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-AUDITOR-OFFLINE" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-AUDITOR-OFFLINE" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-auditor-offline \- Taler auditor certifies that it audits a Taler exchange . diff --git a/man/taler-auditor-sync.1 b/man/taler-auditor-sync.1 index 785b46ce..3f765f4a 100644 --- a/man/taler-auditor-sync.1 +++ b/man/taler-auditor-sync.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-AUDITOR-SYNC" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-AUDITOR-SYNC" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-auditor-sync \- tool to safely synchronize auditor database . diff --git a/man/taler-auditor.1 b/man/taler-auditor.1 index 924dfa11..fec4b446 100644 --- a/man/taler-auditor.1 +++ b/man/taler-auditor.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-AUDITOR" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-AUDITOR" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-auditor \- audit exchange . diff --git a/man/taler-config.1 b/man/taler-config.1 index a53e2e9f..0f2acbdc 100644 --- a/man/taler-config.1 +++ b/man/taler-config.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-CONFIG" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-CONFIG" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-config \- Taler configuration inspection and editing . diff --git a/man/taler-exchange-aggregator.1 b/man/taler-exchange-aggregator.1 index 12b9c63b..52bcca4a 100644 --- a/man/taler-exchange-aggregator.1 +++ b/man/taler-exchange-aggregator.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-AGGREGATOR" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-AGGREGATOR" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-exchange-aggregator \- aggregate deposits into wire transfers . diff --git a/man/taler-exchange-benchmark.1 b/man/taler-exchange-benchmark.1 index 822a2768..dfee3576 100644 --- a/man/taler-exchange-benchmark.1 +++ b/man/taler-exchange-benchmark.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-BENCHMARK" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-BENCHMARK" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-exchange-benchmark \- measure exchange performance . diff --git a/man/taler-exchange-closer.1 b/man/taler-exchange-closer.1 index b56fc78a..a69f45ce 100644 --- a/man/taler-exchange-closer.1 +++ b/man/taler-exchange-closer.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-CLOSER" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-CLOSER" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-exchange-closer \- close idle reserves . diff --git a/man/taler-exchange-dbinit.1 b/man/taler-exchange-dbinit.1 index 3c4e4e32..f5aedd35 100644 --- a/man/taler-exchange-dbinit.1 +++ b/man/taler-exchange-dbinit.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-DBINIT" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-DBINIT" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-exchange-dbinit \- initialize Taler exchange database . diff --git a/man/taler-exchange-drain.1 b/man/taler-exchange-drain.1 index e8cbf4f6..6c4889f8 100644 --- a/man/taler-exchange-drain.1 +++ b/man/taler-exchange-drain.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-DRAIN" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-DRAIN" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-exchange-drain \- drain profits from exchange . diff --git a/man/taler-exchange-expire.1 b/man/taler-exchange-expire.1 index 380e4f1c..78b378b4 100644 --- a/man/taler-exchange-expire.1 +++ b/man/taler-exchange-expire.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-EXPIRE" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-EXPIRE" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-exchange-expire \- refund expired purses . diff --git a/man/taler-exchange-httpd.1 b/man/taler-exchange-httpd.1 index bd4e45af..015456c7 100644 --- a/man/taler-exchange-httpd.1 +++ b/man/taler-exchange-httpd.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-HTTPD" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-HTTPD" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-exchange-httpd \- run Taler exchange (with RESTful API) . diff --git a/man/taler-exchange-kyc-tester.1 b/man/taler-exchange-kyc-tester.1 index fcba8e41..e01060b9 100644 --- a/man/taler-exchange-kyc-tester.1 +++ b/man/taler-exchange-kyc-tester.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-KYC-TESTER" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-KYC-TESTER" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-exchange-kyc-tester \- test KYC service integration . @@ -50,6 +50,10 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] \fBtaler\-exchange\-kyc\-tester\fP is used to test the interaction between a Taler exchange and a KYC service. The tool can be used to manually trigger the various steps of a KYC process and to observe the interaction with the respective KYC service. It is supposted to help test the configuration of the integration, and \fInot\fP required at all during production. .sp To use it, you must first provide a configuration file with at least one KYC service configured. Some other exchange\-specific options, like the PORT for the HTTP service and the BASE_URL under which the Taler exchange will run are also required. You should be able to use exactly the same configuration file that one would usually give to a Taler exchange. Starting with this, the tool allows the simulation of a KYC process. Note that it will not write any information to the database. +.sp +Begin with a first invocation of taler\-exchange\-kyc\-tester using the options \fB\-i\fP for an individual or business and use \fB\-R\fP to specify a list of checks required from the process. The output will be an URL to visit with the browser, as well as \fB\-p\fP, \fB\-u\fP, \fB\-U\fP options to use in future invocations of the tool. +.sp +Next, run taler\-exchange\-kyc\-tester again, but this time using \fB\-w\fP (to run the Webserver) and using the \fB\-u\fP and \fB\-U\fP options output by the previous call, as well as the \fB\-p\fP option with the payto hash. Then visit the Web site from the link output by the previous invocation and "pass" (or "fail") the KYC check. .INDENT 0.0 .TP \fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP @@ -66,14 +70,14 @@ Specifies the log level to use. Accepted values are: \fBDEBUG\fP, \fBINFO\fP, \fB\-l\fP \fIFILENAME\fP | \fB\-\-logfile=\fP\fIFILENAME\fP Send logging output to \fIFILENAME\fP\&. .TP -\fB\-i\fP \fISECTION_NAME\fP | \fB\-\-initiate=\fP\fISECTION_NAME\fP -Start a fresh KYC process using the KYC provider configured in SECTION_NAME of the configuration. This will output the HTTP URL where the user has to begin the KYC process to the command\-line. This is usually the first thing to do when using this tool. Outputs the KYC\-logic specific user and legitimization IDs, or NULL if not used by the KYC\-logic at the initiation stage. +\fB\-i\fP \fIUSERTYPE\fP | \fB\-\-initiate=\fP\fIUSERTYPE\fP +Specifies the type of user for which we are starting a fresh KYC process. USERTYPE must be either "individual" or "business". .TP \fB\-u\fP \fIID\fP | \fB\-\-user=\fP\fIID\fP -Run the process with ID for the user identifier at the KYC provider. Not useful in conjunction with \fB\-i\fP as that option will override whatever value is provided here. +Run the process with ID for the user identifier at the KYC provider. Not useful in conjunction with \fB\-i\fP and \fB\-R\fP as that option will override whatever value is provided here. .TP \fB\-U\fP \fIID\fP | \fB\-\-legitimization=\fP\fIID\fP -Run the process with ID for the legitimization process identifier at the KYC provider. Not useful in conjunction with \fB\-i\fP as that option will override whatever value is provided here. +Run the process with ID for the legitimization process identifier at the KYC provider. Not useful in conjunction with \fB\-R\fP / \fB\-i\fP as that option will override whatever value is provided here. .TP \fB\-p\fP \fIHASH\fP | \fB\-\-payto\-hash=\fP\fIHASH\fP Run the process with HASH as the hash of the payto://\-URI that identifies the account or wallet triggering the KYC requirement. If not given, a fresh random value is used. Rarely useful. @@ -84,6 +88,9 @@ Print the HASH of the payto://\-URI used for the KYC simulation this time. Usefu \fB\-r\fP \fINUMBER\fP | \fB\-\-rowid=\fP\fINUMBER\fP Run the process with NUMBER as the database row for the legitimization operation. Rarely useful, except maybe for debugging. Defaults to 42. .TP +\fB\-R\fP \fICHECKS\fP | \fB\-\-requirements=\fP\fICHECKS\fP +Start a fresh KYC process for the given list of CHECKS. CHECKS must be a space\-separated list of checks that must be in the configuration under \fIPROVIDED_CHECKS\fP for some of the providers. The exchange will determine which provider to use for KYC based on the CHECKS given. The tool will output the HTTP URL where the user has to begin the KYC process to the command\-line. This is usually the first thing to do when using this tool. Outputs the KYC\-logic specific user and legitimization IDs, or NULL if not used by the KYC\-logic at the initiation stage. You may want to use the \fB\-P\fP option to also obtain the Payto\-Hash for use with \fBp\fP later. +.TP \fB\-v\fP | \fB\-\-version\fP Print version information. .TP diff --git a/man/taler-exchange-offline.1 b/man/taler-exchange-offline.1 index bc02e1cc..08bd3e2b 100644 --- a/man/taler-exchange-offline.1 +++ b/man/taler-exchange-offline.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-OFFLINE" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-OFFLINE" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-exchange-offline \- operations using the offline key of a Taler exchange . @@ -361,6 +361,61 @@ History fee charged when inquiring about non\-recent account history. .UNINDENT .UNINDENT .UNINDENT +.SS aml\-enable +.sp +Enable AML officer\(aqs account, granting them access to AML data and, +if \(aqrw\(aq is given, the power to make AML decisions. +.sp +The arguments provided must include: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +AML staff member public key (in base32 encoding) +.IP 2. 3 +AML staff member legal name +.IP 3. 3 +\(aqro\(aq or \(aqrw\(aq to set access to read\-only or read\-write +.UNINDENT +.UNINDENT +.UNINDENT +.SS aml\-disable +.sp +Disable AML officer\(aqs account. Also updates the legal name. +.sp +The arguments provided must include: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +AML staff member public key (in base32 encoding) +.IP 2. 3 +AML staff member legal name +.UNINDENT +.UNINDENT +.UNINDENT +.SS add\-partner +.sp +Add partner exchange for wad transfers. Enables P2P payments +between users of these exchanges. +.sp +The arguments provided must include: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP 1. 3 +Master public key of the partner exchange. +.IP 2. 3 +Base URL of the partner exchange API. +.IP 3. 3 +Wad fee to charge. +.IP 4. 3 +Wad transfer frequency. +.IP 5. 3 +Year for which the above options are to be configured, \(aqnow\(aq for the current year. +.UNINDENT +.UNINDENT +.UNINDENT .SS upload .sp This subcommand uploads outputs from other subcommands (except \fBdownload\fP and \fBshow\fP) diff --git a/man/taler-exchange-router.1 b/man/taler-exchange-router.1 index 9bcb18b3..96931042 100644 --- a/man/taler-exchange-router.1 +++ b/man/taler-exchange-router.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-ROUTER" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-ROUTER" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-exchange-router \- route payments to partner exchanges . diff --git a/man/taler-exchange-secmod-cs.1 b/man/taler-exchange-secmod-cs.1 index cdf80b0c..7fcde41b 100644 --- a/man/taler-exchange-secmod-cs.1 +++ b/man/taler-exchange-secmod-cs.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-SECMOD-CS" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-SECMOD-CS" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-exchange-secmod-cs \- handle private CS key operations for a Taler exchange . diff --git a/man/taler-exchange-secmod-eddsa.1 b/man/taler-exchange-secmod-eddsa.1 index 8fcdbadf..3813288b 100644 --- a/man/taler-exchange-secmod-eddsa.1 +++ b/man/taler-exchange-secmod-eddsa.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-SECMOD-EDDSA" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-SECMOD-EDDSA" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-exchange-secmod-eddsa \- handle private EDDSA key operations for a Taler exchange . diff --git a/man/taler-exchange-secmod-rsa.1 b/man/taler-exchange-secmod-rsa.1 index c1df0acb..84edb7e9 100644 --- a/man/taler-exchange-secmod-rsa.1 +++ b/man/taler-exchange-secmod-rsa.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-SECMOD-RSA" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-SECMOD-RSA" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-exchange-secmod-rsa \- handle private RSA key operations for a Taler exchange . diff --git a/man/taler-exchange-transfer.1 b/man/taler-exchange-transfer.1 index 1e541ee6..821b1ca3 100644 --- a/man/taler-exchange-transfer.1 +++ b/man/taler-exchange-transfer.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-TRANSFER" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-TRANSFER" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-exchange-transfer \- execute wire transfers . diff --git a/man/taler-exchange-wire-gateway-client.1 b/man/taler-exchange-wire-gateway-client.1 index da313c2d..c96e4498 100644 --- a/man/taler-exchange-wire-gateway-client.1 +++ b/man/taler-exchange-wire-gateway-client.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-WIRE-GATEWAY-CLIENT" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-WIRE-GATEWAY-CLIENT" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-exchange-wire-gateway-client \- trigger a transfer at the bank . diff --git a/man/taler-exchange-wirewatch.1 b/man/taler-exchange-wirewatch.1 index 43c69983..1886635e 100644 --- a/man/taler-exchange-wirewatch.1 +++ b/man/taler-exchange-wirewatch.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-EXCHANGE-WIREWATCH" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-EXCHANGE-WIREWATCH" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-exchange-wirewatch \- watch for incoming wire transfers . @@ -54,6 +54,9 @@ Its options are as follows: Use the configuration and other resources for the exchange to operate from \fIFILENAME\fP\&. .TP +\fB\-f\fP \fIDELAY\fP| \fB\-\-longpoll\-timeout=\fP\fIDELAY\fP +How long do we wait for a response for bank transactions from the bank. This is both the timeout for the long polling as well as the maximum frequency at which we would query the bank. Default is 60s. +.TP \fB\-h\fP | \fB\-\-help\fP Print short help on options. .TP diff --git a/man/taler-helper-auditor-aggregation.1 b/man/taler-helper-auditor-aggregation.1 index 49d2ae0f..e4876369 100644 --- a/man/taler-helper-auditor-aggregation.1 +++ b/man/taler-helper-auditor-aggregation.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-HELPER-AUDITOR-AGGREGATION" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-HELPER-AUDITOR-AGGREGATION" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-helper-auditor-aggregation \- audit Taler exchange aggregation activity . diff --git a/man/taler-helper-auditor-coins.1 b/man/taler-helper-auditor-coins.1 index 518b57be..43f4ff9e 100644 --- a/man/taler-helper-auditor-coins.1 +++ b/man/taler-helper-auditor-coins.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-HELPER-AUDITOR-COINS" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-HELPER-AUDITOR-COINS" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-helper-auditor-coins \- audit Taler coin processing . diff --git a/man/taler-helper-auditor-deposits.1 b/man/taler-helper-auditor-deposits.1 index d9ea1b52..fdde9874 100644 --- a/man/taler-helper-auditor-deposits.1 +++ b/man/taler-helper-auditor-deposits.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-HELPER-AUDITOR-DEPOSITS" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-HELPER-AUDITOR-DEPOSITS" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-helper-auditor-deposits \- audit Taler exchange database for deposit confirmation consistency . diff --git a/man/taler-helper-auditor-purses.1 b/man/taler-helper-auditor-purses.1 index 130b1c56..58871d6f 100644 --- a/man/taler-helper-auditor-purses.1 +++ b/man/taler-helper-auditor-purses.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-HELPER-AUDITOR-PURSES" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-HELPER-AUDITOR-PURSES" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-helper-auditor-purses \- audit Taler exchange purse handling . diff --git a/man/taler-helper-auditor-reserves.1 b/man/taler-helper-auditor-reserves.1 index a25f3357..bc75f5f6 100644 --- a/man/taler-helper-auditor-reserves.1 +++ b/man/taler-helper-auditor-reserves.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-HELPER-AUDITOR-RESERVES" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-HELPER-AUDITOR-RESERVES" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-helper-auditor-reserves \- audit Taler exchange reserve handling . diff --git a/man/taler-helper-auditor-wire.1 b/man/taler-helper-auditor-wire.1 index a1a667ce..463aa554 100644 --- a/man/taler-helper-auditor-wire.1 +++ b/man/taler-helper-auditor-wire.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-HELPER-AUDITOR-WIRE" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-HELPER-AUDITOR-WIRE" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-helper-auditor-wire \- audit exchange database for consistency with the bank's wire transfers . diff --git a/man/taler-merchant-benchmark.1 b/man/taler-merchant-benchmark.1 index 88835ea8..6345b5cc 100644 --- a/man/taler-merchant-benchmark.1 +++ b/man/taler-merchant-benchmark.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-MERCHANT-BENCHMARK" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-MERCHANT-BENCHMARK" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-merchant-benchmark \- generate Taler-style benchmarking payments . diff --git a/man/taler-merchant-dbinit.1 b/man/taler-merchant-dbinit.1 index 7bf4fb46..4ce6ba0e 100644 --- a/man/taler-merchant-dbinit.1 +++ b/man/taler-merchant-dbinit.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-MERCHANT-DBINIT" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-MERCHANT-DBINIT" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-merchant-dbinit \- initialize Taler merchant database . diff --git a/man/taler-merchant-httpd.1 b/man/taler-merchant-httpd.1 index 1215735c..d4b42393 100644 --- a/man/taler-merchant-httpd.1 +++ b/man/taler-merchant-httpd.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-MERCHANT-HTTPD" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-MERCHANT-HTTPD" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-merchant-httpd \- run Taler merchant backend (with RESTful API) . @@ -33,6 +33,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .SH SYNOPSIS .sp \fBtaler\-merchant\-httpd\fP +[\fB\-a**_|_\fP\-\-auth**] [\fB\-C\fP\ |\ \fB\-\-connection\-close\fP] [\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP] [\fB\-h\fP\ |\ \fB\-\-help\fP] @@ -49,9 +50,9 @@ before running this command. .INDENT 0.0 .TP \fB\-a\fP \fITOKEN\fP | \fB\-\-auth=\fP\fITOKEN\fP -Use TOKEN for initial access control to the merchant backend. The value +Use TOKEN for initial access control to the merchant backend. TOKEN must start with the "secret\-token:" prefix, as per RFC 8959. The value given in TOKEN must appear in backoffice requests to the default instance -of the merchant, i.e. "Authorization: Bearer secret\-token:TOKEN" to obtain +of the merchant, i.e. "Authorization: Bearer TOKEN" to obtain access to the merchant backend. Note that setting a passphrase for the default instance by any means will block future access via TOKEN. This is basically a way to reset the passphrase protecting access. TOKEN diff --git a/man/taler-merchant-setup-reserve.1 b/man/taler-merchant-setup-reserve.1 index 88e9f0f3..f2ccda23 100644 --- a/man/taler-merchant-setup-reserve.1 +++ b/man/taler-merchant-setup-reserve.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER-MERCHANT-SETUP-RESERVE" "1" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER-MERCHANT-SETUP-RESERVE" "1" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler-merchant-setup-reserve \- setup reserve for tipping at a Taler merchant backend . diff --git a/man/taler-merchant-webhook.1 b/man/taler-merchant-webhook.1 new file mode 100644 index 00000000..15315f1a --- /dev/null +++ b/man/taler-merchant-webhook.1 @@ -0,0 +1,84 @@ +.\" Man page generated from reStructuredText. +. +.TH "TALER-MERCHANT-WEBHOOK" "1" "Apr 16, 2023" "0.9" "GNU Taler" +.SH NAME +taler-merchant-webhook \- execute webhooks of the Taler merchant backend (optional service) +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +\fBtaler\-merchant\-webhook\fP +[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP] +[\fB\-h\fP\ |\ \fB\-\-help\fP] +[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-loglevel=\fP\fILOGLEVEL\fP] +[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB\-\-logfile=\fP\fIFILENAME\fP] +[\fB\-t\fP\ |\ \fB\-\-test\fP] +[\fB\-v\fP\ |\ \fB\-\-version\fP] +.SH DESCRIPTION +.sp +\fBtaler\-merchant\-webhook\fP is a command\-line tool to trigger webhooks +scheduled by a Taler merchant backend. It makes the necessary HTTP +requests and updates the Taler merchant database accordingly. +.sp +Its options are as follows: +.INDENT 0.0 +.TP +\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +Use the configuration and other resources for the merchant to operate +from \fIFILENAME\fP\&. +.TP +\fB\-h\fP | \fB\-\-help\fP +Print short help on options. +.TP +\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +Specifies the log level to use. Accepted values are: \fBDEBUG\fP, \fBINFO\fP, +\fBWARNING\fP, \fBERROR\fP\&. +.TP +\fB\-l\fP \fIFILENAME\fP | \fB\-\-logfile=\fP\fIFILENAME\fP +Send logging output to \fIFILENAME\fP\&. +.TP +\fB\-t\fP | \fB\-\-test\fP +Run in test mode. Only runs until there are no more webhooks +to be executed. +.TP +\fB\-v\fP | \fB–version\fP +Print version information. +.UNINDENT +.SH SEE ALSO +.sp +taler\-merchant\-httpd(1), taler.conf(5). +.SH BUGS +.sp +Report bugs by using \fI\%https://bugs.taler.net\fP or by sending electronic +mail to <\fI\%taler@gnu.org\fP>. +.SH AUTHOR +GNU Taler contributors +.SH COPYRIGHT +2014-2022 Taler Systems SA (GPLv3+ or GFDL 1.3+) +.\" Generated by docutils manpage writer. +. diff --git a/man/taler-merchant-wirewatch.1 b/man/taler-merchant-wirewatch.1 new file mode 100644 index 00000000..acc786bc --- /dev/null +++ b/man/taler-merchant-wirewatch.1 @@ -0,0 +1,90 @@ +.\" Man page generated from reStructuredText. +. +.TH "TALER-MERCHANT-WIREWATCH" "1" "Apr 16, 2023" "0.9" "GNU Taler" +.SH NAME +taler-merchant-wirewatch \- import credit transactions from a merchant bank account into merchant backend (optional) +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +\fBtaler\-merchant\-wirewatch\fP +[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB\-\-config=\fP\fIFILENAME\fP] +[\fB\-h\fP\ |\ \fB\-\-help\fP] +[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB\-\-loglevel=\fP\fILOGLEVEL\fP] +[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB\-\-logfile=\fP\fIFILENAME\fP] +[\fB\-t\fP\ |\ \fB\-\-test\fP] +[\fB\-v\fP\ |\ \fB\-\-version\fP] +.SH DESCRIPTION +.sp +\fBtaler\-merchant\-wirewatch\fP is a command\-line tool to import +information about incoming bank transfers into a Taler merchant +backend. This will allow the merchant backend to validate that +the exchange paid the merchant correctly. +.sp +Its options are as follows: +.INDENT 0.0 +.TP +\fB\-c\fP \fIFILENAME\fP | \fB\-\-config=\fP\fIFILENAME\fP +Use the configuration and other resources for the merchant to operate +from \fIFILENAME\fP\&. +.TP +\fB\-h\fP | \fB\-\-help\fP +Print short help on options. +.TP +\fB\-L\fP \fILOGLEVEL\fP | \fB\-\-loglevel=\fP\fILOGLEVEL\fP +Specifies the log level to use. Accepted values are: \fBDEBUG\fP, \fBINFO\fP, +\fBWARNING\fP, \fBERROR\fP\&. +.TP +\fB\-l\fP \fIFILENAME\fP | \fB\-\-logfile=\fP\fIFILENAME\fP +Send logging output to \fIFILENAME\fP\&. +.TP +\fB\-s\fP \fISECTION\fP | \fB\-\-section=\fP\fISECTION\fP +Configuration section to use. Default is taler\-merchant\-wirewatch. Needed +if different processes are used to watch multiple bank accounts (for the +same instance or different instances). +.TP +\fB\-t\fP | \fB\-\-test\fP +Run in test mode. Only runs until the current list of bank +transactions are all imported. +.TP +\fB\-v\fP | \fB–version\fP +Print version information. +.UNINDENT +.SH SEE ALSO +.sp +taler\-merchant\-httpd(1), taler.conf(5). +.SH BUGS +.sp +Report bugs by using \fI\%https://bugs.taler.net\fP or by sending electronic +mail to <\fI\%taler@gnu.org\fP>. +.SH AUTHOR +GNU Taler contributors +.SH COPYRIGHT +2014-2022 Taler Systems SA (GPLv3+ or GFDL 1.3+) +.\" Generated by docutils manpage writer. +. diff --git a/man/taler.conf.5 b/man/taler.conf.5 index 9c393d4c..4467ef44 100644 --- a/man/taler.conf.5 +++ b/man/taler.conf.5 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "TALER.CONF" "5" "Nov 03, 2022" "0.9" "GNU Taler" +.TH "TALER.CONF" "5" "Apr 16, 2023" "0.9" "GNU Taler" .SH NAME taler.conf \- Taler configuration file . @@ -85,6 +85,14 @@ virtually all Taler components. .TP .B CURRENCY Name of the currency, e.g.\ “EUR” for Euro. +.TP +.B CURRENCY_ROUND_UNIT +Smallest amount in this currency that can be transferred using the +underlying RTGS. For example: "EUR:0.01" or "JPY:1". +.TP +.B AML_THRESHOLD +Largest amount in this currency that can be transferred per month without +an AML staff member doing a (manual) AML check. For example: "USD:1000000". .UNINDENT .sp The “[PATHS]” section is special in that it contains paths that can be @@ -232,22 +240,22 @@ The following options must be in the section "[kyc\-provider\-XXX]" sections wit Duration (e.g. "12 months") of the validity of the performed KYC check. Can be "forever". .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. 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/auth\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. The login URL will be encoded as part of the \(aqredirect_uri\(aq argument of the request to the KYC_AUTH2_AUTH_URL. Typically, the user will then be redirected to this URL to log in. Example: "\fI\%http://localhost:8888/oauth/v2/login\fP" .TP .B KYC_OAUTH2_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\(aqs details. The server will use the access token obtained from the KYC_AUTH2_AUTH_URL to show that it is authorized to obtain the details. Example: "\fI\%http://localhost:8888/api/user/me\fP" or "\fI\%http://localhost:8888/oauth/v2/info\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. .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. .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\(aqs browser after successful authorization/login for the KYC process. Example: "\fI\%http://example.com/thank\-you\fP" .UNINDENT .SS EXCHANGE KYC KYCAID OPTIONS .sp @@ -266,6 +274,37 @@ ID that specifies the form to use for the KYC process. .B KYC_KYCAID_POST_URL URL to which the exchange will redirect the client\(aqs browser after successful authorization/login for the KYC process. .UNINDENT +.SS EXCHANGE KYC PERSONA OPTIONS +.sp +The following options must be in the section "[kyc\-provider\-XXX]" sections with "LOGIC = persona". +.INDENT 0.0 +.TP +.B KYC_PERSONA_VALIDITY +Duration (e.g. "12 months") of the validity of the performed KYC check. Can be "forever". +.TP +.B KYC_PERSONA_AUTH_TOKEN +Authentication token to access the KYC service. +.TP +.B KYC_PERSONA_SALT +Salt value to use for request idempotency. Optional, generated at random per process if not given. +.TP +.B KYC_PERSONA_SUBDOMAIN +Subdomain to use under Persona. +.TP +.B KYC_PERSONA_POST_URL +URL to which the exchange will redirect the client\(aqs browser after successful authorization/login for the KYC process. +.TP +.B KYC_PERSONA_TEMPLATE_ID +ID of the Persona template to use. +.UNINDENT +.SS EXCHANGE KYC PERSONA GLOBAL OPTIONS +.sp +The following option must be in the section "[kyclogic\-persona]". +.INDENT 0.0 +.TP +.B WEBHOOK_AUTH_TOKEN +Authentication token Persona must supply to our webhook. This is an optional setting. +.UNINDENT .SS EXCHANGE OFFLINE SIGNING OPTIONS .sp The following options must be in the section "[exchange\-offline]". @@ -387,6 +426,10 @@ After what time do we forget about (drained) reserves during garbage collection? .B AGGREGATOR_SHIFT Delay between a deposit being eligible for aggregation and the aggregator actually triggering. +.TP +.B DEFAULT_PURSE_LIMIT +Number of concurrent purses that a reserve may have active +if it is paid to be opened for a year. .UNINDENT .SS EXCHANGE POSTGRES BACKEND DATABASE OPTIONS .sp @@ -572,6 +615,31 @@ Name of the currency for which this auditor is trusted, 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. .UNINDENT +.SS MERCHANT WIREWATCH OPTIONS +.sp +The name of the configuration section used by taler\-merchant\-wirewatch +can be changed via the command\-line. By default, it is simply +"[taler\-merchant\-wirewatch]". The options are: +.INDENT 0.0 +.TP +.B INSTANCE +Which instance of the backend should transactions be imported for by this wirewatcher. +.TP +.B WIRE_GATEWAY_URL +Under which URL is the wire gateway (libeufin facade) reachable that makes bank transfer data availalbe to us. +.TP +.B WIRE_GATEWAY_AUTH_METHOD +Which authentication method should be used (currently only "NONE" or "BASIC" are supported). +.TP +.B USERNAME +Username to give to the wire gateway when using "BASIC" authentication. +.TP +.B PASSWORD +Password to give to the wire gateway when using "BASIC" authentication. +.UNINDENT +.sp +Note that the libeufin facade type to configure for a taler\-merchant\-wirewatch +operation is the "Anastasis" facade. .SS AUDITOR OPTIONS .sp The following options must be in section “[auditor]” for the Taler |