summaryrefslogtreecommitdiff
path: root/man/challenger.conf.5
blob: efeb216a5d751dbf57cb03948dee45ac5d6c5294 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
.\" Man page generated from reStructuredText.
.
.TH "CHALLENGER.CONF" "5" "Apr 16, 2023" "0.9" "GNU Taler"
.SH NAME
challenger.conf \- Challenger configuration file
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH DESCRIPTION
.sp
The configuration file is line\-oriented.
Blank lines and whitespace at the beginning and end of a line are ignored.
Comments start with \fB#\fP or \fB%\fP in the first column
(after any beginning\-of\-line whitespace) and go to the end of the line.
.sp
The file is split into sections.
Every section begins with “[SECTIONNAME]” and
contains a number of options of the form “OPTION=VALUE”.
There may be whitespace around the \fB=\fP (equal sign).
Section names and options are \fIcase\-insensitive\fP\&.
.sp
The values, however, are \fIcase\-sensitive\fP\&.
In particular, boolean values are one of \fBYES\fP or \fBNO\fP\&.
Values can include whitespace by surrounding
the entire value with \fB"\fP (double quote).
Note, however, that there are no escape characters in such strings;
all characters between the double quotes (including other double quotes)
are taken verbatim.
.sp
Values that represent filenames can begin with a \fB/bin/sh\fP\-like
variable reference.
This can be simple, such as \fB$TMPDIR/foo\fP, or complex,
such as \fB${TMPDIR:\-${TMP:\-/tmp}}/foo\fP\&.
See \fB[PATHS]\fP (below).
.sp
Values that represent a time duration are represented as a series
of one or more \fBNUMBER UNIT\fP pairs, e.g. \fB60 s\fP, \fB4 weeks 1 day\fP,
\fB5 years 2 minutes\fP\&.
.sp
Values that represent an amount are in the usual amount syntax:
\fBCURRENCY:VALUE.FRACTION\fP, e.g. \fBEUR:1.50\fP\&.
The \fBFRACTION\fP portion may extend up to 8 places.
.sp
Files containing default values for many of the options described below
are installed under \fB$PREFIX/share/challenger/config.d/\fP\&.
The configuration file given with \fB\-c\fP to Challenger binaries
overrides these defaults.
.sp
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\&.
.sp
Be extra careful when using \fBchallenger\-config \-V VALUE\fP to change configuration
values: it will destroy all uses of \fB@INLINE@\fP and furthermore remove all
comments from the configuration file!
.SS GLOBAL OPTIONS
.sp
The following options are from the “[challenger]” section.
This is normally the only section in a challenger.conf file.
.INDENT 0.0
.TP
.B SERVE
This can either be \fBtcp\fP or \fBunix\fP\&.
.TP
.B PORT
Port on which the HTTP server listens, e.g.\ 9967.
Only used if \fBSERVE\fP is \fBtcp\fP\&.
.TP
.B BIND_TO
Which IP address should we bind to?  E.g. \fB127.0.0.1\fP or \fB::1\fP
for loopback.  Can also be given as a hostname.  We will bind to
the wildcard (dual\-stack) if left empty.
Only used if \fBSERVE\fP is \fBtcp\fP\&.
.TP
.B UNIXPATH
Which unix domain path should we bind to?
Only used if \fBSERVE\fP is \fBunix\fP\&.
.TP
.B UNIXPATH_MODE = 660
What should be the file access permissions for \fBUNIXPATH\fP?
Only used if \fBSERVE\fP is \fBunix\fP\&.
.TP
.B DB
Plugin to use for the database, e.g.\ “postgres”.
.UNINDENT
.SH SEE ALSO
.sp
challenger\-dbinit(1), challenger\-httpd(1), challenger\-config(1).
.SH BUGS
.sp
Report bugs by using \fI\%https://bugs.taler.net/\fP or by sending electronic
mail to <\fI\%taler@gnu.org\fP>.
.SH AUTHOR
GNU Taler contributors
.SH COPYRIGHT
2014-2022 Taler Systems SA (GPLv3+ or GFDL 1.3+)
.\" Generated by docutils manpage writer.
.