1 7edcf2b3 2023-06-24 op .\" Copyright (c) 2022, 2023 Omar Polo <op@omarpolo.com>
3 1595c277 2022-04-07 op .\" Permission to use, copy, modify, and distribute this software for any
4 1595c277 2022-04-07 op .\" purpose with or without fee is hereby granted, provided that the above
5 1595c277 2022-04-07 op .\" copyright notice and this permission notice appear in all copies.
7 1595c277 2022-04-07 op .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 1595c277 2022-04-07 op .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 1595c277 2022-04-07 op .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 1595c277 2022-04-07 op .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 1595c277 2022-04-07 op .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 1595c277 2022-04-07 op .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 1595c277 2022-04-07 op .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14 56d32bb5 2023-07-24 op .Dd July 24, 2023
15 1595c277 2022-04-07 op .Dt GMID.CONF 5
19 1595c277 2022-04-07 op .Nd gmid Gemini server configuration file
20 1595c277 2022-04-07 op .Sh DESCRIPTION
22 1595c277 2022-04-07 op is the configuration file format for the
24 1595c277 2022-04-07 op Gemini server.
26 7edcf2b3 2023-06-24 op The configuration file is divided into the following sections:
27 7edcf2b3 2023-06-24 op .Bl -tag -width Ds
29 1595c277 2022-04-07 op User-defined variables may be defined and used later, simplifying the
30 1595c277 2022-04-07 op configuration file.
31 1595c277 2022-04-07 op .It Sy Global Options
32 1595c277 2022-04-07 op Global settings for
34 1595c277 2022-04-07 op .It Sy Servers
35 1595c277 2022-04-07 op Virtual hosts definition.
37 1595c277 2022-04-07 op Media types and extensions.
40 1595c277 2022-04-07 op Within the sections, empty lines are ignored and comments can be put
41 1595c277 2022-04-07 op anywhere in the file using a hash mark
43 1595c277 2022-04-07 op and extend to the end of the current line.
44 1595c277 2022-04-07 op A boolean is either the symbol
48 1595c277 2022-04-07 op A string is a sequence of characters wrapped in double quotes,
49 1595c277 2022-04-07 op .Dq like this .
50 1595c277 2022-04-07 op Multiple strings one next to the other are joined into a single
52 1595c277 2022-04-07 op .Bd -literal -offset indent
53 1595c277 2022-04-07 op # equivalent to "temporary-failure"
54 1595c277 2022-04-07 op block return 40 "temporary" "-" "failure"
57 1595c277 2022-04-07 op Furthermore, quoting is necessary only when a string needs to contain
58 1595c277 2022-04-07 op special characters
59 1595c277 2022-04-07 op .Pq like spaces or punctuation ,
60 1595c277 2022-04-07 op something that looks like a number or a reserved keyword.
61 1595c277 2022-04-07 op The last example could have been written also as:
62 1595c277 2022-04-07 op .Bd -literal -offset indent
63 1595c277 2022-04-07 op block return 40 temporary "-" failure
66 1595c277 2022-04-07 op Strict ordering of the sections is not enforced, so that is possible
67 1595c277 2022-04-07 op to mix macros, options and
70 1595c277 2022-04-07 op However, defining all the
72 1595c277 2022-04-07 op blocks after the macros and the global options is recommended.
74 1595c277 2022-04-07 op Newlines are often optional, except around top-level instructions, and
77 1595c277 2022-04-07 op can also be optionally used to separate options.
79 1595c277 2022-04-07 op Additional configuration files can be included with the
81 1595c277 2022-04-07 op keyword, for example:
82 1595c277 2022-04-07 op .Bd -literal -offset indent
83 1595c277 2022-04-07 op include "/etc/gmid.conf.local"
86 1595c277 2022-04-07 op Macros can be defined that will later be expanded in context.
87 1595c277 2022-04-07 op Macro names must start with a letter, digit or underscore and may
88 1595c277 2022-04-07 op contain any of those characters.
89 1595c277 2022-04-07 op Macros names may not be reserved words.
90 1595c277 2022-04-07 op Macros are not expanded inside quotes.
92 1595c277 2022-04-07 op Two kinds of macros are supported: variable-like and proper macros.
93 1595c277 2022-04-07 op When a macro is invoked with a
95 1595c277 2022-04-07 op before its name its expanded as a string, whereas when it's invoked
98 1595c277 2022-04-07 op its expanded in-place.
101 1595c277 2022-04-07 op .Bd -literal -offset indent
102 547437cc 2023-08-01 op ext_ip = "10.0.0.1"
103 1595c277 2022-04-07 op dir = "/var/gemini"
104 1595c277 2022-04-07 op certdir = "/etc/keys"
105 1595c277 2022-04-07 op common = "lang it; auto index on"
107 1595c277 2022-04-07 op server "foo" {
108 547437cc 2023-08-01 op listen on $ext_ip
109 7edcf2b3 2023-06-24 op root $dir "/foo" # "/var/gemini/foo"
110 7edcf2b3 2023-06-24 op cert $certdir "/foo.pem" # "/etc/keys/foo.pem"
111 7edcf2b3 2023-06-24 op key $certdir "/foo.key" # "/etc/keys/foo.key"
115 1595c277 2022-04-07 op .Ss Global Options
116 1595c277 2022-04-07 op .Bl -tag -width 12m
117 1595c277 2022-04-07 op .It Ic chroot Ar path
119 1595c277 2022-04-07 op the process to the given
121 1595c277 2022-04-07 op The daemon has to be run with root privileges and thus the option
123 7edcf2b3 2023-06-24 op needs to be provided too, so privileges can be dropped afterwards.
124 7edcf2b3 2023-06-24 op All the paths in the configuration file are relative to the chroot
125 7edcf2b3 2023-06-24 op directory, except for the
131 287ab865 2023-06-24 op Defaults to the
133 287ab865 2023-06-24 op home directory, if provided.
134 226f13ec 2023-07-24 op .It Ic log Ar options
135 226f13ec 2023-07-24 op Specify logging options.
136 226f13ec 2023-07-24 op Multiple options may be provided within curly braces.
137 226f13ec 2023-07-24 op The available options are as follows:
138 226f13ec 2023-07-24 op .Bl -tag -width Ds
139 226f13ec 2023-07-24 op .It Ic access Ar file
140 226f13ec 2023-07-24 op Log the requests to
142 4acf495f 2023-07-24 op The path is relative to the
144 abd261d2 2023-07-25 op .It Ic style Ar style
145 abd261d2 2023-07-25 op Set the logging style, defaults to
149 abd261d2 2023-07-25 op can be one of:
150 abd261d2 2023-07-25 op .Bl -tag -width Ds
151 abd261d2 2023-07-25 op .It Ic common
152 abd261d2 2023-07-25 op Attempt to be compatible with the default Apache httpd log format.
153 abd261d2 2023-07-25 op Each line is formatted as follows: the matching host name,
154 abd261d2 2023-07-25 op the remote IP address, one dash
156 abd261d2 2023-07-25 op Common Name of the client certificate
157 abd261d2 2023-07-25 op .Pq if provided, '-' otherwise ,
158 abd261d2 2023-07-25 op the timestamp of the request, the request URI wrapped in double quotes,
159 abd261d2 2023-07-25 op the response code and the size of the response.
160 abd261d2 2023-07-25 op .It Ic combined
161 abd261d2 2023-07-25 op Attempt to be compatible with the default nginx log format.
162 abd261d2 2023-07-25 op Each line is formatted as follows: the remote IP address, one dash
164 abd261d2 2023-07-25 op Common Name of the client certificate
165 abd261d2 2023-07-25 op .Pq if provided, '-' otherwise ,
166 abd261d2 2023-07-25 op the timestamp wrapped in square brackets, the request URI wrapped in
167 abd261d2 2023-07-25 op double quotes, the response code, the size of the response, a dash
168 abd261d2 2023-07-25 op wrapped in double quotes and "".
169 abd261d2 2023-07-25 op The strangness of these two last fields is because Gemini doesn't have
170 abd261d2 2023-07-25 op the notion of the
172 abd261d2 2023-07-25 op header nor the
173 abd261d2 2023-07-25 op .Dq User-agent .
174 a250aff2 2023-08-04 op .\" .It Ic condensed
175 a250aff2 2023-08-04 op .\" The native
176 a250aff2 2023-08-04 op .\" .Xr gmid 8
177 a250aff2 2023-08-04 op .\" format since 2.0.
178 a250aff2 2023-08-04 op .\" Each line is formatted as follows: RFC 3339 date time,
179 a250aff2 2023-08-04 op .\" remote IP address, Common Name of the client certificate
180 a250aff2 2023-08-04 op .\" .Pq if provided, '-' otherwise ,
181 a250aff2 2023-08-04 op .\" the matching host name, the request URI, the size of the request,
182 a250aff2 2023-08-04 op .\" the size of the response, the response code and meta.
183 abd261d2 2023-07-25 op .It Ic legacy
184 abd261d2 2023-07-25 op Each line is formatted as follows: the remote IP address and port, the
186 abd261d2 2023-07-25 op keyword, the request URI, the response code and meta.
188 0c39da51 2023-07-26 op .It Ic syslog Op Ic off
189 0c39da51 2023-07-26 op Log to syslog.
190 0c39da51 2023-07-26 op It is enabled by default, use the
192 0c39da51 2023-07-26 op argument to disable.
193 9abba172 2023-08-07 op .It Ic syslog facility Ar facility
196 9abba172 2023-08-07 op using specified
197 9abba172 2023-08-07 op .Ar facility .
198 9abba172 2023-08-07 op Available facilities are as follows: daemon, ftp, local0 through local7 and
200 9abba172 2023-08-07 op These are case insensitive and can be prefixed with
202 9abba172 2023-08-07 op Not all level may be available on all operating systems.
203 9abba172 2023-08-07 op The default facility is
204 9abba172 2023-08-07 op .Ev LOG_DAEMON .
206 1595c277 2022-04-07 op .It Ic prefork Ar number
207 1595c277 2022-04-07 op Run the specified number of server processes.
208 1595c277 2022-04-07 op This increases the performance and prevents delays when connecting to
211 1595c277 2022-04-07 op runs 3 server processes by default.
212 1595c277 2022-04-07 op The maximum number allowed is 16.
213 1595c277 2022-04-07 op .It Ic protocols Ar string
214 1595c277 2022-04-07 op Specify the TLS protocols to enable.
216 1595c277 2022-04-07 op .Xr tls_config_parse_protocols 3
217 1595c277 2022-04-07 op for the valid protocol string values.
218 1595c277 2022-04-07 op By default, both TLSv1.3 and TLSv1.2 are enabled.
221 1595c277 2022-04-07 op to enable only TLSv1.3.
222 1595c277 2022-04-07 op .It Ic user Ar string
223 1595c277 2022-04-07 op Run the daemon as the given user.
224 2c079c9e 2023-08-01 op Mandatory if the
226 2c079c9e 2023-08-01 op option is used.
229 1595c277 2022-04-07 op Every virtual host is defined by a
232 1595c277 2022-04-07 op .Bl -tag -width Ds
233 1595c277 2022-04-07 op .It Ic server Ar hostname Brq ...
234 1595c277 2022-04-07 op Match the server name using shell globbing rules.
235 1595c277 2022-04-07 op It can be an explicit name,
236 1595c277 2022-04-07 op .Ar www.example.com ,
237 1595c277 2022-04-07 op or a name including a wildcards,
238 1595c277 2022-04-07 op .Ar *.example.com .
241 1595c277 2022-04-07 op Followed by a block of options that is enclosed in curly brackets:
242 1595c277 2022-04-07 op .Bl -tag -width Ds
243 1595c277 2022-04-07 op .It Ic alias Ar name
244 1595c277 2022-04-07 op Specify an additional alias
246 1595c277 2022-04-07 op for this server.
247 1595c277 2022-04-07 op .It Ic auto Ic index Ar bool
248 1595c277 2022-04-07 op If no index file is found, automatically generate a directory listing.
249 1595c277 2022-04-07 op Disabled by default.
250 1595c277 2022-04-07 op .It Ic block Op Ic return Ar code Op Ar meta
251 1595c277 2022-04-07 op Send a reply and close the connection;
258 1595c277 2022-04-07 op .Dq temporary failure .
261 1595c277 2022-04-07 op is in the 3x range, then
263 1595c277 2022-04-07 op is mandatory.
266 1595c277 2022-04-07 op the following special sequences are supported:
267 1595c277 2022-04-07 op .Bl -tag -width Ds -compact
269 1595c277 2022-04-07 op is replaced with a single
272 1595c277 2022-04-07 op is replaced with the request path.
274 1595c277 2022-04-07 op is replaced with the query string of the request.
276 1595c277 2022-04-07 op is replaced with the server port.
278 1595c277 2022-04-07 op is replaced with the server name.
280 1595c277 2022-04-07 op .It Ic cert Ar file
281 1595c277 2022-04-07 op Path to the certificate to use for this server.
283 1595c277 2022-04-07 op should contain a PEM encoded certificate.
284 1595c277 2022-04-07 op This option is mandatory.
285 9b15e4c6 2022-09-08 op .It Ic default type Ar string
286 9b15e4c6 2022-09-08 op Set the default media type that is used if the media type for a
287 9b15e4c6 2022-09-08 op specified extension is not found.
288 9b15e4c6 2022-09-08 op If not specified, the
289 9b15e4c6 2022-09-08 op .Ic default type
291 9b15e4c6 2022-09-08 op .Dq application/octet-stream .
292 a1ba9650 2023-07-23 op .It Ic fastcgi Ar option
293 a1ba9650 2023-07-23 op Enable FastCGI instead of serving files.
294 a1ba9650 2023-07-23 op Multiple options may be specified within curly braces.
295 a1ba9650 2023-07-23 op Valid options are:
296 a1ba9650 2023-07-23 op .Bl -tag -width Ds
297 a1ba9650 2023-07-23 op .It Ic param Ar name Cm = Ar value
298 a1ba9650 2023-07-23 op Set the param
302 a1ba9650 2023-07-23 op .It Ic socket Oo Ic tcp Oc Ar socket Oo Cm port Ar port Oc
305 9b15e4c6 2022-09-08 op can either be a UNIX-domain socket or a TCP socket.
306 9b15e4c6 2022-09-08 op If the FastCGI application is listening on a UNIX domain socket,
308 9b15e4c6 2022-09-08 op is a local path name within the
310 9b15e4c6 2022-09-08 op root directory of
312 9b15e4c6 2022-09-08 op Otherwise, the
314 9b15e4c6 2022-09-08 op keyword must be provided and
316 9b15e4c6 2022-09-08 op is interpreted as a hostname or an IP address.
318 9b15e4c6 2022-09-08 op can be either a port number or the name of a service enclosed in
319 9b15e4c6 2022-09-08 op double quotes.
320 9b15e4c6 2022-09-08 op If not specified defaults to 9000.
321 03d671e2 2023-08-08 op .It Ic strip Ar number
324 03d671e2 2023-08-08 op leading path components from the
327 a1ba9650 2023-07-23 op The FastCGI handler will be given the following variables by default:
328 1595c277 2022-04-07 op .Bl -tag -width 24m
329 1595c277 2022-04-07 op .It Ev GATEWAY_INTERFACE
331 1595c277 2022-04-07 op .It Ev GEMINI_DOCUMENT_ROOT
332 1595c277 2022-04-07 op The root directory of the virtual host.
333 1595c277 2022-04-07 op .It Ev GEMINI_SCRIPT_FILENAME
334 9b15e4c6 2022-09-08 op Full path to the FastCGI script being executed.
335 1595c277 2022-04-07 op .It Ev GEMINI_URL
336 1595c277 2022-04-07 op The full IRI of the request.
337 1595c277 2022-04-07 op .It Ev GEMINI_URL_PATH
338 1595c277 2022-04-07 op The path of the request.
339 97b306cb 2022-11-27 op .It Ev GEMINI_SEARCH_STRING
341 97b306cb 2022-11-27 op .Ev QUERY_STRING
342 97b306cb 2022-11-27 op if defined in the request and if it doesn't contain any unencoded
344 97b306cb 2022-11-27 op characters, otherwise unset.
345 1595c277 2022-04-07 op .It Ev PATH_INFO
346 1595c277 2022-04-07 op The portion of the requested path that is derived from the the IRI
347 1595c277 2022-04-07 op path hierarchy following the part that identifies the script itself.
348 1595c277 2022-04-07 op Can be unset.
349 1595c277 2022-04-07 op .It Ev PATH_TRANSLATED
350 1595c277 2022-04-07 op Present if and only if
351 1595c277 2022-04-07 op .Ev PATH_INFO
353 1595c277 2022-04-07 op It represent the translation of the
354 1595c277 2022-04-07 op .Ev PATH_INFO .
356 1595c277 2022-04-07 op builds this by appending the
357 1595c277 2022-04-07 op .Ev PATH_INFO
358 1595c277 2022-04-07 op to the virtual host directory root.
359 1595c277 2022-04-07 op .It Ev QUERY_STRING
360 77718c12 2022-11-27 op The URL-encoded search or parameter string.
361 1595c277 2022-04-07 op .It Ev REMOTE_ADDR , Ev REMOTE_HOST
362 1595c277 2022-04-07 op Textual representation of the client IP.
363 1595c277 2022-04-07 op .It Ev REQUEST_METHOD
364 1595c277 2022-04-07 op This is present only for RFC3875 (CGI) compliance.
365 1595c277 2022-04-07 op It's always set to the empty string.
366 1595c277 2022-04-07 op .It Ev SCRIPT_NAME
367 9b15e4c6 2022-09-08 op The virtual URI path to the script.
368 1595c277 2022-04-07 op .It Ev SERVER_NAME
369 1595c277 2022-04-07 op The name of the server
370 1595c277 2022-04-07 op .It Ev SERVER_PORT
371 1595c277 2022-04-07 op The port the server is listening on.
372 1595c277 2022-04-07 op .It Ev SERVER_PROTOCOL
374 1595c277 2022-04-07 op .It Ev SERVER_SOFTWARE
375 1595c277 2022-04-07 op The name and version of the server, i.e.
376 1f6de749 2022-07-04 op .Dq gmid/1.8.4
377 1595c277 2022-04-07 op .It Ev AUTH_TYPE
378 1595c277 2022-04-07 op The string "Certificate" if the client used a certificate, otherwise
380 1595c277 2022-04-07 op .It Ev REMOTE_USER
381 1595c277 2022-04-07 op The subject of the client certificate if provided, otherwise unset.
382 1595c277 2022-04-07 op .It Ev TLS_CLIENT_ISSUER
383 1595c277 2022-04-07 op The is the issuer of the client certificate if provided, otherwise
385 1595c277 2022-04-07 op .It Ev TLS_CLIENT_HASH
386 1595c277 2022-04-07 op The hash of the client certificate if provided, otherwise unset.
387 1595c277 2022-04-07 op The format is
388 1595c277 2022-04-07 op .Dq ALGO:HASH .
389 1595c277 2022-04-07 op .It Ev TLS_VERSION
390 1595c277 2022-04-07 op The TLS version negotiated with the peer.
391 1595c277 2022-04-07 op .It Ev TLS_CIPHER
392 1595c277 2022-04-07 op The cipher suite negotiated with the peer.
393 1595c277 2022-04-07 op .It Ev TLS_CIPHER_STRENGTH
394 1595c277 2022-04-07 op The strength in bits for the symmetric cipher that is being used with
396 1595c277 2022-04-07 op .It Ev TLS_CLIENT_NOT_AFTER
397 1595c277 2022-04-07 op The time corresponding to the end of the validity period of the peer
398 1595c277 2022-04-07 op certificate in the ISO 8601 format
399 1595c277 2022-04-07 op .Pq e.g. Dq 2021-02-07T20:17:41Z .
400 1595c277 2022-04-07 op .It Ev TLS_CLIENT_NOT_BEFORE
401 1595c277 2022-04-07 op The time corresponding to the start of the validity period of the peer
402 1595c277 2022-04-07 op certificate in the ISO 8601 format.
404 6a8387e5 2023-07-23 op .It Ic fastcgi off
405 6a8387e5 2023-07-23 op Disable FastCGI handling in the current location.
406 a1ba9650 2023-07-23 op .It Ic index Ar string
407 a1ba9650 2023-07-23 op Set the directory index file.
408 a1ba9650 2023-07-23 op If not specified, it defaults to
409 a1ba9650 2023-07-23 op .Pa index.gmi .
410 a1ba9650 2023-07-23 op .It Ic key Ar file
411 a1ba9650 2023-07-23 op Specify the private key to use for this server.
413 a1ba9650 2023-07-23 op should contain a PEM encoded private key.
414 a1ba9650 2023-07-23 op This option is mandatory.
415 a1ba9650 2023-07-23 op .It Ic lang Ar string
416 a1ba9650 2023-07-23 op Specify the language tag for the text/gemini content served.
417 a1ba9650 2023-07-23 op If not specified, no
419 a1ba9650 2023-07-23 op parameter will be added in the response.
420 a1ba9650 2023-07-23 op .It Ic listen on Ar address Op Ic port Ar number
421 a1ba9650 2023-07-23 op Set the listen
425 a1ba9650 2023-07-23 op which defaults to
427 a1ba9650 2023-07-23 op This statement can be specified multiple times.
434 a1ba9650 2023-07-23 op will listen on all IPv4 and IPv6 addresses.
436 a1ba9650 2023-07-23 op can be used to listen on all IPv4 addresses and
438 a1ba9650 2023-07-23 op on all IPv6 addresses.
439 a1ba9650 2023-07-23 op .It Ic location Ar path Brq ...
440 a1ba9650 2023-07-23 op Specify server configuration rules for a specific location.
442 a1ba9650 2023-07-23 op argument will be matched against the request path with shell globbing
444 a1ba9650 2023-07-23 op In case of multiple location statements in the same context, the first
445 a1ba9650 2023-07-23 op matching location will be put into effect and the later ones ignored.
446 a1ba9650 2023-07-23 op Therefore is advisable to match for more specific paths first and for
447 a1ba9650 2023-07-23 op generic ones later on.
450 a1ba9650 2023-07-23 op section may include most of the server configuration rules
452 a1ba9650 2023-07-23 op .Ic alias , Ic cert , Ic key , Ic listen , Ic location
455 a1ba9650 2023-07-23 op .It Ic log Ar bool
456 a1ba9650 2023-07-23 op Enable or disable the logging for the current server or location block.
457 1595c277 2022-04-07 op .It Ic ocsp Ar file
458 1595c277 2022-04-07 op Specify an OCSP response to be stapled during TLS handshakes
459 1595c277 2022-04-07 op with this server.
462 1595c277 2022-04-07 op should contain a DER-format OCSP response retrieved from an
463 1595c277 2022-04-07 op OCSP server for the
466 1595c277 2022-04-07 op If the OCSP response in
468 1595c277 2022-04-07 op is empty, OCSP stapling will not be used.
469 1595c277 2022-04-07 op The default is to not use OCSP stapling.
470 d2da235a 2022-10-05 op .It Ic proxy Oo Cm proto Ar name Oc Oo Cm for-host Ar host Oo Cm port Ar port Oc Oc Brq ...
471 1595c277 2022-04-07 op Set up a reverse proxy.
472 1595c277 2022-04-07 op The optional matching rules
476 1595c277 2022-04-07 op can be used to enable proxying only for protocols matching
478 1595c277 2022-04-07 op .Po Dq gemini
481 1595c277 2022-04-07 op and/or whose request IRI matches
485 1595c277 2022-04-07 op .Pq 1965 by default .
486 1595c277 2022-04-07 op Matching happens using shell globbing rules.
488 1595c277 2022-04-07 op In case of multiple matching proxy blocks in the same context, the
489 1595c277 2022-04-07 op first matching proxy will be put into effect and the later ones
492 1595c277 2022-04-07 op Valid options are:
493 1595c277 2022-04-07 op .Bl -tag -width Ds
494 1595c277 2022-04-07 op .It Ic cert Ar file
495 1595c277 2022-04-07 op Specify the client certificate to use when making requests.
496 1595c277 2022-04-07 op .It Ic key Ar file
497 1595c277 2022-04-07 op Specify the client certificate key to use when making requests.
498 1595c277 2022-04-07 op .It Ic protocols Ar string
499 1595c277 2022-04-07 op Specify the TLS protocols allowed when making remote requests.
501 1595c277 2022-04-07 op .Xr tls_config_parse_protocols 3
502 1595c277 2022-04-07 op function for the valid protocol string values.
503 1595c277 2022-04-07 op By default, both TLSv1.2 and TLSv1.3 are enabled.
504 d2da235a 2022-10-05 op .It Ic relay-to Ar host Op Cm port Ar port
505 1595c277 2022-04-07 op Relay the request to the given
509 1595c277 2022-04-07 op 1965 by default.
510 1595c277 2022-04-07 op This is the only mandatory option in a
513 1595c277 2022-04-07 op .It Ic require Ic client Ic ca Ar file
514 1595c277 2022-04-07 op Allow the proxying only from clients that provide a certificate
515 1595c277 2022-04-07 op signed by the CA certificate in
517 1595c277 2022-04-07 op .It Ic sni Ar hostname
518 1595c277 2022-04-07 op Use the given
520 1595c277 2022-04-07 op instead of the one extracted from the
522 1595c277 2022-04-07 op rule for the TLS handshake with the proxied gemini server.
523 1595c277 2022-04-07 op .It Ic use-tls Ar bool
524 1595c277 2022-04-07 op Specify whether to use TLS when connecting to the proxied host.
525 1595c277 2022-04-07 op Enabled by default.
526 1595c277 2022-04-07 op .It Ic verifyname Ar bool
527 1595c277 2022-04-07 op Enable or disable the TLS server name verification.
528 1595c277 2022-04-07 op Enabled by default.
530 1595c277 2022-04-07 op .It Ic root Ar directory
531 1595c277 2022-04-07 op Specify the root directory for this server
532 1595c277 2022-04-07 op .Pq alas the current Dq document root .
533 1595c277 2022-04-07 op It's relative to the chroot if enabled.
534 1595c277 2022-04-07 op .It Ic require Ic client Ic ca Ar path
535 1595c277 2022-04-07 op Allow requests only from clients that provide a certificate signed by
536 1595c277 2022-04-07 op the CA certificate in
538 1595c277 2022-04-07 op It needs to be a PEM-encoded certificate and it's not relative to the
540 1595c277 2022-04-07 op .It Ic strip Ar number
543 1595c277 2022-04-07 op components from the beginning of the path before doing a lookup in the
544 1595c277 2022-04-07 op root directory.
545 1595c277 2022-04-07 op It's also considered for the
547 1595c277 2022-04-07 op parameter in the scope of a
548 1595c277 2022-04-07 op .Ic block return .
553 1595c277 2022-04-07 op section must include one or more lines of the following syntax, enclosed
554 1595c277 2022-04-07 op in curly brances:
555 1595c277 2022-04-07 op .Bl -tag -width Ds
556 7edcf2b3 2023-06-24 op .It Ar type Ns / Ns Ar subtype Ar name Op Ar name ...
557 1595c277 2022-04-07 op Set the media
561 1595c277 2022-04-07 op to the specified extension
563 1595c277 2022-04-07 op One or more names can be specified per line.
564 1595c277 2022-04-07 op Earch line may end with an optional semicolon.
565 1595c277 2022-04-07 op .It Ic include Ar file
566 1595c277 2022-04-07 op Include types definition from an external file, for example
567 1595c277 2022-04-07 op .Pa /usr/share/misc/mime.types .
572 5f03bf17 2022-04-08 op uses the following mapping if no
574 93cab6dc 2022-04-08 op block is defined:
576 1595c277 2022-04-07 op .Bl -tag -offset indent -width 15m -compact
577 1595c277 2022-04-07 op .It application/pdf
579 1595c277 2022-04-07 op .It image/gif
581 1595c277 2022-04-07 op .It image/jpeg
583 1595c277 2022-04-07 op .It image/png
585 1595c277 2022-04-07 op .It image/svg+xml
587 1595c277 2022-04-07 op .It text/gemini
589 1595c277 2022-04-07 op .It text/markdown
591 1595c277 2022-04-07 op .It text/x-patch
597 93cab6dc 2022-04-08 op As an exception,
599 93cab6dc 2022-04-08 op uses the MIME type
600 93cab6dc 2022-04-08 op .Ar text/gemini
601 93cab6dc 2022-04-08 op for file extensions
605 93cab6dc 2022-04-08 op if no mapping was found.
607 1595c277 2022-04-07 op The following is an example of a possible configuration for a site
608 1595c277 2022-04-07 op that enables only TLSv1.3, adds the MIME types mapping from
609 1595c277 2022-04-07 op .Pa /usr/share/misc/mime.types
610 1595c277 2022-04-07 op and defines two virtual host:
611 1595c277 2022-04-07 op .Bd -literal -offset indent
612 1595c277 2022-04-07 op protocols "tlsv1.3"
615 1595c277 2022-04-07 op include "/usr/share/misc/mime.types"
618 1595c277 2022-04-07 op server "example.com" {
619 7edcf2b3 2023-06-24 op listen on * port 1965
620 1595c277 2022-04-07 op cert "/etc/ssl/example.com.pem"
621 1595c277 2022-04-07 op key "/etc/ssl/private/example.com.key"
622 1595c277 2022-04-07 op root "/var/gemini/example.com"
625 1595c277 2022-04-07 op server "example.it" {
626 7edcf2b3 2023-06-24 op listen on * port 1965
627 1595c277 2022-04-07 op cert "/etc/ssl/example.it.pem"
628 1595c277 2022-04-07 op key "/etc/ssl/private/example.it.key"
629 1595c277 2022-04-07 op root "/var/gemini/example.it"
631 1595c277 2022-04-07 op # set the language for text/gemini files
636 1595c277 2022-04-07 op Yet another example, showing how to enable a
641 1595c277 2022-04-07 op .Bd -literal -offset indent
642 1595c277 2022-04-07 op chroot "/var/gemini"
645 1595c277 2022-04-07 op server "example.com" {
646 7edcf2b3 2023-06-24 op listen on * port 1965
648 1595c277 2022-04-07 op # absolute paths:
649 1595c277 2022-04-07 op cert "/etc/ssl/example.com.pem"
650 1595c277 2022-04-07 op key "/etc/ssl/private/example.com.key"
652 1595c277 2022-04-07 op # relative to the chroot:
653 1595c277 2022-04-07 op root "/example.com"
655 1595c277 2022-04-07 op location "/static/*" {
656 1595c277 2022-04-07 op # load the following rules only for
657 1595c277 2022-04-07 op # requests that matches "/static/*"
659 1595c277 2022-04-07 op auto index on
660 1595c277 2022-04-07 op index "index.gemini"
665 161651fa 2023-08-03 op This shows how to set up a reverse proxy: all request for
666 161651fa 2023-08-03 op .Sq example.com
667 161651fa 2023-08-03 op will be forwarded to 10.0.0.6 transparently.
668 161651fa 2023-08-03 op Proxying establish a new TLS connection, so any client-certificates used
669 161651fa 2023-08-03 op to connect to
671 161651fa 2023-08-03 op cannot be provided to the proxied server as well.
672 161651fa 2023-08-03 op .Bd -literal -offset indent
673 161651fa 2023-08-03 op server "example.com" {
674 161651fa 2023-08-03 op listen on * port 1965
675 161651fa 2023-08-03 op cert "/etc/ssl/example.com.pem"
676 161651fa 2023-08-03 op key "/etc/ssl/private/example.com.key"
678 161651fa 2023-08-03 op relay-to 10.0.0.6 port 1965
684 1595c277 2022-04-07 op .Xr slowcgi 8
689 1595c277 2022-04-07 op program was written by
690 1595c277 2022-04-07 op .An Omar Polo Aq Mt op@omarpolo.com .
