1 .\" Copyright (c) 2021 Omar Polo <op@omarpolo.com>
3 .\" Permission to use, copy, modify, and distribute this software for any
4 .\" purpose with or without fee is hereby granted, provided that the above
5 .\" copyright notice and this permission notice appear in all copies.
7 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14 .Dd $Mdocdate: January 30 2021$
19 .Nd simple and secure Gemini server
38 is a simple and minimal gemini server that can serve static files and
40 It can run without a configuration file with a limited set of features
44 rereads the configuration file when it receives
47 The options are as follows:
50 Specify the configuration file.
52 Stays and logs on the foreground.
54 Check that the configuration is valid, but don't start the server.
58 pid to the given path.
61 If no configuration file is given,
63 will look for the following options
67 .It Fl d Pa certs-path
68 Directory where certificates for the config-less mode are stored.
70 .Pa $XDG_DATA_HOME/gmid ,
72 .Pa ~/.local/share/gmid .
74 The hostname, by default
76 Certificates for the given
78 are searched inside the
80 directory given with the
86 .Pa hostname.key.pem .
87 If a certificate or key don't exists for a given hostname they
88 will be automatically generated.
90 Print the usage and exit.
92 The port to listen on, by default 1965.
97 options increase the verbosity.
99 Enable execution of CGI scripts.
100 See the description of the
102 option in the section
107 Cannot be provided more than once.
109 The root directory to serve.
110 By default the current working directory is assumed.
112 .Sh CONFIGURATION FILE
113 The configuration file is divided into two sections:
115 .It Sy Global Options
119 Virtual hosts definition.
122 Within the sections, empty lines are ignored and comments can be put
123 anywhere in the file using a hash mark
125 and extend to the end of the current line.
126 A boolean is either the symbol
130 A string is a sequence of characters wrapped in double quotes,
134 .It Ic chroot Pa path
136 the process to the given
138 The daemon has to be run with root privileges and thus the option
140 needs to be provided, so privileges can be dropped.
143 will enter the chroot after loading the TLS keys, but before opening
144 the virtual host root directories.
145 It's recommended to keep the TLS keys outside the chroot.
150 Enable or disable IPv6 support.
152 .It Ic mime Ar mime-type Ar file-extension
153 Add a mapping for the given
157 Both argument are strings.
158 .It Ic port Ar portno
159 The port to listen on.
161 .It Ic prefork Ar number
162 Run the specified number of server processes.
163 This increases the performance and prevents delays when connecting to
166 runs 3 server processes by default, when not in config-less mode.
167 The maximum number allowed is 16.
168 .It Ic protocols Ar string
169 Specify the TLS protocols to enable.
171 .Xr tls_config_parse_protocols 3
172 for the valid protocol string values.
173 By default, both TLSv1.3 and TLSv1.2 are enabled.
176 to enable only TLSv1.3.
177 .It Ic user Ar string
178 Run the daemon as the given user.
181 Every virtual host is defined by a
185 .It Ic server Ar hostname Brq ...
186 Match the server name using shell globbing rules.
187 This can be an explicit name,
188 .Ar www.example.com ,
189 or a name including a wildcards,
193 Followed by a block of options that is enclosed in curly brackets:
195 .It Ic auto Ic index Ar bool
196 If no index file is found, automatically generate a directory listing.
197 It's disabled by default.
198 .It Ic block Op Ic return Ar code Op Ar meta
199 Send a reply and close the connection;
205 .Dq temporary failure
209 is in the 3x range, then
214 the following special sequences are replaced:
217 is replaced with a single
220 is replaced with the request path.
222 is replaced with the query string of the request.
224 is replaced with the server port.
226 is replaced with the server name.
229 Path to the certificate to use for this server.
232 should contain a PEM encoded certificate.
233 This option is mandatory.
235 Execute CGI scripts that matches
237 using shell globbing rules.
238 .It Ic default type Ar string
239 Set the default media type that is used if the media type for a
240 specified extension is not found.
241 If not specified, the
244 .Dq application/octet-stream .
245 .It Ic entrypoint Pa path
246 Handle all the requests for the current virtual host using the
249 .It Ic env Ar name Ar value
250 Set the environment variable
254 when executing CGI scripts.
255 Can be provided more than once.
256 .It Ic index Ar string
257 Set the directory index file.
258 If not specified, it defaults to
261 Specify the private key to use for this server.
264 should contain a PEM encoded private key.
265 This option is mandatory.
266 .It Ic lang Ar string
267 Specify the language tag for the text/gemini content served.
270 parameter will be added in the response.
271 .It Ic location Pa path Brq ...
272 Specify server configuration rules for a specific location.
275 argument will be matched against the request path with shell globbing
277 In case of multiple location statements in the same context, the first
278 matching location will be put into effect and the later ones ignored.
279 Therefore is advisable to match for more specific paths first and for
280 generic ones later on.
283 section may include most of the server configuration rules
285 .Ic cert , Ic env , Ic key , Ic root , Ic location ,
286 .Ic entrypoint No and Ic cgi .
287 .It Ic root Pa directory
288 Specify the root directory for this server.
289 This option is mandatory.
290 It's relative to the chroot, if enabled.
291 .It Ic require Ic client Ic ca Pa path
292 Allow requests only from clients that provide a certificate signed by
293 the CA certificate in
295 It needs to be a PEM-encoded certificate and it's not relative to the
297 .It Ic strip Ar number
300 components from the beginning of the path.
301 It's only considered for the
303 parameter in the scope of a
307 When a request for an executable file matches the
309 rule, that file will be execute and its output fed to the client.
311 The CGI scripts are executed in the directory they reside and inherit
314 with these additional variables set:
316 .It Ev GATEWAY_INTERFACE
318 .It Ev GEMINI_DOCUMENT_ROOT
319 The root directory of the virtual host.
320 .It Ev GEMINI_SCRIPT_FILENAME
321 Full path to the CGI script being executed.
323 The full IRI of the request.
324 .It Ev GEMINI_URL_PATH
325 The path of the request.
327 The portion of the requested path that is derived from the the IRI
328 path hierarchy following the part that identifies the script itself.
330 .It Ev PATH_TRANSLATED
331 Present if and only if
334 It represent the translation of the
337 builds this by appending the
339 to the virtual host directory root.
341 The decoded query string.
342 .It Ev REMOTE_ADDR , Ev REMOTE_HOST
343 Textual representation of the client IP.
344 .It Ev REQUEST_METHOD
345 This is present only for RFC3875 (CGI) compliance.
346 It's always set to the empty string.
350 that identifies the current CGI script.
352 The name of the server
354 The port the server is listening on.
355 .It Ev SERVER_PROTOCOL
357 .It Ev SERVER_SOFTWARE
358 The name and version of the server, i.e.
361 The string "Certificate" if the client used a certificate, otherwise
364 The subject of the client certificate if provided, otherwise unset.
365 .It Ev TLS_CLIENT_ISSUER
366 The is the issuer of the client certificate if provided, otherwise
368 .It Ev TLS_CLIENT_HASH
369 The hash of the client certificate if provided, otherwise unset.
373 The TLS version negotiated with the peer.
375 The cipher suite negotiated with the peer.
376 .It Ev TLS_CIPHER_STRENGTH
377 The strength in bits for the symmetric cipher that is being used with
379 .It Ev TLS_CLIENT_NOT_AFTER
380 The time corresponding to the end of the validity period of the peer
381 certificate in the ISO 8601 format
382 .Pq e.g. Dq 2021-02-07T20:17:41Z .
383 .It Ev TLS_CLIENT_NOT_BEFORE
384 The time corresponding to the start of the validity period of the peer
385 certificate in the ISO 8601 format.
389 To auto-detect the MIME type of the response
391 looks at the file extension and consults its internal table.
392 By default the following mappings are loaded, but they can be
393 overridden or extended using the
395 configuration option.
396 If no MIME is found, the value of
400 will be used, which is
401 .Dq application/octet-stream
404 .Bl -tag -offset indent -width 14m -compact
431 Serve the current directory
432 .Bd -literal -offset indent
436 To serve the directory
438 and enable CGI scripts inside
441 .Bd -literal -offset indent
443 $ cat <<EOF > docs/cgi/hello
445 printf "20 text/plain\\r\\n"
448 $ chmod +x docs/cgi/hello
449 $ gmid -x '/cgi/*' docs
452 The following is an example of a possible configuration for a site
453 that enables only TLSv1.3, adds a mime type for the file extension
454 "rtf" and defines two virtual host:
455 .Bd -literal -offset indent
456 ipv6 on # enable ipv6
460 mime "application/rtf" "rtf"
462 server "example.com" {
463 cert "/path/to/cert.pem"
464 key "/path/to/key.pem"
465 root "/var/gemini/example.com"
468 server "it.example.com" {
469 cert "/path/to/cert.pem"
470 key "/path/to/key.pem"
471 root "/var/gemini/it.example.com"
477 Yet another example, showing how to enable a
482 .Bd -literal -offset indent
486 server "example.com" {
487 cert "/path/to/cert.pem"
488 key "/path/to/key.pem"
489 root "/example.com" # in the /var/gemini chroot
491 location "/static/*" {
500 .Dq Flexible and Economical
501 UTF-8 decoder written by
502 .An Bjoern Hoehrmann .
507 program was written by
508 .An Omar Polo Aq Mt op@omarpolo.com .
512 The root directories of all virtual hosts are opened during the daemon
513 startup; this means that if a root directory gets deleted and then
516 won't be able to serve files inside that directory until a restart.
517 This restriction applies only to the root directories and not their content.
519 a %2F sequence is indistinguishable from a literal slash: this is not
522 a %00 sequence is treated as invalid character and thus rejected.
