taler-mailbox.conf.5 (6660B)
1 .\" Man page generated from reStructuredText. 2 . 3 . 4 .nr rst2man-indent-level 0 5 . 6 .de1 rstReportMargin 7 \\$1 \\n[an-margin] 8 level \\n[rst2man-indent-level] 9 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] 10 - 11 \\n[rst2man-indent0] 12 \\n[rst2man-indent1] 13 \\n[rst2man-indent2] 14 .. 15 .de1 INDENT 16 .\" .rstReportMargin pre: 17 . RS \\$1 18 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] 19 . nr rst2man-indent-level +1 20 .\" .rstReportMargin post: 21 .. 22 .de UNINDENT 23 . RE 24 .\" indent \\n[an-margin] 25 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] 26 .nr rst2man-indent-level -1 27 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] 28 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u 29 .. 30 .TH "TALER-MAILBOX.CONF" "5" "Mar 21, 2026" "1.0" "GNU Taler" 31 .SH NAME 32 taler-mailbox.conf \- Taler mailbox configuration file 33 .SH DESCRIPTION 34 .sp 35 The configuration file is line\-oriented. Blank lines and whitespace at the 36 beginning and end of a line are ignored. Comments start with \fB#\fP or \fB%\fP 37 in the first column (after any beginning\-of\-line whitespace) and go to the end 38 of the line. 39 .sp 40 The file is split into sections. Every section begins with \fB[SECTIONNAME]\fP 41 and contains a number of options of the form \fBOPTION=VALUE\fP\&. There may be 42 whitespace around the \fB=\fP (equal sign). Section names and options are 43 \fIcase\-insensitive\fP\&. 44 .sp 45 The values, however, are \fIcase\-sensitive\fP\&. In particular, boolean values are 46 one of \fBYES\fP or \fBNO\fP\&. Values can include whitespace by surrounding the 47 entire value with \fB\(dq\fP (double quote). Note, however, that there are no 48 escape characters in such strings; all characters between the double quotes 49 (including other double quotes) are taken verbatim. 50 .sp 51 Values that represent a time duration are represented as a series 52 of one or more \fBNUMBER UNIT\fP pairs, e.g. \fB60 s\fP, \fB4 weeks 1 day\fP, 53 \fB5 years 2 minutes\fP\&. 54 .sp 55 Values that represent an amount are in the usual amount syntax: 56 \fBCURRENCY:VALUE.FRACTION\fP, e.g. \fBEUR:1.50\fP\&. 57 The \fBFRACTION\fP portion may extend up to 8 places. 58 .sp 59 Values that represent filenames can begin with a \fB/bin/sh\fP\-like variable 60 reference. This can be simple, such as \fB$TMPDIR/foo\fP, or complex, such as 61 \fB${TMPDIR:\-${TMP:\-/tmp}}/foo\fP\&. The variables are expanded either using 62 key\-values from the \fB[PATHS]\fP section (see below) or from the environment 63 (\fBgetenv()\fP). The values from \fB[PATHS]\fP take precedence over those from 64 the environment. If the variable name is found in neither \fB[PATHS]\fP nor the 65 environment, a warning is printed and the value is left unchanged. Variables (including those from the environment) are expanded recursively, so if \fBFOO=$BAR\fP and \fBBAR=buzz\fP then the result is \fBFOO=buzz\fP\&. Recursion is bounded to at most 128 levels to avoid undefined behavior for mutually recursive expansions like if \fBBAR=$FOO\fP in the example above. 66 .sp 67 The \fB[PATHS]\fP section is special in that it contains paths that can be 68 referenced using \fB$\fP in other configuration values that specify 69 \fIfilenames\fP\&. Note that configuration options that are not specifically 70 retrieved by the application as \fIfilenames\fP will not see “$”\-expressions 71 expanded. To expand \fB$\fP\-expressions when using \fBtaler\-config\fP, you must pass 72 the \fB\-f\fP command\-line option. 73 .sp 74 The system automatically pre\-populates the \fB[PATHS]\fP section with a few values 75 at run\-time (in addition to the values that are in the actual configuration 76 file and automatically overwriting those values if they are present). 77 These automatically generated values refer to installation properties 78 from \X'tty: link https://www.gnu.org/prep/standards/html_node/Directory-Variables.html'\fI\%GNU autoconf\fP\X'tty: link'\&. The 79 values are usually dependent on an \fBINSTALL_PREFIX\fP which is determined by 80 the \fB\-\-prefix\fP option given to configure. The canonical values are: 81 .INDENT 0.0 82 .IP \(bu 2 83 LIBEXECDIR = $INSTALL_PREFIX/taler/libexec/ 84 .IP \(bu 2 85 DOCDIR = $INSTALL_PREFIX/share/doc/taler/ 86 .IP \(bu 2 87 ICONDIR = $INSTALL_PREFIX/share/icons/ 88 .IP \(bu 2 89 LOCALEDIR = $INSTALL_PREFIX/share/locale/ 90 .IP \(bu 2 91 PREFIX = $INSTALL_PREFIX/ 92 .IP \(bu 2 93 BINDIR = $INSTALL_PREFIX/bin/ 94 .IP \(bu 2 95 LIBDIR = $INSTALL_PREFIX/lib/taler/ 96 .IP \(bu 2 97 DATADIR = $INSTALL_PREFIX/share/taler/ 98 .UNINDENT 99 .sp 100 Note that on some platforms, the given paths may differ depending 101 on how the system was compiled or installed, the above are just the 102 canonical locations of the various resources. These 103 automatically generated values are never written to disk. 104 .sp 105 Files containing default values for many of the options described below 106 are installed under \fB$PREFIX/share/taler\-mailbox/config.d/\fP\&. 107 The configuration file given with \fB\-c\fP to taler\-mailbox binaries 108 overrides these defaults. 109 .sp 110 A configuration file may include another, by using the \fB@INLINE@\fP directive, 111 for example, in \fBmain.conf\fP, you could write \fB@INLINE@ sub.conf\fP to 112 include the entirety of \fBsub.conf\fP at that point in \fBmain.conf\fP\&. 113 .sp 114 Be extra careful when using \fBtaler\-mailbox\-config \-V VALUE\fP to change configuration 115 values: it will destroy all uses of \fB@INLINE@\fP and furthermore remove all 116 comments from the configuration file! 117 .SS GLOBAL OPTIONS 118 .sp 119 The following options are from the “[mailbox]” section. 120 .INDENT 0.0 121 .TP 122 .B BASE_URL 123 The base URL of the service. If your service is proxied, the external base URL this service is availiable at. 124 Default: \fBhttps://example.com\fP 125 .TP 126 .B MAX_BODY_BYTES 127 Number of bytes of the challenge. 128 Default: \fB256\fP 129 .TP 130 .B MESSAGE_RESPONSE_LIMIT 131 Maximum number of messages returned in a single response. 132 Default: \fB50\fP 133 .TP 134 .B MONTHLY_FEE 135 Monthly fee of this service. 136 Default: \fBKUDOS:0\fP 137 .TP 138 .B REGISTRATION_UPDATE_FEE 139 Registration modification fee. 140 Default: \fBKUDOS:0\fP 141 .TP 142 .B MESSAGE_FEE 143 Cost for sending a message to a mailbox. 144 Default: \fBKUDOS:0\fP 145 .TP 146 .B FREE_MESSAGE_QUOTA 147 Number of messages that can be sent for free 148 Default: \fB0\fP 149 .TP 150 .B PENDING_REGISTRATION_EXPIRATION 151 Lifetime of a pending (unpaid) registration until it is purged from the database. 152 Default: \fB24h\fP 153 .UNINDENT 154 .SH SEE ALSO 155 .sp 156 taler\-mailbox\-dbinit(1), taler\-mailbox\-httpd(1), taler\-mailbox\-config(1). 157 .SH BUGS 158 .sp 159 Report bugs by using \X'tty: link https://bugs.taler.net/'\fI\%https://bugs.taler.net/\fP\X'tty: link' or by sending electronic 160 mail to <\X'tty: link mailto:taler@gnu.org'\fI\%taler@gnu.org\fP\X'tty: link'>. 161 .SH AUTHOR 162 GNU Taler contributors 163 .SH COPYRIGHT 164 2014-2025 Taler Systems SA (GPLv3+ or GFDL 1.3+) 165 .\" Generated by docutils manpage writer. 166 .