aboutsummaryrefslogtreecommitdiff
path: root/doc/anastasis.conf.5
diff options
context:
space:
mode:
Diffstat (limited to 'doc/anastasis.conf.5')
-rw-r--r--doc/anastasis.conf.5151
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
5anastasis.conf \- anastasis configuration file
6.
7.nr rst2man-indent-level 0
8.
9.de1 rstReportMargin
10\\$1 \\n[an-margin]
11level \\n[rst2man-indent-level]
12level 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
35The configuration file is line\-oriented.
36Blank lines and whitespace at the beginning and end of a line are ignored.
37Comments 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
40The file is split into sections.
41Every section begins with “[SECTIONNAME]” and
42contains a number of options of the form “OPTION=VALUE”.
43There may be whitespace around the \fB=\fP (equal sign).
44Section names and options are \fIcase\-insensitive\fP\&.
45.sp
46The values, however, are \fIcase\-sensitive\fP\&.
47In particular, boolean values are one of \fBYES\fP or \fBNO\fP\&.
48Values can include whitespace by surrounding
49the entire value with \fB"\fP (double quote).
50Note, however, that there are no escape characters in such strings;
51all characters between the double quotes (including other double quotes)
52are taken verbatim.
53.sp
54Values that represent filenames can begin with a \fB/bin/sh\fP\-like
55variable reference.
56This can be simple, such as \fB$TMPDIR/foo\fP, or complex,
57such as \fB${TMPDIR:\-${TMP:\-/tmp}}/foo\fP\&.
58See \fB[PATHS]\fP (below).
59.sp
60Values that represent a time duration are represented as a series of one or
61more \fBNUMBER UNIT\fP pairs, e.g. \fB60 s\fP, \fB4 weeks 1 day\fP, \fB5 years 2 minutes\fP\&.
62.sp
63Values that represent an amount are in the usual amount syntax:
64\fBCURRENCY:VALUE.FRACTION\fP, e.g. \fBEUR:1.50\fP\&.
65The \fBFRACTION\fP portion may extend up to 8 places.
66.sp
67Files containing default values for many of the options described below
68are installed under \fB$ANASTASIS_PREFIX/share/taler/config.d/\fP\&.
69The configuration file given with \fB\-c\fP to Anastasis binaries
70overrides these defaults.
71.sp
72A configuration file may include another, by using the \fB@INLINE@\fP directive,
73for example, in \fBmain.conf\fP, you could write \fB@INLINE@ sub.conf\fP to
74include 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
78The following options are from the \fB[anastasis]\fP section and used by
79the \fBanastasis\-httpd\fP service.
80.INDENT 0.0
81.TP
82.B PAYMENT_BACKEND_URL
83Base\-URL of the Taler merchant backend instance to use for payments.
84FIXME: How do we pass the access token?
85.TP
86.B ANNUAL_FEE
87Annual fee to be paid for policy uploads, i.e. “EUR:1.5”.
88.TP
89.B TRUTH_UPLOAD_FEE
90Annual fee to be paid for truth uploads, i.e. “EUR:1.5”.
91.TP
92.B DB
93Database backend to use, only \fBpostgres\fP is supported right now.
94.TP
95.B UPLOAD_LIMIT_MB
96Maximum upload size for policy uploads in megabytes. Default is 1.
97.TP
98.B ANNUAL_POLICY_UPLOAD_LIMIT
99Maximum number of policies uploaded per year of service. Default is 42.
100.TP
101.B BUSINESS_NAME
102Name of the business.
103.TP
104.B SERVER_SALT
105Must be set to a high\-entropy random server salt that the provider must never
106change after the initial configuration.
107.TP
108.B PORT
109TCP port on which the HTTP service should listen on.
110.UNINDENT
111.SS Authorization options
112.sp
113For each active authorization plugin, options must be configured in
114a section called \fB[authorization\-$PLUGIN]\fP where \fB$PLUGIN\fP is
115the name of the authorization plugin.
116.INDENT 0.0
117.TP
118.B COST
119Fee the user has to pay to obtain a challenge from this
120authorization plugin during recovery.
121.TP
122.B ENABLED
123\fByes\fP to enable this plugin, \fBno\fP to disable.
124.TP
125.B COMMAND
126Helper command to run (only relevant for some plugins).
127.UNINDENT
128.SS Postgres database configuration
129.sp
130The 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
136Path under which the Postgres database is that the service
137should use, i.e. \fBpostgres://anastasis\fP\&.
138.UNINDENT
139.SH SEE ALSO
140.sp
141anastasis\-httpd(1), anastasis\-config(1)
142.SH BUGS
143.sp
144Report bugs by using \fI\%https://bugs.anastasis.lu/\fP or by sending electronic
145mail to <\fI\%contact@anastasis.lu\fP>.
146.SH AUTHOR
147Anastasis SARL
148.SH COPYRIGHT
1492020-2021 Anastasis SARL (AGPLv3+ or GFDL 1.3+)
150.\" Generated by docutils manpage writer.
151.