diff options
Diffstat (limited to 'doc/anastasis.conf.5')
-rw-r--r-- | doc/anastasis.conf.5 | 151 |
1 files changed, 151 insertions, 0 deletions
diff --git a/doc/anastasis.conf.5 b/doc/anastasis.conf.5 new file mode 100644 index 0000000..446531a --- /dev/null +++ b/doc/anastasis.conf.5 | |||
@@ -0,0 +1,151 @@ | |||
1 | .\" Man page generated from reStructuredText. | ||
2 | . | ||
3 | .TH "ANASTASIS.CONF" "5" "Jul 18, 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 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 | ||
87 | Annual fee to be paid for policy uploads, i.e. “EUR:1.5”. | ||
88 | .TP | ||
89 | .B TRUTH_UPLOAD_FEE | ||
90 | Annual fee to be paid for truth uploads, i.e. “EUR:1.5”. | ||
91 | .TP | ||
92 | .B DB | ||
93 | Database backend to use, only \fBpostgres\fP is supported right now. | ||
94 | .TP | ||
95 | .B UPLOAD_LIMIT_MB | ||
96 | Maximum upload size for policy uploads in megabytes. Default is 1. | ||
97 | .TP | ||
98 | .B ANNUAL_POLICY_UPLOAD_LIMIT | ||
99 | Maximum number of policies uploaded per year of service. Default is 42. | ||
100 | .TP | ||
101 | .B BUSINESS_NAME | ||
102 | Name of the business. | ||
103 | .TP | ||
104 | .B SERVER_SALT | ||
105 | Must be set to a high\-entropy random server salt that the provider must never | ||
106 | change after the initial configuration. | ||
107 | .TP | ||
108 | .B PORT | ||
109 | TCP port on which the HTTP service should listen on. | ||
110 | .UNINDENT | ||
111 | .SS Authorization options | ||
112 | .sp | ||
113 | For each active authorization plugin, options must be configured in | ||
114 | a section called \fB[authorization\-$PLUGIN]\fP where \fB$PLUGIN\fP is | ||
115 | the name of the authorization plugin. | ||
116 | .INDENT 0.0 | ||
117 | .TP | ||
118 | .B COST | ||
119 | Fee the user has to pay to obtain a challenge from this | ||
120 | authorization plugin during recovery. | ||
121 | .TP | ||
122 | .B ENABLED | ||
123 | \fByes\fP to enable this plugin, \fBno\fP to disable. | ||
124 | .TP | ||
125 | .B COMMAND | ||
126 | Helper command to run (only relevant for some plugins). | ||
127 | .UNINDENT | ||
128 | .SS Postgres database configuration | ||
129 | .sp | ||
130 | 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 | ||
132 | \fB[anastasis]\fP section. | ||
133 | .INDENT 0.0 | ||
134 | .TP | ||
135 | .B CONFIG | ||
136 | Path under which the Postgres database is that the service | ||
137 | should use, i.e. \fBpostgres://anastasis\fP\&. | ||
138 | .UNINDENT | ||
139 | .SH SEE ALSO | ||
140 | .sp | ||
141 | anastasis\-httpd(1), anastasis\-config(1) | ||
142 | .SH BUGS | ||
143 | .sp | ||
144 | Report bugs by using \fI\%https://bugs.anastasis.lu/\fP or by sending electronic | ||
145 | mail to <\fI\%contact@anastasis.lu\fP>. | ||
146 | .SH AUTHOR | ||
147 | Anastasis SARL | ||
148 | .SH COPYRIGHT | ||
149 | 2020-2021 Anastasis SARL (AGPLv3+ or GFDL 1.3+) | ||
150 | .\" Generated by docutils manpage writer. | ||
151 | . | ||