summaryrefslogtreecommitdiff
path: root/doc/anastasis.conf.5
diff options
context:
space:
mode:
Diffstat (limited to 'doc/anastasis.conf.5')
-rw-r--r--doc/anastasis.conf.561
1 files changed, 48 insertions, 13 deletions
diff --git a/doc/anastasis.conf.5 b/doc/anastasis.conf.5
index 446531a..e23f7b8 100644
--- a/doc/anastasis.conf.5
+++ b/doc/anastasis.conf.5
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "ANASTASIS.CONF" "5" "Jul 18, 2021" "0.0" "Anastasis"
+.TH "ANASTASIS.CONF" "5" "Aug 20, 2021" "0.0" "Anastasis"
.SH NAME
anastasis.conf \- anastasis configuration file
.
@@ -72,22 +72,18 @@ overrides these defaults.
A configuration file may include another, by using the \fB@INLINE@\fP directive,
for example, in \fBmain.conf\fP, you could write \fB@INLINE@ sub.conf\fP to
include the entirety of \fBsub.conf\fP at that point in \fBmain.conf\fP\&.
-.. TODO: Document ‘anastasis\-config \-V’ in light of ‘@INLINE@’ in taler\-config(1).
+\&.. TODO: Document ‘anastasis\-config \-V’ in light of ‘@INLINE@’ in taler\-config(1).
.SS GLOBAL OPTIONS
.sp
The following options are from the \fB[anastasis]\fP section and used by
the \fBanastasis\-httpd\fP service.
.INDENT 0.0
.TP
-.B PAYMENT_BACKEND_URL
-Base\-URL of the Taler merchant backend instance to use for payments.
-FIXME: How do we pass the access token?
-.TP
.B ANNUAL_FEE
-Annual fee to be paid for policy uploads, i.e. “EUR:1.5”.
+Annual fee to be paid for policy uploads, i.e. "EUR:1.5".
.TP
.B TRUTH_UPLOAD_FEE
-Annual fee to be paid for truth uploads, i.e. “EUR:1.5”.
+Annual fee to be paid for truth uploads, i.e. "EUR:1.5".
.TP
.B DB
Database backend to use, only \fBpostgres\fP is supported right now.
@@ -108,11 +104,25 @@ change after the initial configuration.
.B PORT
TCP port on which the HTTP service should listen on.
.UNINDENT
+.SS Backend options
+.sp
+The following options are from the \fB[anastasis\-merchant\-backend]\fP section and used by
+the \fBanastasis\-httpd\fP service.
+.INDENT 0.0
+.TP
+.B PAYMENT_BACKEND_URL
+Base\-URL of the Taler merchant backend instance to use for payments.
+.TP
+.B API_KEY
+API key to transmit to the merchant backend for authentication.
+.UNINDENT
.SS Authorization options
.sp
-For each active authorization plugin, options must be configured in
-a section called \fB[authorization\-$PLUGIN]\fP where \fB$PLUGIN\fP is
-the name of the authorization plugin.
+For each active authorization plugin, options must be configured in a
+section called \fB[authorization\-$PLUGIN]\fP where \fB$PLUGIN\fP is the
+name of the authorization plugin. Specific plugins may require
+additional options, which are described in the respective sections
+below.
.INDENT 0.0
.TP
.B COST
@@ -121,14 +131,39 @@ authorization plugin during recovery.
.TP
.B ENABLED
\fByes\fP to enable this plugin, \fBno\fP to disable.
+.UNINDENT
+.SS SMS Authorization options
+.INDENT 0.0
.TP
.B COMMAND
-Helper command to run (only relevant for some plugins).
+Helper command to run to send SMS.
+.UNINDENT
+.SS Email Authorization options
+.INDENT 0.0
+.TP
+.B COMMAND
+Helper command to run to send E\-mail.
+.UNINDENT
+.SS Post Authorization options
+.INDENT 0.0
+.TP
+.B COMMAND
+Helper command to run to send physical mail.
+.UNINDENT
+.SS IBAN Authorization options
+.INDENT 0.0
+.TP
+.B CREDIT_IBAN
+IBAN number where the consumers must
+wire the money to for authentication.
+.TP
+.B BUSINESS_NAME
+Name of the account holder.
.UNINDENT
.SS Postgres database configuration
.sp
The following options must be in the section \fB[statis\-postgres]\fP if
-\fBpostgress\fP was used for the database under \fBDB\fP in the
+\fBpostgres\fP was used for the database under \fBDB\fP in the
\fB[anastasis]\fP section.
.INDENT 0.0
.TP