1 f28d96d3 2021-01-25 op .\" Copyright (c) 2021 Omar Polo <op@omarpolo.com>
3 3e4749f7 2020-10-02 op .\" Permission to use, copy, modify, and distribute this software for any
4 3e4749f7 2020-10-02 op .\" purpose with or without fee is hereby granted, provided that the above
5 3e4749f7 2020-10-02 op .\" copyright notice and this permission notice appear in all copies.
7 3e4749f7 2020-10-02 op .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 3e4749f7 2020-10-02 op .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 3e4749f7 2020-10-02 op .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 3e4749f7 2020-10-02 op .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 3e4749f7 2020-10-02 op .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 3e4749f7 2020-10-02 op .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 3e4749f7 2020-10-02 op .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14 39a7b611 2021-01-30 op .Dd $Mdocdate: January 30 2021$
19 714685c1 2021-01-30 op .Nd simple and secure Gemini server
24 15902770 2021-01-15 op .Op Fl c Ar config
25 8b743dda 2021-06-29 op .Op Fl D Ar macro Ns = Ns Ar value
26 8e8b2e25 2021-04-28 op .Op Fl P Ar pidfile
31 f28d96d3 2021-01-25 op .Op Fl d Pa certs-dir
32 f28d96d3 2021-01-25 op .Op Fl H Ar hostname
33 721e2325 2020-11-18 op .Op Fl p Ar port
34 f28d96d3 2021-01-25 op .Op Fl x Pa cgi
37 3e4749f7 2020-10-02 op .Sh DESCRIPTION
39 8ff40039 2021-05-24 op is a simple and minimal gemini server that can serve static files,
40 8ff40039 2021-05-24 op execute CGI scripts and talk to FastCGI applications.
41 eb699783 2021-01-18 op It can run without a configuration file with a limited set of features
45 3007f565 2021-02-04 op rereads the configuration file when it receives
48 eb699783 2021-01-18 op The options are as follows:
49 f28d96d3 2021-01-25 op .Bl -tag -width 14m
50 eb699783 2021-01-18 op .It Fl c Pa config
51 f28d96d3 2021-01-25 op Specify the configuration file.
52 8b743dda 2021-06-29 op .It Fl D Ar macro Ns = Ns Ar value
57 8b743dda 2021-06-29 op on the command line.
58 8b743dda 2021-06-29 op Overrides the definition of
60 8b743dda 2021-06-29 op in the config file if present.
62 46af8c6c 2021-01-27 op Stays and logs on the foreground.
64 eb699783 2021-01-18 op Check that the configuration is valid, but don't start the server.
65 8e8b2e25 2021-04-28 op .It Fl P Pa pidfile
68 8e8b2e25 2021-04-28 op pid to the given path.
71 eb699783 2021-01-18 op If no configuration file is given,
73 f28d96d3 2021-01-25 op will look for the following options
74 f28d96d3 2021-01-25 op .Bl -tag -width 14m
77 f28d96d3 2021-01-25 op .It Fl d Pa certs-path
78 f28d96d3 2021-01-25 op Directory where certificates for the config-less mode are stored.
80 f28d96d3 2021-01-25 op .Pa $XDG_DATA_HOME/gmid ,
82 f28d96d3 2021-01-25 op .Pa ~/.local/share/gmid .
83 71cf3975 2021-01-25 op .It Fl H Ar hostname
84 f28d96d3 2021-01-25 op The hostname, by default
85 f28d96d3 2021-01-25 op .Ar localhost .
86 f28d96d3 2021-01-25 op Certificates for the given
88 f28d96d3 2021-01-25 op are searched inside the
90 f28d96d3 2021-01-25 op directory given with the
93 714685c1 2021-01-30 op They have the form
94 f28d96d3 2021-01-25 op .Pa hostname.cert.pem
96 f28d96d3 2021-01-25 op .Pa hostname.key.pem .
97 1de92289 2021-04-15 op If a certificate or key don't exists for a given hostname they
98 714685c1 2021-01-30 op will be automatically generated.
99 ba65dcc8 2021-06-29 op .It Fl h , Fl -help
100 fab952e1 2020-10-03 op Print the usage and exit.
101 721e2325 2020-11-18 op .It Fl p Ar port
102 eb699783 2021-01-18 op The port to listen on, by default 1965.
103 ba65dcc8 2021-06-29 op .It Fl V , Fl -version
104 ba65dcc8 2021-06-29 op Print the version and exit.
106 3abf91b0 2021-02-07 op Verbose mode.
109 3abf91b0 2021-02-07 op options increase the verbosity.
110 f28d96d3 2021-01-25 op .It Fl x Pa path
111 eb699783 2021-01-18 op Enable execution of CGI scripts.
112 eb699783 2021-01-18 op See the description of the
114 eb699783 2021-01-18 op option in the section
116 eb699783 2021-01-18 op below to learn how
118 eb699783 2021-01-18 op is processed.
119 eb699783 2021-01-18 op Cannot be provided more than once.
121 f28d96d3 2021-01-25 op The root directory to serve.
122 f28d96d3 2021-01-25 op By default the current working directory is assumed.
124 eb699783 2021-01-18 op .Sh CONFIGURATION FILE
125 8b743dda 2021-06-29 op The configuration file is divided into three sections:
126 eb699783 2021-01-18 op .Bl -tag -width xxxx
127 8b743dda 2021-06-29 op .It Sy Macros
128 8b743dda 2021-06-29 op User-defined variables may be defined and used later, simplifying the
129 8b743dda 2021-06-29 op configuration file.
130 eb699783 2021-01-18 op .It Sy Global Options
131 eb699783 2021-01-18 op Global settings for
133 eb699783 2021-01-18 op .It Sy Servers
134 f28d96d3 2021-01-25 op Virtual hosts definition.
137 eb699783 2021-01-18 op Within the sections, empty lines are ignored and comments can be put
138 eb699783 2021-01-18 op anywhere in the file using a hash mark
140 eb699783 2021-01-18 op and extend to the end of the current line.
141 eb699783 2021-01-18 op A boolean is either the symbol
145 f28d96d3 2021-01-25 op A string is a sequence of characters wrapped in double quotes,
146 f28d96d3 2021-01-25 op .Dq like this .
147 eaf7f776 2021-06-29 op Multiple strings one next to the other are joined into a single
149 eaf7f776 2021-06-29 op .Bd -literal -offset indent
150 eaf7f776 2021-06-29 op # equivalent to "temporary-failure"
151 eaf7f776 2021-06-29 op block return 40 "temporary" "-" "failure"
154 8b743dda 2021-06-29 op Strict ordering of the sections is not enforced, so that is possible
155 8b743dda 2021-06-29 op to mix macros, options and
158 8b743dda 2021-06-29 op However, defining all the
160 8b743dda 2021-06-29 op blocks after the macros and the global options is recommended.
162 8b743dda 2021-06-29 op Macros can be defined that will later be expanded in context.
163 8b743dda 2021-06-29 op Macro names must start with a letter, digit or underscore and may
164 8b743dda 2021-06-29 op contain any of those characters.
165 4f9a2760 2021-07-02 op Macros names may not be reserved words.
166 bfb076ed 2021-06-29 op Macros are not expanded inside quotes.
169 8b743dda 2021-06-29 op .Bd -literal -offset indent
170 8b743dda 2021-06-29 op dir = "/var/gemini"
171 8b743dda 2021-06-29 op cert = "/etc/keys"
173 8b743dda 2021-06-29 op server "foo" {
174 4ede0fe4 2021-06-29 op root $dir "/foo" # -> /var/gemini/foo
175 4ede0fe4 2021-06-29 op cert $cert "/foo.crt" # -> /etc/keys/foo.crt
176 4ede0fe4 2021-06-29 op key $cert "/foo.pem" # -> /etc/keys/foo.pem
179 eb699783 2021-01-18 op .Ss Global Options
180 eb699783 2021-01-18 op .Bl -tag -width 12m
181 ae08ec7d 2021-01-25 op .It Ic chroot Pa path
183 ae08ec7d 2021-01-25 op the process to the given
185 ae08ec7d 2021-01-25 op The daemon has to be run with root privileges and thus the option
187 714685c1 2021-01-30 op needs to be provided, so privileges can be dropped.
190 714685c1 2021-01-30 op will enter the chroot after loading the TLS keys, but before opening
191 714685c1 2021-01-30 op the virtual host root directories.
192 714685c1 2021-01-30 op It's recommended to keep the TLS keys outside the chroot.
193 ae08ec7d 2021-01-25 op Future version of
195 1de92289 2021-04-15 op may enforce this.
196 2b92a447 2021-02-06 op .It Ic ipv6 Ar bool
197 2b92a447 2021-02-06 op Enable or disable IPv6 support.
198 2b92a447 2021-02-06 op By default is off.
199 2b92a447 2021-02-06 op .It Ic mime Ar mime-type Ar file-extension
200 2b92a447 2021-02-06 op Add a mapping for the given
201 2b92a447 2021-02-06 op .Ar file-extension
203 2b92a447 2021-02-06 op .Ar mime-type .
204 2b92a447 2021-02-06 op Both argument are strings.
205 2b92a447 2021-02-06 op .It Ic port Ar portno
206 2b92a447 2021-02-06 op The port to listen on.
207 2b92a447 2021-02-06 op By default is 1965.
208 a709ddf5 2021-02-07 op .It Ic prefork Ar number
209 a709ddf5 2021-02-07 op Run the specified number of server processes.
210 a709ddf5 2021-02-07 op This increases the performance and prevents delays when connecting to
213 a709ddf5 2021-02-07 op runs 3 server processes by default, when not in config-less mode.
214 2c3e53da 2021-03-03 op The maximum number allowed is 16.
215 2b92a447 2021-02-06 op .It Ic protocols Ar string
216 2b92a447 2021-02-06 op Specify the TLS protocols to enable.
218 2b92a447 2021-02-06 op .Xr tls_config_parse_protocols 3
219 2b92a447 2021-02-06 op for the valid protocol string values.
220 2b92a447 2021-02-06 op By default, both TLSv1.3 and TLSv1.2 are enabled.
223 2b92a447 2021-02-06 op to enable only TLSv1.3.
224 ae08ec7d 2021-01-25 op .It Ic user Ar string
225 ae08ec7d 2021-01-25 op Run the daemon as the given user.
228 eb699783 2021-01-18 op Every virtual host is defined by a
231 eb699783 2021-01-18 op .Bl -tag -width Ds
232 eb699783 2021-01-18 op .It Ic server Ar hostname Brq ...
233 75fbb178 2021-01-28 op Match the server name using shell globbing rules.
234 75fbb178 2021-01-28 op This can be an explicit name,
235 de27389e 2021-01-21 op .Ar www.example.com ,
236 de27389e 2021-01-21 op or a name including a wildcards,
237 de27389e 2021-01-21 op .Ar *.example.com .
240 eb699783 2021-01-18 op Followed by a block of options that is enclosed in curly brackets:
241 eb699783 2021-01-18 op .Bl -tag -width Ds
242 cc8c2901 2021-04-29 op .It Ic alias Ar name
243 cc8c2901 2021-04-29 op Specify an additional alias
245 cc8c2901 2021-04-29 op for this server.
246 2b92a447 2021-02-06 op .It Ic auto Ic index Ar bool
247 2b92a447 2021-02-06 op If no index file is found, automatically generate a directory listing.
248 2b92a447 2021-02-06 op It's disabled by default.
249 2b92a447 2021-02-06 op .It Ic block Op Ic return Ar code Op Ar meta
250 2b92a447 2021-02-06 op Send a reply and close the connection;
256 2b92a447 2021-02-06 op .Dq temporary failure
260 2b92a447 2021-02-06 op is in the 3x range, then
262 2b92a447 2021-02-06 op must be provided.
265 2b92a447 2021-02-06 op the following special sequences are replaced:
266 fd1ae83d 2021-06-11 op .Bl -tag -width Ds -compact
268 2b92a447 2021-02-06 op is replaced with a single
271 2b92a447 2021-02-06 op is replaced with the request path.
273 2b92a447 2021-02-06 op is replaced with the query string of the request.
275 2b92a447 2021-02-06 op is replaced with the server port.
277 2b92a447 2021-02-06 op is replaced with the server name.
279 eb699783 2021-01-18 op .It Ic cert Pa file
280 eb699783 2021-01-18 op Path to the certificate to use for this server.
283 eb699783 2021-01-18 op should contain a PEM encoded certificate.
284 eb699783 2021-01-18 op This option is mandatory.
285 eb699783 2021-01-18 op .It Ic cgi Pa path
286 87f2b68b 2021-02-02 op Execute CGI scripts that matches
288 87f2b68b 2021-02-02 op using shell globbing rules.
289 6119e13e 2021-01-19 op .It Ic default type Ar string
290 6119e13e 2021-01-19 op Set the default media type that is used if the media type for a
291 6119e13e 2021-01-19 op specified extension is not found.
292 6119e13e 2021-01-19 op If not specified, the
293 6119e13e 2021-01-19 op .Ic default type
295 6119e13e 2021-01-19 op .Dq application/octet-stream .
296 2b92a447 2021-02-06 op .It Ic entrypoint Pa path
297 dafaf467 2021-04-15 op Handle all the requests for the current virtual host using the
298 dafaf467 2021-04-15 op CGI script at
300 9cc630aa 2021-04-28 op .It Ic env Ar name Ar value
301 9cc630aa 2021-04-28 op Set the environment variable
305 9cc630aa 2021-04-28 op when executing CGI scripts.
306 9cc630aa 2021-04-28 op Can be provided more than once.
307 8ff40039 2021-05-24 op .\" don't document the "spawn <prog>" form because it probably won't
309 8ff40039 2021-05-24 op .It Ic fastcgi Oo Ic tcp Oc Pa socket Oo Ar port Oc
310 8ff40039 2021-05-24 op Enable FastCGI instead of serving files.
313 8ff40039 2021-05-24 op can either be a UNIX domain socket or a TCP socket.
314 8ff40039 2021-05-24 op If the FastCGI application is listening on a UNIX domain socket,
316 8ff40039 2021-05-24 op is a local path name within the
318 8ff40039 2021-05-24 op root directory of
320 8ff40039 2021-05-24 op Otherwise, the
322 8ff40039 2021-05-24 op keyword must be provided and
324 8ff40039 2021-05-24 op is interpreted as a hostname or an IP address.
326 8ff40039 2021-05-24 op can be either a port number or the name of a service enclosed in
327 8ff40039 2021-05-24 op double quotes.
328 8ff40039 2021-05-24 op If it's not specified defaults to 9000.
329 2b92a447 2021-02-06 op .It Ic index Ar string
330 2b92a447 2021-02-06 op Set the directory index file.
331 2b92a447 2021-02-06 op If not specified, it defaults to
332 2b92a447 2021-02-06 op .Pa index.gmi .
333 2b92a447 2021-02-06 op .It Ic key Pa file
334 2b92a447 2021-02-06 op Specify the private key to use for this server.
337 2b92a447 2021-02-06 op should contain a PEM encoded private key.
338 2b92a447 2021-02-06 op This option is mandatory.
339 05c23a54 2021-01-19 op .It Ic lang Ar string
340 05c23a54 2021-01-19 op Specify the language tag for the text/gemini content served.
341 05c23a54 2021-01-19 op If not specified, no
343 05c23a54 2021-01-19 op parameter will be added in the response.
344 c8b74339 2021-01-24 op .It Ic location Pa path Brq ...
345 c8b74339 2021-01-24 op Specify server configuration rules for a specific location.
348 c8b74339 2021-01-24 op argument will be matched against the request path with shell globbing
350 6016a593 2021-01-30 op In case of multiple location statements in the same context, the first
351 6016a593 2021-01-30 op matching location will be put into effect and the later ones ignored.
352 6016a593 2021-01-30 op Therefore is advisable to match for more specific paths first and for
353 6016a593 2021-01-30 op generic ones later on.
356 c8b74339 2021-01-24 op section may include most of the server configuration rules
358 fdea6aa0 2021-04-30 op .Ic alias , Ic cert , Ic env , Ic key , Ic location ,
359 e3ddf390 2021-02-06 op .Ic entrypoint No and Ic cgi .
360 2c43dcce 2021-06-17 op .It Ic log Ar bool
361 2c43dcce 2021-06-17 op Enable or disable the logging for the current server or location block.
362 ada16f87 2021-06-11 op .It Ic param Ar name Ar value
363 ada16f87 2021-06-11 op Set the param
368 2b92a447 2021-02-06 op .It Ic root Pa directory
369 2b92a447 2021-02-06 op Specify the root directory for this server.
370 2b92a447 2021-02-06 op It's relative to the chroot, if enabled.
371 02be96c6 2021-02-09 op .It Ic require Ic client Ic ca Pa path
372 02be96c6 2021-02-09 op Allow requests only from clients that provide a certificate signed by
373 02be96c6 2021-02-09 op the CA certificate in
375 02be96c6 2021-02-09 op It needs to be a PEM-encoded certificate and it's not relative to the
377 6abda252 2021-02-06 op .It Ic strip Ar number
380 0773413c 2021-05-15 op components from the beginning of the path before doing a lookup in the
381 0773413c 2021-05-15 op root directory.
382 0773413c 2021-05-15 op It's also considered for the
384 2b92a447 2021-02-06 op parameter in the scope of a
385 6abda252 2021-02-06 op .Ic block return .
388 87f2b68b 2021-02-02 op When a request for an executable file matches the
390 87f2b68b 2021-02-02 op rule, that file will be execute and its output fed to the client.
392 ee655e64 2021-02-01 op The CGI scripts are executed in the directory they reside and inherit
393 a7b9bb4d 2021-01-24 op the environment from
395 0ed56567 2020-11-06 op with these additional variables set:
396 ee655e64 2021-02-01 op .Bl -tag -width 24m
397 28ec6178 2021-01-24 op .It Ev GATEWAY_INTERFACE
399 ee655e64 2021-02-01 op .It Ev GEMINI_DOCUMENT_ROOT
400 ee655e64 2021-02-01 op The root directory of the virtual host.
401 ee655e64 2021-02-01 op .It Ev GEMINI_SCRIPT_FILENAME
402 ee655e64 2021-02-01 op Full path to the CGI script being executed.
403 ee655e64 2021-02-01 op .It Ev GEMINI_URL
404 ee655e64 2021-02-01 op The full IRI of the request.
405 ee655e64 2021-02-01 op .It Ev GEMINI_URL_PATH
406 ee655e64 2021-02-01 op The path of the request.
407 ee655e64 2021-02-01 op .It Ev PATH_INFO
408 ee655e64 2021-02-01 op The portion of the requested path that is derived from the the IRI
409 ee655e64 2021-02-01 op path hierarchy following the part that identifies the script itself.
410 ee655e64 2021-02-01 op Can be unset.
411 ee655e64 2021-02-01 op .It Ev PATH_TRANSLATED
412 ee655e64 2021-02-01 op Present if and only if
413 ee655e64 2021-02-01 op .Ev PATH_INFO
415 ee655e64 2021-02-01 op It represent the translation of the
416 ee655e64 2021-02-01 op .Ev PATH_INFO .
418 ee655e64 2021-02-01 op builds this by appending the
419 ee655e64 2021-02-01 op .Ev PATH_INFO
420 ee655e64 2021-02-01 op to the virtual host directory root.
421 ee655e64 2021-02-01 op .It Ev QUERY_STRING
422 ee655e64 2021-02-01 op The decoded query string.
423 ee655e64 2021-02-01 op .It Ev REMOTE_ADDR , Ev REMOTE_HOST
424 ee655e64 2021-02-01 op Textual representation of the client IP.
425 ee655e64 2021-02-01 op .It Ev REQUEST_METHOD
426 ee655e64 2021-02-01 op This is present only for RFC3875 (CGI) compliance.
427 ee655e64 2021-02-01 op It's always set to the empty string.
428 ee655e64 2021-02-01 op .It Ev SCRIPT_NAME
429 ee655e64 2021-02-01 op The part of the
430 ee655e64 2021-02-01 op .Ev GEMINI_URL_PATH
431 ee655e64 2021-02-01 op that identifies the current CGI script.
432 ee655e64 2021-02-01 op .It Ev SERVER_NAME
433 ee655e64 2021-02-01 op The name of the server
434 ee655e64 2021-02-01 op .It Ev SERVER_PORT
435 ee655e64 2021-02-01 op The port the server is listening on.
436 28ec6178 2021-01-24 op .It Ev SERVER_PROTOCOL
438 0ed56567 2020-11-06 op .It Ev SERVER_SOFTWARE
439 ee655e64 2021-02-01 op The name and version of the server, i.e.
441 677afbd3 2020-12-02 op .It Ev AUTH_TYPE
442 28ec6178 2021-01-24 op The string "Certificate" if the client used a certificate, otherwise
444 677afbd3 2020-12-02 op .It Ev REMOTE_USER
445 677afbd3 2020-12-02 op The subject of the client certificate if provided, otherwise unset.
446 677afbd3 2020-12-02 op .It Ev TLS_CLIENT_ISSUER
447 28ec6178 2021-01-24 op The is the issuer of the client certificate if provided, otherwise
449 677afbd3 2020-12-02 op .It Ev TLS_CLIENT_HASH
450 677afbd3 2020-12-02 op The hash of the client certificate if provided, otherwise unset.
451 ee655e64 2021-02-01 op The format is
452 ee655e64 2021-02-01 op .Dq ALGO:HASH .
453 89541eee 2021-04-13 op .It Ev TLS_VERSION
454 89541eee 2021-04-13 op The TLS version negotiated with the peer.
455 89541eee 2021-04-13 op .It Ev TLS_CIPHER
456 89541eee 2021-04-13 op The cipher suite negotiated with the peer.
457 89541eee 2021-04-13 op .It Ev TLS_CIPHER_STRENGTH
458 89541eee 2021-04-13 op The strength in bits for the symmetric cipher that is being used with
460 b63e30ff 2021-02-07 op .It Ev TLS_CLIENT_NOT_AFTER
461 b63e30ff 2021-02-07 op The time corresponding to the end of the validity period of the peer
462 b63e30ff 2021-02-07 op certificate in the ISO 8601 format
463 b63e30ff 2021-02-07 op .Pq e.g. Dq 2021-02-07T20:17:41Z .
464 b63e30ff 2021-02-07 op .It Ev TLS_CLIENT_NOT_BEFORE
465 b63e30ff 2021-02-07 op The time corresponding to the start of the validity period of the peer
466 b63e30ff 2021-02-07 op certificate in the ISO 8601 format.
470 ada16f87 2021-06-11 op optionally supports FastCGI.
473 ada16f87 2021-06-11 op rule must be present in a server or location block.
474 ada16f87 2021-06-11 op Then, all requests matching that server or location will be handled
475 ada16f87 2021-06-11 op via the specified FastCGI backend.
477 ada16f87 2021-06-11 op By default the following variables
478 ada16f87 2021-06-11 op .Pq parameters
479 ada16f87 2021-06-11 op are sent, and carry the same semantics as with CGI.
480 ada16f87 2021-06-11 op More parameters can be added with the
483 ada16f87 2021-06-11 op .Bl -bullet -compact
485 ada16f87 2021-06-11 op GATEWAY_INTERFACE
487 ada16f87 2021-06-11 op GEMINI_URL_PATH
495 ada16f87 2021-06-11 op REQUEST_METHOD
499 ada16f87 2021-06-11 op SERVER_PROTOCOL
501 ada16f87 2021-06-11 op SERVER_SOFTWARE
507 ada16f87 2021-06-11 op TLS_CLIENT_ISSUER
509 ada16f87 2021-06-11 op TLS_CLIENT_HASH
515 ada16f87 2021-06-11 op TLS_CIPHER_STRENGTH
517 ada16f87 2021-06-11 op TLS_CLIENT_NOT_BEFORE
519 ada16f87 2021-06-11 op TLS_CLIENT_NOT_AFTER
522 75fbb178 2021-01-28 op To auto-detect the MIME type of the response
524 75fbb178 2021-01-28 op looks at the file extension and consults its internal table.
525 75fbb178 2021-01-28 op By default the following mappings are loaded, but they can be
526 75fbb178 2021-01-28 op overridden or extended using the
528 75fbb178 2021-01-28 op configuration option.
529 75fbb178 2021-01-28 op If no MIME is found, the value of
530 75fbb178 2021-01-28 op .Ic default type
531 75fbb178 2021-01-28 op matching the file
533 75fbb178 2021-01-28 op will be used, which is
534 75fbb178 2021-01-28 op .Dq application/octet-stream
537 75fbb178 2021-01-28 op .Bl -tag -offset indent -width 14m -compact
540 75fbb178 2021-01-28 op .It gemini, gmi
548 75fbb178 2021-01-28 op .It markdown, md
549 75fbb178 2021-01-28 op text/markdown
553 75fbb178 2021-01-28 op application/pdf
557 75fbb178 2021-01-28 op image/svg+xml
564 f28d96d3 2021-01-25 op Serve the current directory
565 6980aad6 2020-10-02 op .Bd -literal -offset indent
569 f28d96d3 2021-01-25 op To serve the directory
571 f28d96d3 2021-01-25 op and enable CGI scripts inside
572 f28d96d3 2021-01-25 op .Pa docs/cgi ,
574 0ed56567 2020-11-06 op .Bd -literal -offset indent
575 f28d96d3 2021-01-25 op $ mkdir docs/cgi
576 b7a99061 2021-04-15 op $ cat <<EOF > docs/cgi/hello
578 0ed56567 2020-11-06 op printf "20 text/plain\\r\\n"
579 f28d96d3 2021-01-25 op echo "hello world"
581 f28d96d3 2021-01-25 op $ chmod +x docs/cgi/hello
582 b890467e 2021-03-20 op $ gmid -x '/cgi/*' docs
585 eb699783 2021-01-18 op The following is an example of a possible configuration for a site
586 eb699783 2021-01-18 op that enables only TLSv1.3, adds a mime type for the file extension
587 eb699783 2021-01-18 op "rtf" and defines two virtual host:
588 eb699783 2021-01-18 op .Bd -literal -offset indent
589 eb699783 2021-01-18 op ipv6 on # enable ipv6
591 eb699783 2021-01-18 op protocols "tlsv1.3"
593 eb699783 2021-01-18 op mime "application/rtf" "rtf"
595 eb699783 2021-01-18 op server "example.com" {
596 eb699783 2021-01-18 op cert "/path/to/cert.pem"
597 eb699783 2021-01-18 op key "/path/to/key.pem"
598 eb699783 2021-01-18 op root "/var/gemini/example.com"
601 eb699783 2021-01-18 op server "it.example.com" {
602 eb699783 2021-01-18 op cert "/path/to/cert.pem"
603 eb699783 2021-01-18 op key "/path/to/key.pem"
604 eb699783 2021-01-18 op root "/var/gemini/it.example.com"
605 87f2b68b 2021-02-02 op cgi "/cgi-bin/*"
610 f28d96d3 2021-01-25 op Yet another example, showing how to enable a
615 f28d96d3 2021-01-25 op .Bd -literal -offset indent
616 f28d96d3 2021-01-25 op chroot "/var/gemini"
619 f28d96d3 2021-01-25 op server "example.com" {
620 f28d96d3 2021-01-25 op cert "/path/to/cert.pem"
621 f28d96d3 2021-01-25 op key "/path/to/key.pem"
622 714685c1 2021-01-30 op root "/example.com" # in the /var/gemini chroot
624 4ee08bd1 2021-02-03 op location "/static/*" {
625 f28d96d3 2021-01-25 op auto index on
626 f28d96d3 2021-01-25 op index "index.gemini"
630 ef04b551 2021-01-09 op .Sh ACKNOWLEDGEMENTS
633 eb699783 2021-01-18 op .Dq Flexible and Economical
634 eb699783 2021-01-18 op UTF-8 decoder written by
635 f28d96d3 2021-01-25 op .An Bjoern Hoehrmann .
640 714685c1 2021-01-30 op program was written by
641 714685c1 2021-01-30 op .An Omar Polo Aq Mt op@omarpolo.com .
645 eb699783 2021-01-18 op The root directories of all virtual hosts are opened during the daemon
646 eb699783 2021-01-18 op startup; this means that if a root directory gets deleted and then
649 eb699783 2021-01-18 op won't be able to serve files inside that directory until a restart.
650 eb699783 2021-01-18 op This restriction applies only to the root directories and not their content.
652 714685c1 2021-01-30 op a %2F sequence is indistinguishable from a literal slash: this is not
653 714685c1 2021-01-30 op RFC3986-compliant.
655 714685c1 2021-01-30 op a %00 sequence is treated as invalid character and thus rejected.
