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 25 2021$
19 .Nd dead simple zero configuration gemini server
35 is a simple and minimal gemini server that can serve static files and
37 It can run without a configuration file with a limited set of features
39 If a configuration file is given, no other flags shall be given,
46 fully supports IRIs (Internationalized Resource Identifiers, see
49 The options are as follows:
52 Specify the configuration file.
54 Stays and logs on the foreground.
56 Check that the configuration is valid, but don't start the server.
59 If no configuration file is given,
61 will look for the following options
65 .It Fl d Pa certs-path
66 Directory where certificates for the config-less mode are stored.
68 .Pa $XDG_DATA_HOME/gmid ,
70 .Pa ~/.local/share/gmid .
72 The hostname, by default
74 Certificates for the given
76 are searched inside the
78 directory given with the
84 .Pa hostname.key.pem .
85 If a certificate and key doesn't exists for a given hostname they
86 would be automatically generated.
88 Print the usage and exit.
90 The port to listen on, by default 1965.
92 Enable execution of CGI scripts.
93 See the description of the
101 Cannot be provided more than once.
103 The root directory to serve.
104 By default the current working directory is assumed.
106 .Sh CONFIGURATION FILE
107 The configuration file is divided into two sections:
109 .It Sy Global Options
113 Virtual hosts definition.
116 Within the sections, empty lines are ignored and comments can be put
117 anywhere in the file using a hash mark
119 and extend to the end of the current line.
120 A boolean is either the symbol
124 A string is a sequence of characters wrapped in double quotes,
129 Enable or disable IPv6 support.
131 .It Ic port Ar portno
132 The port to listen on.
134 .It Ic protocols Ar string
135 Specify the TLS protocols to enable.
137 .Xr tls_config_parse_protocols 3
138 for the valid protocol string values.
139 By default, both TLSv1.3 and TLSv1.2 are used.
142 to enable only TLSv1.3.
143 .It Ic mime Ar mime-type Ar file-extension
144 Add a mapping for the given
148 Both argument are strings.
149 .It Ic chroot Pa path
151 the process to the given
153 The daemon has to be run with root privileges and thus the option
155 needs to be provided, so
157 can drop the privileges.
158 Note that they are dropped after loading the TLS keys, so it's
159 recommended to put those outside the chroot.
163 .It Ic user Ar string
164 Run the daemon as the given user.
167 Every virtual host is defined by a
171 .It Ic server Ar hostname Brq ...
172 Match the server name using shell globbing rules. This can be an explicit name,
173 .Ar www.example.com ,
174 or a name including a wildcards,
178 Followed by a block of options that is enclosed in curly brackets:
181 Path to the certificate to use for this server.
184 should contain a PEM encoded certificate.
185 This option is mandatory.
187 Specify the private key to use for this server.
190 should contain a PEM encoded private key.
191 This option is mandatory.
192 .It Ic root Pa directory
193 Specify the root directory for this server.
194 This option is mandatory.
195 It's relative to the chroot, if enabled.
197 Enable the execution of CGI scripts if
199 is a prefix of the user request string.
200 An empty path "" will effectively enable the execution of any file
201 with the executable bit set inside the root directory.
202 .It Ic default type Ar string
203 Set the default media type that is used if the media type for a
204 specified extension is not found.
205 If not specified, the
208 .Dq application/octet-stream .
209 .It Ic lang Ar string
210 Specify the language tag for the text/gemini content served.
213 parameter will be added in the response.
214 .It Ic index Ar string
215 Set the directory index file.
216 If not specified, it defaults to
218 .It Ic auto Ic index Ar bool
219 If no index file is found, automatically generate a directory listing.
220 It's disabled by default.
221 .It Ic location Pa path Brq ...
222 Specify server configuration rules for a specific location.
225 argument will be matched against the request path with shell globbing
227 In case of multiple location statements in the same context, the last
228 matching location will be put into effect.
229 Therefore is advisable to match for a generic paths first and for more
230 specific ones later on.
233 section may include most of the server configuration rules
235 .Ic cert , Ic key , Ic root , Ic location No and Ic CGI .
238 When CGI scripts are enabled for a directory, a request for an
239 executable file will execute it and fed its output to the client.
241 The CGI scripts are executed in the root directory of the virtual
242 host, or in the served directory if run without config, and inherits
245 with these additional variables set:
247 .It Ev GATEWAY_INTERFACE
249 .It Ev SERVER_PROTOCOL
251 .It Ev SERVER_SOFTWARE
257 This variable is not available when operating without a configuration.
259 The (public) path to the script, e.g.
260 .Pa "/cgi-bin/example.cgi"
261 .It Ev SCRIPT_EXECUTABLE
262 The full path to the executable.
264 The user request (without the query parameters.)
265 .It Ev REQUEST_RELATIVE
266 The request relative to the script.
268 The query parameters.
270 The remote IP address.
272 The remote IP address.
274 The root directory being served, the one provided with the
278 or the root directory of the virtual host.
280 The string "Certificate" if the client used a certificate, otherwise
283 The subject of the client certificate if provided, otherwise unset.
284 .It Ev TLS_CLIENT_ISSUER
285 The is the issuer of the client certificate if provided, otherwise
287 .It Ev TLS_CLIENT_HASH
288 The hash of the client certificate if provided, otherwise unset.
289 The format is "ALGO:HASH".
292 Let's say you have a script in
294 and the user request is
295 .Pa /cgi-bin/script/foo/bar?quux .
300 .Ev SCRIPT_EXECUTABLE
302 .Pa $DOCUMENT_ROOT/cgi-bin/script ,
305 .Pa cgi-bin/script/foo/bar ,
314 Serve the current directory
315 .Bd -literal -offset indent
319 To serve the directory
321 and enable CGI scripts inside
324 .Bd -literal -offset indent
326 $ cat <<EOF > cgi/hello
328 printf "20 text/plain\\r\\n"
331 $ chmod +x docs/cgi/hello
335 Note that the argument to the
341 since it's relative to the document root.
343 The following is an example of a possible configuration for a site
344 that enables only TLSv1.3, adds a mime type for the file extension
345 "rtf" and defines two virtual host:
346 .Bd -literal -offset indent
347 ipv6 on # enable ipv6
351 mime "application/rtf" "rtf"
353 server "example.com" {
354 cert "/path/to/cert.pem"
355 key "/path/to/key.pem"
356 root "/var/gemini/example.com"
359 server "it.example.com" {
360 cert "/path/to/cert.pem"
361 key "/path/to/key.pem"
362 root "/var/gemini/it.example.com"
368 Yet another example, showing how to enable a
373 .Bd -literal -offset indent
377 server "example.com" {
378 cert "/path/to/cert.pem"
379 key "/path/to/key.pem"
380 root "/var/gemini/example.com"
382 location "/static/" {
391 .Dq Flexible and Economical
392 UTF-8 decoder written by
393 .An Bjoern Hoehrmann .
397 The root directories of all virtual hosts are opened during the daemon
398 startup; this means that if a root directory gets deleted and then
401 won't be able to serve files inside that directory until a restart.
402 This restriction applies only to the root directories and not their content.
404 a %2F sequence in the path part is indistinguishable from a literal
405 slash: this is not RFC3986-compliant.
407 a %00 sequence either in the path or in the query part is treated as
408 invalid character and thus rejected.
