diff options
Diffstat (limited to 'doc/anastasis.conf.5')
-rw-r--r-- | doc/anastasis.conf.5 | 61 |
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 @@ | |||
1 | .\" Man page generated from reStructuredText. | 1 | .\" Man page generated from reStructuredText. |
2 | . | 2 | . |
3 | .TH "ANASTASIS.CONF" "5" "Jul 18, 2021" "0.0" "Anastasis" | 3 | .TH "ANASTASIS.CONF" "5" "Aug 20, 2021" "0.0" "Anastasis" |
4 | .SH NAME | 4 | .SH NAME |
5 | anastasis.conf \- anastasis configuration file | 5 | anastasis.conf \- anastasis configuration file |
6 | . | 6 | . |
@@ -72,22 +72,18 @@ overrides these defaults. | |||
72 | A configuration file may include another, by using the \fB@INLINE@\fP directive, | 72 | A configuration file may include another, by using the \fB@INLINE@\fP directive, |
73 | for example, in \fBmain.conf\fP, you could write \fB@INLINE@ sub.conf\fP to | 73 | for example, in \fBmain.conf\fP, you could write \fB@INLINE@ sub.conf\fP to |
74 | include the entirety of \fBsub.conf\fP at that point in \fBmain.conf\fP\&. | 74 | include the entirety of \fBsub.conf\fP at that point in \fBmain.conf\fP\&. |
75 | .. TODO: Document ‘anastasis\-config \-V’ in light of ‘@INLINE@’ in taler\-config(1). | 75 | \&.. TODO: Document ‘anastasis\-config \-V’ in light of ‘@INLINE@’ in taler\-config(1). |
76 | .SS GLOBAL OPTIONS | 76 | .SS GLOBAL OPTIONS |
77 | .sp | 77 | .sp |
78 | The following options are from the \fB[anastasis]\fP section and used by | 78 | The following options are from the \fB[anastasis]\fP section and used by |
79 | the \fBanastasis\-httpd\fP service. | 79 | the \fBanastasis\-httpd\fP service. |
80 | .INDENT 0.0 | 80 | .INDENT 0.0 |
81 | .TP | 81 | .TP |
82 | .B PAYMENT_BACKEND_URL | ||
83 | Base\-URL of the Taler merchant backend instance to use for payments. | ||
84 | FIXME: How do we pass the access token? | ||
85 | .TP | ||
86 | .B ANNUAL_FEE | 82 | .B ANNUAL_FEE |
87 | Annual fee to be paid for policy uploads, i.e. “EUR:1.5”. | 83 | Annual fee to be paid for policy uploads, i.e. "EUR:1.5". |
88 | .TP | 84 | .TP |
89 | .B TRUTH_UPLOAD_FEE | 85 | .B TRUTH_UPLOAD_FEE |
90 | Annual fee to be paid for truth uploads, i.e. “EUR:1.5”. | 86 | Annual fee to be paid for truth uploads, i.e. "EUR:1.5". |
91 | .TP | 87 | .TP |
92 | .B DB | 88 | .B DB |
93 | Database backend to use, only \fBpostgres\fP is supported right now. | 89 | Database backend to use, only \fBpostgres\fP is supported right now. |
@@ -108,11 +104,25 @@ change after the initial configuration. | |||
108 | .B PORT | 104 | .B PORT |
109 | TCP port on which the HTTP service should listen on. | 105 | TCP port on which the HTTP service should listen on. |
110 | .UNINDENT | 106 | .UNINDENT |
107 | .SS Backend options | ||
108 | .sp | ||
109 | The following options are from the \fB[anastasis\-merchant\-backend]\fP section and used by | ||
110 | the \fBanastasis\-httpd\fP service. | ||
111 | .INDENT 0.0 | ||
112 | .TP | ||
113 | .B PAYMENT_BACKEND_URL | ||
114 | Base\-URL of the Taler merchant backend instance to use for payments. | ||
115 | .TP | ||
116 | .B API_KEY | ||
117 | API key to transmit to the merchant backend for authentication. | ||
118 | .UNINDENT | ||
111 | .SS Authorization options | 119 | .SS Authorization options |
112 | .sp | 120 | .sp |
113 | For each active authorization plugin, options must be configured in | 121 | For each active authorization plugin, options must be configured in a |
114 | a section called \fB[authorization\-$PLUGIN]\fP where \fB$PLUGIN\fP is | 122 | section called \fB[authorization\-$PLUGIN]\fP where \fB$PLUGIN\fP is the |
115 | the name of the authorization plugin. | 123 | name of the authorization plugin. Specific plugins may require |
124 | additional options, which are described in the respective sections | ||
125 | below. | ||
116 | .INDENT 0.0 | 126 | .INDENT 0.0 |
117 | .TP | 127 | .TP |
118 | .B COST | 128 | .B COST |
@@ -121,14 +131,39 @@ authorization plugin during recovery. | |||
121 | .TP | 131 | .TP |
122 | .B ENABLED | 132 | .B ENABLED |
123 | \fByes\fP to enable this plugin, \fBno\fP to disable. | 133 | \fByes\fP to enable this plugin, \fBno\fP to disable. |
134 | .UNINDENT | ||
135 | .SS SMS Authorization options | ||
136 | .INDENT 0.0 | ||
124 | .TP | 137 | .TP |
125 | .B COMMAND | 138 | .B COMMAND |
126 | Helper command to run (only relevant for some plugins). | 139 | Helper command to run to send SMS. |
140 | .UNINDENT | ||
141 | .SS Email Authorization options | ||
142 | .INDENT 0.0 | ||
143 | .TP | ||
144 | .B COMMAND | ||
145 | Helper command to run to send E\-mail. | ||
146 | .UNINDENT | ||
147 | .SS Post Authorization options | ||
148 | .INDENT 0.0 | ||
149 | .TP | ||
150 | .B COMMAND | ||
151 | Helper command to run to send physical mail. | ||
152 | .UNINDENT | ||
153 | .SS IBAN Authorization options | ||
154 | .INDENT 0.0 | ||
155 | .TP | ||
156 | .B CREDIT_IBAN | ||
157 | IBAN number where the consumers must | ||
158 | wire the money to for authentication. | ||
159 | .TP | ||
160 | .B BUSINESS_NAME | ||
161 | Name of the account holder. | ||
127 | .UNINDENT | 162 | .UNINDENT |
128 | .SS Postgres database configuration | 163 | .SS Postgres database configuration |
129 | .sp | 164 | .sp |
130 | The following options must be in the section \fB[statis\-postgres]\fP if | 165 | The following options must be in the section \fB[statis\-postgres]\fP if |
131 | \fBpostgress\fP was used for the database under \fBDB\fP in the | 166 | \fBpostgres\fP was used for the database under \fBDB\fP in the |
132 | \fB[anastasis]\fP section. | 167 | \fB[anastasis]\fP section. |
133 | .INDENT 0.0 | 168 | .INDENT 0.0 |
134 | .TP | 169 | .TP |