anastasis.conf.5 (6091B)
1 .\" Man page generated from reStructuredText. 2 . 3 .TH "ANASTASIS.CONF" "5" "Aug 24, 2021" "0.0" "Anastasis" 4 .SH NAME 5 anastasis.conf \- anastasis configuration file 6 . 7 .nr rst2man-indent-level 0 8 . 9 .de1 rstReportMargin 10 \\$1 \\n[an-margin] 11 level \\n[rst2man-indent-level] 12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] 13 - 14 \\n[rst2man-indent0] 15 \\n[rst2man-indent1] 16 \\n[rst2man-indent2] 17 .. 18 .de1 INDENT 19 .\" .rstReportMargin pre: 20 . RS \\$1 21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] 22 . nr rst2man-indent-level +1 23 .\" .rstReportMargin post: 24 .. 25 .de UNINDENT 26 . RE 27 .\" indent \\n[an-margin] 28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] 29 .nr rst2man-indent-level -1 30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] 31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u 32 .. 33 .SH DESCRIPTION 34 .sp 35 The configuration file is line\-oriented. 36 Blank lines and whitespace at the beginning and end of a line are ignored. 37 Comments start with \fB#\fP or \fB%\fP in the first column 38 (after any beginning\-of\-line whitespace) and go to the end of the line. 39 .sp 40 The file is split into sections. 41 Every section begins with “[SECTIONNAME]” and 42 contains a number of options of the form “OPTION=VALUE”. 43 There may be whitespace around the \fB=\fP (equal sign). 44 Section names and options are \fIcase\-insensitive\fP\&. 45 .sp 46 The values, however, are \fIcase\-sensitive\fP\&. 47 In particular, boolean values are one of \fBYES\fP or \fBNO\fP\&. 48 Values can include whitespace by surrounding 49 the entire value with \fB"\fP (double quote). 50 Note, however, that there are no escape characters in such strings; 51 all characters between the double quotes (including other double quotes) 52 are taken verbatim. 53 .sp 54 Values that represent filenames can begin with a \fB/bin/sh\fP\-like 55 variable reference. 56 This can be simple, such as \fB$TMPDIR/foo\fP, or complex, 57 such as \fB${TMPDIR:\-${TMP:\-/tmp}}/foo\fP\&. 58 See \fB[PATHS]\fP (below). 59 .sp 60 Values that represent a time duration are represented as a series of one or 61 more \fBNUMBER UNIT\fP pairs, e.g. \fB60 s\fP, \fB4 weeks 1 day\fP, \fB5 years 2 minutes\fP\&. 62 .sp 63 Values that represent an amount are in the usual amount syntax: 64 \fBCURRENCY:VALUE.FRACTION\fP, e.g. \fBEUR:1.50\fP\&. 65 The \fBFRACTION\fP portion may extend up to 8 places. 66 .sp 67 Files containing default values for many of the options described below 68 are installed under \fB$ANASTASIS_PREFIX/share/taler/config.d/\fP\&. 69 The configuration file given with \fB\-c\fP to Anastasis binaries 70 overrides these defaults. 71 .sp 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 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). 76 .SS GLOBAL OPTIONS 77 .sp 78 The following options are from the \fB[anastasis]\fP section and used by 79 the \fBanastasis\-httpd\fP service. 80 .INDENT 0.0 81 .TP 82 .B ANNUAL_FEE 83 Annual fee to be paid for policy uploads, i.e. "EUR:1.5". 84 .TP 85 .B TRUTH_UPLOAD_FEE 86 Annual fee to be paid for truth uploads, i.e. "EUR:1.5". 87 .TP 88 .B DB 89 Database backend to use, only \fBpostgres\fP is supported right now. 90 .TP 91 .B UPLOAD_LIMIT_MB 92 Maximum upload size for policy uploads in megabytes. Default is 1. 93 .TP 94 .B ANNUAL_POLICY_UPLOAD_LIMIT 95 Maximum number of policies uploaded per year of service. Default is 42. 96 .TP 97 .B BUSINESS_NAME 98 Name of the business. 99 .TP 100 .B SERVER_SALT 101 Must be set to a high\-entropy random server salt that the provider must never 102 change after the initial configuration. 103 .TP 104 .B PORT 105 TCP port on which the HTTP service should listen on. 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 119 .SS Authorization options 120 .sp 121 For each active authorization plugin, options must be configured in a 122 section called \fB[authorization\-$PLUGIN]\fP where \fB$PLUGIN\fP is the 123 name of the authorization plugin. Specific plugins may require 124 additional options, which are described in the respective sections 125 below. 126 .INDENT 0.0 127 .TP 128 .B COST 129 Fee the user has to pay to obtain a challenge from this 130 authorization plugin during recovery. 131 .TP 132 .B ENABLED 133 \fByes\fP to enable this plugin, \fBno\fP to disable. 134 .UNINDENT 135 .SS SMS Authorization options 136 .INDENT 0.0 137 .TP 138 .B COMMAND 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. 162 .TP 163 .B WIRE_GATEWAY_URL 164 Base URL of the LibEuFin wire gateway (Anastasis facade). 165 .TP 166 .B WIRE_GATEWAY_AUTH_METHOD 167 Authentication method used to talk to the LibEuFin wire gateway, i.e. \(aqbasic\(aq for HTTP basic authentication. 168 .TP 169 .B USERNAME 170 Username to use when using HTTP basic authentication. 171 .TP 172 .B PASSWORD 173 Password to use when using HTTP basic authentication. 174 .UNINDENT 175 .SS Postgres database configuration 176 .sp 177 The following options must be in the section \fB[statis\-postgres]\fP if 178 \fBpostgres\fP was used for the database under \fBDB\fP in the 179 \fB[anastasis]\fP section. 180 .INDENT 0.0 181 .TP 182 .B CONFIG 183 Path under which the Postgres database is that the service 184 should use, i.e. \fBpostgres://anastasis\fP\&. 185 .UNINDENT 186 .SH SEE ALSO 187 .sp 188 anastasis\-httpd(1), anastasis\-config(1) 189 .SH BUGS 190 .sp 191 Report bugs by using \fI\%https://bugs.anastasis.lu/\fP or by sending electronic 192 mail to <\fI\%contact@anastasis.lu\fP>. 193 .SH AUTHOR 194 Anastasis SARL 195 .SH COPYRIGHT 196 2020-2021 Anastasis SARL (AGPLv3+ or GFDL 1.3+) 197 .\" Generated by docutils manpage writer. 198 .