taler-directory.conf.5 (10721B)
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-DIRECTORY.CONF" "5" "Mar 22, 2026" "1.0" "GNU Taler" 31 .SH NAME 32 taler-directory.conf \- Taler directory 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\-directory/config.d/\fP\&. 107 The configuration file given with \fB\-c\fP to taler\-directory 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\-directory\-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 “[directory]” 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: \fBhttp://localhost:11000\fP 125 .TP 126 .B BIND_TO 127 What interface/port to bind to. 128 Default: \fBlocalhost:11000\fP 129 .TP 130 .B SALT 131 The salt used when hading the alises internally. Should be unique per directory. 132 Default: \fBChangeMe\fP 133 .TP 134 .B DEFAULT_DOC_FILETYPE 135 Default filetype sent when privacy policy o TOS are served. 136 Default: \fBtext/html\fP 137 .TP 138 .B DEFAULT_DOC_LANG 139 Default language sent when privacy policy o TOS are served. 140 Default\(dq \fBen\fP 141 .TP 142 .B DEFAULT_TOS_PATH 143 Default path where TOS is found. 144 Default: \fBterms/\fP 145 .TP 146 .B DEFAULT_PP_PATH 147 Default path there privacy policy is found. 148 Default: \fBpp/\fP 149 .TP 150 .B SUPPORTED_DOC_FILETYPES 151 Supported filetypes for privacy policy and TOS. 152 Default: \fBtext/html application/pdf application/epub application/xml text/plain\fP 153 .TP 154 .B MERCHANT_BASE_URL 155 The base URL of the merchant instance to use. 156 Default: \fBhttps://backend.demo.taler.net\fP 157 .TP 158 .B MERCHANT_TOKEN 159 The API token to use for the merchant instance. 160 Default: \fBsandbox\fP 161 .TP 162 .B CHALLENGE_BYTES 163 Number of bytes of the challenge. 164 Default: \fB16\fP 165 .TP 166 .B VALIDATION_INITIATION_MAX 167 Maximum number of pending validations for the same alias. 168 Default: \fB3\fP 169 .TP 170 .B SOLUTION_ATTEMPT_MAX 171 Maximum times a solution may be attempted for an active validation. 172 Default: \fB3\fP 173 .TP 174 .B VALIDATION_TIMEFRAME 175 Cooldown period between two successive validation requests (for the same alias). 176 Default: \fB5m\fP 177 .TP 178 .B SOLUTION_ATTEMPT_TIMEFRAME 179 Duration for which a solution must be provided for any given validation. 180 Default: \fB1h\fP 181 .TP 182 .B VALIDATION_EXPIRATION 183 Time until a pending validation expires 184 Default: \fB24h\fP 185 .TP 186 .B VALID_PAYMENT_SYSTEM_ADDRESS_REGEX 187 Defines valid payment system addresses that may be registered. 188 Default: \fB\&.*\fP 189 .TP 190 .B MONTHLY_FEE 191 Cost for registration of a single month. 192 Default: \fBKUDOS:0\fP 193 .TP 194 .B NAVIGATION 195 The navigation (header) HTML template file. If relative will be interpreted relative to DATADIR. 196 Default: \fBweb/templates/nav.html\fP 197 .TP 198 .B FOOTER 199 The footer HTML template file. If relative will be interpreted relative to DATADIR. 200 Default: \fBweb/templates/footer.html\fP 201 .TP 202 .B IMPRINT_PAGE 203 The imprint HTML template file. If relative will be interpreted relative to DATADIR. 204 Default: \fBweb/templates/imprint.html\fP 205 .TP 206 .B ABOUT_PAGE 207 The about HTML template file. If relative will be interpreted relative to DATADIR. 208 Default: \fBweb/templates/about.html\fP 209 .TP 210 .B LANDING_PAGE 211 The landing page HTML template file. If relative will be interpreted relative to DATADIR. 212 Default: \fBweb/templates/landing.html\fP 213 .TP 214 .B VALIDATION_LANDING 215 The validation landing HTML template file. If relative will be interpreted relative to DATADIR. 216 Default: \fBweb/templates/validation_landing.html\fP 217 .TP 218 .B LOOKUP_RESULT_PAGE 219 The lookup result HTML template file. If relative will be interpreted relative to DATADIR. 220 Default: \fBweb/templates/validation_landing.html\fP 221 .UNINDENT 222 .sp 223 The following options are from a “[directory\-<validator>]” section. 224 .INDENT 0.0 225 .TP 226 .B ENABLED 227 Is this validator enabled or disabled. 228 Default: \fBfalse\fP 229 .TP 230 .B TYPE 231 What type of validator is this. Options: \fBcommand\fP, \fBoidc\fP\&. 232 Default: \fBcommand\fP 233 .TP 234 .B CHALLENGE_FEE 235 What does the initiation of a challenge cost. 236 Default: \fBKUDOS:0\fP 237 .TP 238 .B VALID_ALIAS_REGEX 239 Defines which aliases are valid in this validator context. 240 Default: empty 241 .TP 242 .B COMMAND 243 Only when TYPE \fBcommand\fP\&. The command to execute. Must be set if TYPE is \fBcommand\fP\&. 244 Default: unset 245 .TP 246 .B SENDER 247 What should the sender of the email be. Only read by the email validator. 248 Default: unset 249 .TP 250 .B AUTHORIZATION_ENDPOINT 251 Only when TYPE \fBoidc\fP\&. The URI of the authorization endpoint. 252 Default: unset 253 .TP 254 .B TOKEN_ENDPOINT 255 Only when TYPE \fBoidc\fP\&. The URI of the token endpoint. 256 Default: unset 257 .TP 258 .B USERINFO_ENDPOINT 259 Only when TYPE \fBoidc\fP\&. The URI of the userinfo endpoint. 260 Default: unset 261 .TP 262 .B CLIENT_ID 263 Only when TYPE \fBoidc\fP\&. The OAuth client_id. 264 Default: unset 265 .TP 266 .B CLIENT_SECRET 267 Only when TYPE \fBoidc\fP\&. The OAuth client_secret. 268 Default: unset 269 .TP 270 .B SCOPE 271 Only when TYPE \fBoidc\fP\&. The OAuth scope(s) to request. 272 Default: unset 273 .TP 274 .B ALIAS_CLAIM 275 Only when TYPE \fBoidc\fP\&. The claim to read from the userinfo response. Must be equal to the alias that is being validated. 276 Default: \fBsub\fP 277 .UNINDENT 278 .sp 279 The following options are from a “[directory\-<disseminator>]” section. 280 .INDENT 0.0 281 .TP 282 .B ENABLED 283 Is this disseminator enabled or disabled. 284 Default: \fBfalse\fP 285 .TP 286 .B ZONE 287 The name (not ZEKY) of the local zone authoritative for publication of the directory. 288 Default: unset 289 .TP 290 .B EXPIRATION 291 The relative expiration time of the record sets. 292 Default: \fB1d\fP 293 .UNINDENT 294 .SH SEE ALSO 295 .sp 296 taler\-directory\-dbinit(1), taler\-directory\-httpd(1), taler\-directory\-config(1). 297 .SH BUGS 298 .sp 299 Report bugs by using \X'tty: link https://bugs.taler.net/'\fI\%https://bugs.taler.net/\fP\X'tty: link' or by sending electronic 300 mail to <\X'tty: link mailto:taler@gnu.org'\fI\%taler@gnu.org\fP\X'tty: link'>. 301 .SH AUTHOR 302 GNU Taler contributors 303 .SH COPYRIGHT 304 2014-2025 Taler Systems SA (GPLv3+ or GFDL 1.3+) 305 .\" Generated by docutils manpage writer. 306 .