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
37 is a simple and minimal gemini server that can serve static files and
39 It can run without a configuration file with a limited set of features
43 rereads the configuration file when it receives
46 The options are as follows:
49 Specify the configuration file.
51 Stays and logs on the foreground.
53 Check that the configuration is valid, but don't start the server.
56 If no configuration file is given,
58 will look for the following options
62 .It Fl d Pa certs-path
63 Directory where certificates for the config-less mode are stored.
65 .Pa $XDG_DATA_HOME/gmid ,
67 .Pa ~/.local/share/gmid .
69 The hostname, by default
71 Certificates for the given
73 are searched inside the
75 directory given with the
81 .Pa hostname.key.pem .
82 If a certificate and key doesn't exists for a given hostname they
83 will be automatically generated.
85 Print the usage and exit.
87 The port to listen on, by default 1965.
92 options increase the verbosity.
94 Enable execution of CGI scripts.
95 See the description of the
102 Cannot be provided more than once.
104 The root directory to serve.
105 By default the current working directory is assumed.
107 .Sh CONFIGURATION FILE
108 The configuration file is divided into two sections:
110 .It Sy Global Options
114 Virtual hosts definition.
117 Within the sections, empty lines are ignored and comments can be put
118 anywhere in the file using a hash mark
120 and extend to the end of the current line.
121 A boolean is either the symbol
125 A string is a sequence of characters wrapped in double quotes,
129 .It Ic chroot Pa path
131 the process to the given
133 The daemon has to be run with root privileges and thus the option
135 needs to be provided, so privileges can be dropped.
138 will enter the chroot after loading the TLS keys, but before opening
139 the virtual host root directories.
140 It's recommended to keep the TLS keys outside the chroot.
145 Enable or disable IPv6 support.
147 .It Ic mime Ar mime-type Ar file-extension
148 Add a mapping for the given
152 Both argument are strings.
153 .It Ic port Ar portno
154 The port to listen on.
156 .It Ic prefork Ar number
157 Run the specified number of server processes.
158 This increases the performance and prevents delays when connecting to
161 runs 3 server processes by default, when not in config-less mode.
162 The maximum number allowed is 16.
163 .It Ic protocols Ar string
164 Specify the TLS protocols to enable.
166 .Xr tls_config_parse_protocols 3
167 for the valid protocol string values.
168 By default, both TLSv1.3 and TLSv1.2 are enabled.
171 to enable only TLSv1.3.
172 .It Ic user Ar string
173 Run the daemon as the given user.
176 Every virtual host is defined by a
180 .It Ic server Ar hostname Brq ...
181 Match the server name using shell globbing rules.
182 This can be an explicit name,
183 .Ar www.example.com ,
184 or a name including a wildcards,
188 Followed by a block of options that is enclosed in curly brackets:
190 .It Ic auto Ic index Ar bool
191 If no index file is found, automatically generate a directory listing.
192 It's disabled by default.
193 .It Ic block Op Ic return Ar code Op Ar meta
194 Send a reply and close the connection;
200 .Dq temporary failure
204 is in the 3x range, then
209 the following special sequences are replaced:
212 is replaced with a single
215 is replaced with the request path.
217 is replaced with the query string of the request.
219 is replaced with the server port.
221 is replaced with the server name.
224 Path to the certificate to use for this server.
227 should contain a PEM encoded certificate.
228 This option is mandatory.
230 Execute CGI scripts that matches
232 using shell globbing rules.
233 .It Ic default type Ar string
234 Set the default media type that is used if the media type for a
235 specified extension is not found.
236 If not specified, the
239 .Dq application/octet-stream .
240 .It Ic entrypoint Pa path
241 Make the CGI script at
243 .Pq relative to the Ic root No directory
244 handle all the requests for the current virtual host
245 .It Ic index Ar string
246 Set the directory index file.
247 If not specified, it defaults to
250 Specify the private key to use for this server.
253 should contain a PEM encoded private key.
254 This option is mandatory.
255 .It Ic lang Ar string
256 Specify the language tag for the text/gemini content served.
259 parameter will be added in the response.
260 .It Ic location Pa path Brq ...
261 Specify server configuration rules for a specific location.
264 argument will be matched against the request path with shell globbing
266 In case of multiple location statements in the same context, the first
267 matching location will be put into effect and the later ones ignored.
268 Therefore is advisable to match for more specific paths first and for
269 generic ones later on.
272 section may include most of the server configuration rules
274 .Ic cert , Ic key , Ic root , Ic location ,
275 .Ic entrypoint No and Ic cgi .
276 .It Ic root Pa directory
277 Specify the root directory for this server.
278 This option is mandatory.
279 It's relative to the chroot, if enabled.
280 .It Ic require Ic client Ic ca Pa path
281 Allow requests only from clients that provide a certificate signed by
282 the CA certificate in
284 It needs to be a PEM-encoded certificate and it's not relative to the
286 .It Ic strip Ar number
289 components from the beginning of the path.
290 It's only considered for the
292 parameter in the scope of a
296 When a request for an executable file matches the
298 rule, that file will be execute and its output fed to the client.
300 The CGI scripts are executed in the directory they reside and inherit
303 with these additional variables set:
305 .It Ev GATEWAY_INTERFACE
307 .It Ev GEMINI_DOCUMENT_ROOT
308 The root directory of the virtual host.
309 .It Ev GEMINI_SCRIPT_FILENAME
310 Full path to the CGI script being executed.
312 The full IRI of the request.
313 .It Ev GEMINI_URL_PATH
314 The path of the request.
316 The portion of the requested path that is derived from the the IRI
317 path hierarchy following the part that identifies the script itself.
319 .It Ev PATH_TRANSLATED
320 Present if and only if
323 It represent the translation of the
326 builds this by appending the
328 to the virtual host directory root.
330 The decoded query string.
331 .It Ev REMOTE_ADDR , Ev REMOTE_HOST
332 Textual representation of the client IP.
333 .It Ev REQUEST_METHOD
334 This is present only for RFC3875 (CGI) compliance.
335 It's always set to the empty string.
339 that identifies the current CGI script.
341 The name of the server
343 The port the server is listening on.
344 .It Ev SERVER_PROTOCOL
346 .It Ev SERVER_SOFTWARE
347 The name and version of the server, i.e.
350 The string "Certificate" if the client used a certificate, otherwise
353 The subject of the client certificate if provided, otherwise unset.
354 .It Ev TLS_CLIENT_ISSUER
355 The is the issuer of the client certificate if provided, otherwise
357 .It Ev TLS_CLIENT_HASH
358 The hash of the client certificate if provided, otherwise unset.
362 The TLS version negotiated with the peer.
364 The cipher suite negotiated with the peer.
365 .It Ev TLS_CIPHER_STRENGTH
366 The strength in bits for the symmetric cipher that is being used with
368 .It Ev TLS_CLIENT_NOT_AFTER
369 The time corresponding to the end of the validity period of the peer
370 certificate in the ISO 8601 format
371 .Pq e.g. Dq 2021-02-07T20:17:41Z .
372 .It Ev TLS_CLIENT_NOT_BEFORE
373 The time corresponding to the start of the validity period of the peer
374 certificate in the ISO 8601 format.
378 To auto-detect the MIME type of the response
380 looks at the file extension and consults its internal table.
381 By default the following mappings are loaded, but they can be
382 overridden or extended using the
384 configuration option.
385 If no MIME is found, the value of
389 will be used, which is
390 .Dq application/octet-stream
393 .Bl -tag -offset indent -width 14m -compact
416 Serve the current directory
417 .Bd -literal -offset indent
421 To serve the directory
423 and enable CGI scripts inside
426 .Bd -literal -offset indent
428 $ cat <<EOF > cgi/hello
430 printf "20 text/plain\\r\\n"
433 $ chmod +x docs/cgi/hello
434 $ gmid -x '/cgi/*' docs
437 The following is an example of a possible configuration for a site
438 that enables only TLSv1.3, adds a mime type for the file extension
439 "rtf" and defines two virtual host:
440 .Bd -literal -offset indent
441 ipv6 on # enable ipv6
445 mime "application/rtf" "rtf"
447 server "example.com" {
448 cert "/path/to/cert.pem"
449 key "/path/to/key.pem"
450 root "/var/gemini/example.com"
453 server "it.example.com" {
454 cert "/path/to/cert.pem"
455 key "/path/to/key.pem"
456 root "/var/gemini/it.example.com"
462 Yet another example, showing how to enable a
467 .Bd -literal -offset indent
471 server "example.com" {
472 cert "/path/to/cert.pem"
473 key "/path/to/key.pem"
474 root "/example.com" # in the /var/gemini chroot
476 location "/static/*" {
485 .Dq Flexible and Economical
486 UTF-8 decoder written by
487 .An Bjoern Hoehrmann .
492 program was written by
493 .An Omar Polo Aq Mt op@omarpolo.com .
497 The root directories of all virtual hosts are opened during the daemon
498 startup; this means that if a root directory gets deleted and then
501 won't be able to serve files inside that directory until a restart.
502 This restriction applies only to the root directories and not their content.
504 a %2F sequence is indistinguishable from a literal slash: this is not
507 a %00 sequence is treated as invalid character and thus rejected.
