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 e58a447a 2021-07-29 op .Dd $Mdocdate: July 29 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 f0a01fc7 2021-10-09 op If specified two or more time, dump the configuration in addition to
67 8e8b2e25 2021-04-28 op .It Fl P Pa pidfile
68 301e039d 2021-07-29 op Write daemon's pid to the given location.
70 2b520ad5 2021-07-09 op will also act as lock: if another process is holding a lock on that
73 2b520ad5 2021-07-09 op will refuse to start.
76 eb699783 2021-01-18 op If no configuration file is given,
79 ebf3373d 2021-12-02 op .Dq config-less mode
80 ebf3373d 2021-12-02 op .Pq i.e. runs in the foreground to serve a directory from the shell
81 ebf3373d 2021-12-02 op and looks for the following options
82 f28d96d3 2021-01-25 op .Bl -tag -width 14m
85 f28d96d3 2021-01-25 op .It Fl d Pa certs-path
86 f28d96d3 2021-01-25 op Directory where certificates for the config-less mode are stored.
87 301e039d 2021-07-29 op By default it is
88 f28d96d3 2021-01-25 op .Pa $XDG_DATA_HOME/gmid ,
90 f28d96d3 2021-01-25 op .Pa ~/.local/share/gmid .
91 71cf3975 2021-01-25 op .It Fl H Ar hostname
97 f28d96d3 2021-01-25 op Certificates for the given
99 f28d96d3 2021-01-25 op are searched inside the
100 f28d96d3 2021-01-25 op .Pa certs-dir
101 f28d96d3 2021-01-25 op directory given with the
104 714685c1 2021-01-30 op They have the form
105 f28d96d3 2021-01-25 op .Pa hostname.cert.pem
107 f28d96d3 2021-01-25 op .Pa hostname.key.pem .
108 301e039d 2021-07-29 op If a certificate or a key doesn't exist for a given hostname, they
109 301e039d 2021-07-29 op will be generated automatically.
110 ba65dcc8 2021-06-29 op .It Fl h , Fl -help
111 fab952e1 2020-10-03 op Print the usage and exit.
112 721e2325 2020-11-18 op .It Fl p Ar port
113 eb699783 2021-01-18 op The port to listen on, by default 1965.
114 ba65dcc8 2021-06-29 op .It Fl V , Fl -version
115 ba65dcc8 2021-06-29 op Print the version and exit.
117 3abf91b0 2021-02-07 op Verbose mode.
120 3abf91b0 2021-02-07 op options increase the verbosity.
121 f28d96d3 2021-01-25 op .It Fl x Pa path
122 301e039d 2021-07-29 op Enable execution of
125 eb699783 2021-01-18 op See the description of the
127 301e039d 2021-07-29 op option in the
129 301e039d 2021-07-29 op section below to learn how
131 eb699783 2021-01-18 op is processed.
132 eb699783 2021-01-18 op Cannot be provided more than once.
134 f28d96d3 2021-01-25 op The root directory to serve.
135 f28d96d3 2021-01-25 op By default the current working directory is assumed.
137 eb699783 2021-01-18 op .Sh CONFIGURATION FILE
138 8b743dda 2021-06-29 op The configuration file is divided into three sections:
139 eb699783 2021-01-18 op .Bl -tag -width xxxx
140 8b743dda 2021-06-29 op .It Sy Macros
141 8b743dda 2021-06-29 op User-defined variables may be defined and used later, simplifying the
142 8b743dda 2021-06-29 op configuration file.
143 eb699783 2021-01-18 op .It Sy Global Options
144 eb699783 2021-01-18 op Global settings for
146 eb699783 2021-01-18 op .It Sy Servers
147 f28d96d3 2021-01-25 op Virtual hosts definition.
150 eb699783 2021-01-18 op Within the sections, empty lines are ignored and comments can be put
151 eb699783 2021-01-18 op anywhere in the file using a hash mark
153 eb699783 2021-01-18 op and extend to the end of the current line.
154 eb699783 2021-01-18 op A boolean is either the symbol
158 f28d96d3 2021-01-25 op A string is a sequence of characters wrapped in double quotes,
159 f28d96d3 2021-01-25 op .Dq like this .
160 eaf7f776 2021-06-29 op Multiple strings one next to the other are joined into a single
162 eaf7f776 2021-06-29 op .Bd -literal -offset indent
163 eaf7f776 2021-06-29 op # equivalent to "temporary-failure"
164 eaf7f776 2021-06-29 op block return 40 "temporary" "-" "failure"
167 2b520ad5 2021-07-09 op Furthermore, quoting is necessary only when a string needs to contain
168 528f37cd 2021-07-09 op special characters
169 528f37cd 2021-07-09 op .Pq like spaces or punctuation ,
170 528f37cd 2021-07-09 op something that looks like a number or a reserved keyword.
171 2b520ad5 2021-07-09 op The last example could have been written also as:
172 2b520ad5 2021-07-09 op .Bd -literal -offset indent
173 2b520ad5 2021-07-09 op block return 40 temporary "-" failure
176 8b743dda 2021-06-29 op Strict ordering of the sections is not enforced, so that is possible
177 8b743dda 2021-06-29 op to mix macros, options and
180 8b743dda 2021-06-29 op However, defining all the
182 8b743dda 2021-06-29 op blocks after the macros and the global options is recommended.
184 528f37cd 2021-07-09 op Newlines are often optional, except around top-level instructions, and
187 528f37cd 2021-07-09 op can also be optionally used to separate options.
189 528f37cd 2021-07-09 op Additional configuration files can be included with the
191 528f37cd 2021-07-09 op keyword, for example:
192 528f37cd 2021-07-09 op .Bd -literal -offset indent
193 528f37cd 2021-07-09 op include "/etc/gmid.conf.local"
196 8b743dda 2021-06-29 op Macros can be defined that will later be expanded in context.
197 8b743dda 2021-06-29 op Macro names must start with a letter, digit or underscore and may
198 8b743dda 2021-06-29 op contain any of those characters.
199 4f9a2760 2021-07-02 op Macros names may not be reserved words.
200 bfb076ed 2021-06-29 op Macros are not expanded inside quotes.
202 528f37cd 2021-07-09 op Two kinds of macros are supported: variable-like and proper macros.
203 528f37cd 2021-07-09 op When a macro is invoked with a
205 528f37cd 2021-07-09 op before its name its expanded as a string, whereas when it's invoked
208 528f37cd 2021-07-09 op its expanded in-place.
211 8b743dda 2021-06-29 op .Bd -literal -offset indent
212 8b743dda 2021-06-29 op dir = "/var/gemini"
213 2d06ae62 2021-07-11 op certdir = "/etc/keys"
214 528f37cd 2021-07-09 op common = "lang it; auto index on"
216 8b743dda 2021-06-29 op server "foo" {
217 ad15003b 2021-07-11 op root $dir "/foo" # -> /var/gemini/foo
218 2d06ae62 2021-07-11 op cert $certdir "/foo.crt" # -> /etc/keys/foo.crt
219 2d06ae62 2021-07-11 op key $certdir "/foo.pem" # -> /etc/keys/foo.pem
223 eb699783 2021-01-18 op .Ss Global Options
224 eb699783 2021-01-18 op .Bl -tag -width 12m
225 ae08ec7d 2021-01-25 op .It Ic chroot Pa path
227 ae08ec7d 2021-01-25 op the process to the given
229 ae08ec7d 2021-01-25 op The daemon has to be run with root privileges and thus the option
231 714685c1 2021-01-30 op needs to be provided, so privileges can be dropped.
234 714685c1 2021-01-30 op will enter the chroot after loading the TLS keys, but before opening
235 714685c1 2021-01-30 op the virtual host root directories.
236 714685c1 2021-01-30 op It's recommended to keep the TLS keys outside the chroot.
237 ae08ec7d 2021-01-25 op Future version of
239 1de92289 2021-04-15 op may enforce this.
240 2b92a447 2021-02-06 op .It Ic ipv6 Ar bool
241 2b520ad5 2021-07-09 op Enable or disable IPv6 support, off by default.
242 d19951cf 2021-07-09 op .It Ic map Ar mime-type Cm to-ext Ar file-extension
244 2b520ad5 2021-07-09 op .Ar mime-type
246 2b520ad5 2021-07-09 op .Ar file-extension .
247 2b92a447 2021-02-06 op Both argument are strings.
248 2b92a447 2021-02-06 op .It Ic port Ar portno
249 2b92a447 2021-02-06 op The port to listen on.
250 2b520ad5 2021-07-09 op 1965 by default.
251 a709ddf5 2021-02-07 op .It Ic prefork Ar number
252 a709ddf5 2021-02-07 op Run the specified number of server processes.
253 a709ddf5 2021-02-07 op This increases the performance and prevents delays when connecting to
255 2b520ad5 2021-07-09 op When not in config-less mode,
257 2b520ad5 2021-07-09 op runs 3 server processes by default.
258 2c3e53da 2021-03-03 op The maximum number allowed is 16.
259 2b92a447 2021-02-06 op .It Ic protocols Ar string
260 2b92a447 2021-02-06 op Specify the TLS protocols to enable.
262 2b92a447 2021-02-06 op .Xr tls_config_parse_protocols 3
263 2b92a447 2021-02-06 op for the valid protocol string values.
264 2b92a447 2021-02-06 op By default, both TLSv1.3 and TLSv1.2 are enabled.
267 2b92a447 2021-02-06 op to enable only TLSv1.3.
268 ae08ec7d 2021-01-25 op .It Ic user Ar string
269 ae08ec7d 2021-01-25 op Run the daemon as the given user.
272 eb699783 2021-01-18 op Every virtual host is defined by a
275 eb699783 2021-01-18 op .Bl -tag -width Ds
276 eb699783 2021-01-18 op .It Ic server Ar hostname Brq ...
277 75fbb178 2021-01-28 op Match the server name using shell globbing rules.
278 2b520ad5 2021-07-09 op It can be an explicit name,
279 de27389e 2021-01-21 op .Ar www.example.com ,
280 de27389e 2021-01-21 op or a name including a wildcards,
281 de27389e 2021-01-21 op .Ar *.example.com .
284 eb699783 2021-01-18 op Followed by a block of options that is enclosed in curly brackets:
285 eb699783 2021-01-18 op .Bl -tag -width Ds
286 cc8c2901 2021-04-29 op .It Ic alias Ar name
287 cc8c2901 2021-04-29 op Specify an additional alias
289 cc8c2901 2021-04-29 op for this server.
290 2b92a447 2021-02-06 op .It Ic auto Ic index Ar bool
291 2b92a447 2021-02-06 op If no index file is found, automatically generate a directory listing.
292 2b520ad5 2021-07-09 op Disabled by default.
293 2b92a447 2021-02-06 op .It Ic block Op Ic return Ar code Op Ar meta
294 2b92a447 2021-02-06 op Send a reply and close the connection;
301 2b520ad5 2021-07-09 op .Dq temporary failure .
304 2b92a447 2021-02-06 op is in the 3x range, then
306 2b520ad5 2021-07-09 op is mandatory.
309 2b520ad5 2021-07-09 op the following special sequences are supported:
310 fd1ae83d 2021-06-11 op .Bl -tag -width Ds -compact
312 2b92a447 2021-02-06 op is replaced with a single
315 2b92a447 2021-02-06 op is replaced with the request path.
317 2b92a447 2021-02-06 op is replaced with the query string of the request.
319 2b92a447 2021-02-06 op is replaced with the server port.
321 2b92a447 2021-02-06 op is replaced with the server name.
323 eb699783 2021-01-18 op .It Ic cert Pa file
324 eb699783 2021-01-18 op Path to the certificate to use for this server.
327 eb699783 2021-01-18 op should contain a PEM encoded certificate.
328 eb699783 2021-01-18 op This option is mandatory.
329 eb699783 2021-01-18 op .It Ic cgi Pa path
332 301e039d 2021-07-29 op scripts that matches
334 87f2b68b 2021-02-02 op using shell globbing rules.
335 6119e13e 2021-01-19 op .It Ic default type Ar string
336 6119e13e 2021-01-19 op Set the default media type that is used if the media type for a
337 6119e13e 2021-01-19 op specified extension is not found.
338 6119e13e 2021-01-19 op If not specified, the
339 6119e13e 2021-01-19 op .Ic default type
341 6119e13e 2021-01-19 op .Dq application/octet-stream .
342 2b92a447 2021-02-06 op .It Ic entrypoint Pa path
343 dafaf467 2021-04-15 op Handle all the requests for the current virtual host using the
347 2b520ad5 2021-07-09 op relative to the current document root.
348 efacb859 2021-07-09 op .It Ic env Ar name Cm = Ar value
349 9cc630aa 2021-04-28 op Set the environment variable
353 9cc630aa 2021-04-28 op when executing CGI scripts.
354 9cc630aa 2021-04-28 op Can be provided more than once.
355 8ff40039 2021-05-24 op .\" don't document the "spawn <prog>" form because it probably won't
357 762b9b99 2021-07-09 op .It Ic fastcgi Oo Ic tcp Oc Pa socket Oo Cm port Ar port Oc
360 301e039d 2021-07-29 op instead of serving files.
363 2b520ad5 2021-07-09 op can either be a UNIX-domain socket or a TCP socket.
364 8ff40039 2021-05-24 op If the FastCGI application is listening on a UNIX domain socket,
366 8ff40039 2021-05-24 op is a local path name within the
368 8ff40039 2021-05-24 op root directory of
370 8ff40039 2021-05-24 op Otherwise, the
372 8ff40039 2021-05-24 op keyword must be provided and
374 8ff40039 2021-05-24 op is interpreted as a hostname or an IP address.
376 8ff40039 2021-05-24 op can be either a port number or the name of a service enclosed in
377 8ff40039 2021-05-24 op double quotes.
378 2b520ad5 2021-07-09 op If not specified defaults to 9000.
379 2b92a447 2021-02-06 op .It Ic index Ar string
380 2b92a447 2021-02-06 op Set the directory index file.
381 2b92a447 2021-02-06 op If not specified, it defaults to
382 2b92a447 2021-02-06 op .Pa index.gmi .
383 2b92a447 2021-02-06 op .It Ic key Pa file
384 2b92a447 2021-02-06 op Specify the private key to use for this server.
387 2b92a447 2021-02-06 op should contain a PEM encoded private key.
388 2b92a447 2021-02-06 op This option is mandatory.
389 05c23a54 2021-01-19 op .It Ic lang Ar string
390 05c23a54 2021-01-19 op Specify the language tag for the text/gemini content served.
391 05c23a54 2021-01-19 op If not specified, no
393 05c23a54 2021-01-19 op parameter will be added in the response.
394 c8b74339 2021-01-24 op .It Ic location Pa path Brq ...
395 c8b74339 2021-01-24 op Specify server configuration rules for a specific location.
398 c8b74339 2021-01-24 op argument will be matched against the request path with shell globbing
400 6016a593 2021-01-30 op In case of multiple location statements in the same context, the first
401 6016a593 2021-01-30 op matching location will be put into effect and the later ones ignored.
402 6016a593 2021-01-30 op Therefore is advisable to match for more specific paths first and for
403 6016a593 2021-01-30 op generic ones later on.
406 c8b74339 2021-01-24 op section may include most of the server configuration rules
408 3d132b28 2021-07-09 op .Ic alias , Ic cert , Ic cgi , Ic entrypoint , Ic env , Ic key ,
409 c143dcfa 2021-12-29 op .Ic location , Ic param No and Ic proxy .
410 2c43dcce 2021-06-17 op .It Ic log Ar bool
411 2c43dcce 2021-06-17 op Enable or disable the logging for the current server or location block.
412 efacb859 2021-07-09 op .It Ic param Ar name Cm = Ar value
413 ada16f87 2021-06-11 op Set the param
418 ff05125e 2021-10-15 op .It Ic ocsp Ar file
419 ff05125e 2021-10-15 op Specify an OCSP response to be stapled during TLS handshakes
420 ff05125e 2021-10-15 op with this server.
423 ff05125e 2021-10-15 op should contain a DER-format OCSP response retrieved from an
424 ff05125e 2021-10-15 op OCSP server for the
427 ff05125e 2021-10-15 op If the OCSP response in
429 ff05125e 2021-10-15 op is empty, OCSP stapling will not be used.
430 ff05125e 2021-10-15 op The default is to not use OCSP stapling.
431 c143dcfa 2021-12-29 op .It Ic proxy Cm relay-to Ar host : Ns Ar port
432 c143dcfa 2021-12-29 op Relay the request to the given
435 c143dcfa 2021-12-29 op will connect to
436 c143dcfa 2021-12-29 op .Ar host : Ns Ar port
437 c143dcfa 2021-12-29 op and repeat the gemini request; the response will then be sent as-is
438 c143dcfa 2021-12-29 op to the connected client.
439 c143dcfa 2021-12-29 op Port is 1965 by default.
440 2b92a447 2021-02-06 op .It Ic root Pa directory
441 2b520ad5 2021-07-09 op Specify the root directory for this server
442 2b520ad5 2021-07-09 op .Pq alas the current Dq document root .
443 2b520ad5 2021-07-09 op It's relative to the chroot if enabled.
444 02be96c6 2021-02-09 op .It Ic require Ic client Ic ca Pa path
445 02be96c6 2021-02-09 op Allow requests only from clients that provide a certificate signed by
446 02be96c6 2021-02-09 op the CA certificate in
448 02be96c6 2021-02-09 op It needs to be a PEM-encoded certificate and it's not relative to the
450 6abda252 2021-02-06 op .It Ic strip Ar number
453 0773413c 2021-05-15 op components from the beginning of the path before doing a lookup in the
454 0773413c 2021-05-15 op root directory.
455 0773413c 2021-05-15 op It's also considered for the
457 2b92a447 2021-02-06 op parameter in the scope of a
458 6abda252 2021-02-06 op .Ic block return .
461 87f2b68b 2021-02-02 op When a request for an executable file matches the
463 301e039d 2021-07-29 op rule, that file will be executed and its output fed to the client.
465 ee655e64 2021-02-01 op The CGI scripts are executed in the directory they reside and inherit
466 a7b9bb4d 2021-01-24 op the environment from
468 0ed56567 2020-11-06 op with these additional variables set:
469 ee655e64 2021-02-01 op .Bl -tag -width 24m
470 28ec6178 2021-01-24 op .It Ev GATEWAY_INTERFACE
472 ee655e64 2021-02-01 op .It Ev GEMINI_DOCUMENT_ROOT
473 ee655e64 2021-02-01 op The root directory of the virtual host.
474 ee655e64 2021-02-01 op .It Ev GEMINI_SCRIPT_FILENAME
475 ee655e64 2021-02-01 op Full path to the CGI script being executed.
476 ee655e64 2021-02-01 op .It Ev GEMINI_URL
477 ee655e64 2021-02-01 op The full IRI of the request.
478 ee655e64 2021-02-01 op .It Ev GEMINI_URL_PATH
479 ee655e64 2021-02-01 op The path of the request.
480 ee655e64 2021-02-01 op .It Ev PATH_INFO
481 ee655e64 2021-02-01 op The portion of the requested path that is derived from the the IRI
482 ee655e64 2021-02-01 op path hierarchy following the part that identifies the script itself.
483 ee655e64 2021-02-01 op Can be unset.
484 ee655e64 2021-02-01 op .It Ev PATH_TRANSLATED
485 ee655e64 2021-02-01 op Present if and only if
486 ee655e64 2021-02-01 op .Ev PATH_INFO
488 ee655e64 2021-02-01 op It represent the translation of the
489 ee655e64 2021-02-01 op .Ev PATH_INFO .
491 ee655e64 2021-02-01 op builds this by appending the
492 ee655e64 2021-02-01 op .Ev PATH_INFO
493 ee655e64 2021-02-01 op to the virtual host directory root.
494 ee655e64 2021-02-01 op .It Ev QUERY_STRING
495 ee655e64 2021-02-01 op The decoded query string.
496 ee655e64 2021-02-01 op .It Ev REMOTE_ADDR , Ev REMOTE_HOST
497 ee655e64 2021-02-01 op Textual representation of the client IP.
498 ee655e64 2021-02-01 op .It Ev REQUEST_METHOD
499 ee655e64 2021-02-01 op This is present only for RFC3875 (CGI) compliance.
500 ee655e64 2021-02-01 op It's always set to the empty string.
501 ee655e64 2021-02-01 op .It Ev SCRIPT_NAME
502 ee655e64 2021-02-01 op The part of the
503 ee655e64 2021-02-01 op .Ev GEMINI_URL_PATH
504 ee655e64 2021-02-01 op that identifies the current CGI script.
505 ee655e64 2021-02-01 op .It Ev SERVER_NAME
506 ee655e64 2021-02-01 op The name of the server
507 ee655e64 2021-02-01 op .It Ev SERVER_PORT
508 ee655e64 2021-02-01 op The port the server is listening on.
509 28ec6178 2021-01-24 op .It Ev SERVER_PROTOCOL
511 0ed56567 2020-11-06 op .It Ev SERVER_SOFTWARE
512 ee655e64 2021-02-01 op The name and version of the server, i.e.
513 fba809b5 2021-09-19 op .Dq gmid/1.7.3
514 677afbd3 2020-12-02 op .It Ev AUTH_TYPE
515 28ec6178 2021-01-24 op The string "Certificate" if the client used a certificate, otherwise
517 677afbd3 2020-12-02 op .It Ev REMOTE_USER
518 677afbd3 2020-12-02 op The subject of the client certificate if provided, otherwise unset.
519 677afbd3 2020-12-02 op .It Ev TLS_CLIENT_ISSUER
520 28ec6178 2021-01-24 op The is the issuer of the client certificate if provided, otherwise
522 677afbd3 2020-12-02 op .It Ev TLS_CLIENT_HASH
523 677afbd3 2020-12-02 op The hash of the client certificate if provided, otherwise unset.
524 ee655e64 2021-02-01 op The format is
525 ee655e64 2021-02-01 op .Dq ALGO:HASH .
526 89541eee 2021-04-13 op .It Ev TLS_VERSION
527 89541eee 2021-04-13 op The TLS version negotiated with the peer.
528 89541eee 2021-04-13 op .It Ev TLS_CIPHER
529 89541eee 2021-04-13 op The cipher suite negotiated with the peer.
530 89541eee 2021-04-13 op .It Ev TLS_CIPHER_STRENGTH
531 89541eee 2021-04-13 op The strength in bits for the symmetric cipher that is being used with
533 b63e30ff 2021-02-07 op .It Ev TLS_CLIENT_NOT_AFTER
534 b63e30ff 2021-02-07 op The time corresponding to the end of the validity period of the peer
535 b63e30ff 2021-02-07 op certificate in the ISO 8601 format
536 b63e30ff 2021-02-07 op .Pq e.g. Dq 2021-02-07T20:17:41Z .
537 b63e30ff 2021-02-07 op .It Ev TLS_CLIENT_NOT_BEFORE
538 b63e30ff 2021-02-07 op The time corresponding to the start of the validity period of the peer
539 b63e30ff 2021-02-07 op certificate in the ISO 8601 format.
543 ada16f87 2021-06-11 op optionally supports FastCGI.
546 ada16f87 2021-06-11 op rule must be present in a server or location block.
547 ada16f87 2021-06-11 op Then, all requests matching that server or location will be handled
548 ada16f87 2021-06-11 op via the specified FastCGI backend.
550 ada16f87 2021-06-11 op By default the following variables
551 ada16f87 2021-06-11 op .Pq parameters
552 ada16f87 2021-06-11 op are sent, and carry the same semantics as with CGI.
553 ada16f87 2021-06-11 op More parameters can be added with the
557 ada16f87 2021-06-11 op .Bl -bullet -compact
559 ada16f87 2021-06-11 op GATEWAY_INTERFACE
561 ada16f87 2021-06-11 op GEMINI_URL_PATH
569 ada16f87 2021-06-11 op REQUEST_METHOD
573 ada16f87 2021-06-11 op SERVER_PROTOCOL
575 ada16f87 2021-06-11 op SERVER_SOFTWARE
581 ada16f87 2021-06-11 op TLS_CLIENT_ISSUER
583 ada16f87 2021-06-11 op TLS_CLIENT_HASH
589 ada16f87 2021-06-11 op TLS_CIPHER_STRENGTH
591 ada16f87 2021-06-11 op TLS_CLIENT_NOT_BEFORE
593 ada16f87 2021-06-11 op TLS_CLIENT_NOT_AFTER
596 75fbb178 2021-01-28 op To auto-detect the MIME type of the response
598 75fbb178 2021-01-28 op looks at the file extension and consults its internal table.
599 75fbb178 2021-01-28 op By default the following mappings are loaded, but they can be
600 75fbb178 2021-01-28 op overridden or extended using the
602 75fbb178 2021-01-28 op configuration option.
603 75fbb178 2021-01-28 op If no MIME is found, the value of
604 75fbb178 2021-01-28 op .Ic default type
605 75fbb178 2021-01-28 op matching the file
607 75fbb178 2021-01-28 op will be used, which is
608 75fbb178 2021-01-28 op .Dq application/octet-stream
611 75fbb178 2021-01-28 op .Bl -tag -offset indent -width 14m -compact
614 75fbb178 2021-01-28 op .It gemini, gmi
622 75fbb178 2021-01-28 op .It markdown, md
623 75fbb178 2021-01-28 op text/markdown
627 75fbb178 2021-01-28 op application/pdf
631 75fbb178 2021-01-28 op image/svg+xml
638 e58a447a 2021-07-29 op Messages and requests are logged by
642 e58a447a 2021-07-29 op facility or printed on
645 e58a447a 2021-07-29 op Requests are logged with the
648 e58a447a 2021-07-29 op Each request log entry has the following fields, separated by
651 e58a447a 2021-07-29 op .Bl -bullet -compact
653 e58a447a 2021-07-29 op Client IP address and the source port number, separated by a colon
660 e58a447a 2021-07-29 op Response status
662 e58a447a 2021-07-29 op Response meta
665 f28d96d3 2021-01-25 op Serve the current directory
666 6980aad6 2020-10-02 op .Bd -literal -offset indent
670 f28d96d3 2021-01-25 op To serve the directory
672 f28d96d3 2021-01-25 op and enable CGI scripts inside
674 0ed56567 2020-11-06 op .Bd -literal -offset indent
675 f28d96d3 2021-01-25 op $ mkdir docs/cgi
676 b7a99061 2021-04-15 op $ cat <<EOF > docs/cgi/hello
678 af5f9b27 2021-07-21 op printf "20 text/plain\er\en"
679 f28d96d3 2021-01-25 op echo "hello world"
681 f28d96d3 2021-01-25 op $ chmod +x docs/cgi/hello
682 b890467e 2021-03-20 op $ gmid -x '/cgi/*' docs
685 e308526c 2021-07-29 op An X.509 certificate must be provided to run
687 e308526c 2021-07-29 op using a configuration file.
688 e308526c 2021-07-29 op First, the RSA certificate is created using a wildcard common name:
689 e308526c 2021-07-29 op .Bd -literal -offset indent
690 e308526c 2021-07-29 op # openssl genrsa \-out /etc/ssl/private/example.com.key 4096
691 1298e430 2021-10-09 op # openssl req \-new \-x509 \e
692 1298e430 2021-10-09 op \-key /etc/ssl/private/example.com.key \e
693 1298e430 2021-10-09 op \-out /etc/ssl/example.com.crt \e
694 1298e430 2021-10-09 op \-days 36500 \-nodes \e
695 2bb1776b 2021-07-29 op \-subj "/CN=example.com"
696 e308526c 2021-07-29 op # chmod 600 /etc/ssl/example.com.crt
697 e308526c 2021-07-29 op # chmod 600 /etc/ssl/private/example.com.key
700 e308526c 2021-07-29 op In the example above, a certificate is valid for one hundred years from
701 e308526c 2021-07-29 op the date it was created, which is normal for TOFU.
703 eb699783 2021-01-18 op The following is an example of a possible configuration for a site
704 eb699783 2021-01-18 op that enables only TLSv1.3, adds a mime type for the file extension
706 e308526c 2021-07-29 op and defines two virtual host:
707 eb699783 2021-01-18 op .Bd -literal -offset indent
708 eb699783 2021-01-18 op ipv6 on # enable ipv6
710 eb699783 2021-01-18 op protocols "tlsv1.3"
712 d19951cf 2021-07-09 op map "application/rtf" to-ext "rtf"
714 eb699783 2021-01-18 op server "example.com" {
715 e308526c 2021-07-29 op cert "/etc/ssl/example.com.crt"
716 e308526c 2021-07-29 op key "/etc/ssl/private/example.com.key"
717 eb699783 2021-01-18 op root "/var/gemini/example.com"
720 eb699783 2021-01-18 op server "it.example.com" {
721 e308526c 2021-07-29 op cert "/etc/ssl/example.com.crt"
722 e308526c 2021-07-29 op key "/etc/ssl/private/example.com.key"
723 eb699783 2021-01-18 op root "/var/gemini/it.example.com"
725 2b520ad5 2021-07-09 op # enable cgi scripts inside "cgi-bin"
726 87f2b68b 2021-02-02 op cgi "/cgi-bin/*"
728 2b520ad5 2021-07-09 op # set the language for text/gemini files
733 f28d96d3 2021-01-25 op Yet another example, showing how to enable a
738 f28d96d3 2021-01-25 op .Bd -literal -offset indent
739 f28d96d3 2021-01-25 op chroot "/var/gemini"
742 f28d96d3 2021-01-25 op server "example.com" {
743 2b520ad5 2021-07-09 op cert "/path/to/cert.pem" # absolute path
744 2b520ad5 2021-07-09 op key "/path/to/key.pem" # also absolute
745 2b520ad5 2021-07-09 op root "/example.com" # relative to the chroot
747 4ee08bd1 2021-02-03 op location "/static/*" {
748 2b520ad5 2021-07-09 op # load the following rules only for
749 2b520ad5 2021-07-09 op # requests that matches "/static/*"
751 f28d96d3 2021-01-25 op auto index on
752 f28d96d3 2021-01-25 op index "index.gemini"
756 ef04b551 2021-01-09 op .Sh ACKNOWLEDGEMENTS
759 eb699783 2021-01-18 op .Dq Flexible and Economical
760 eb699783 2021-01-18 op UTF-8 decoder written by
761 f28d96d3 2021-01-25 op .An Bjoern Hoehrmann .
766 714685c1 2021-01-30 op program was written by
767 714685c1 2021-01-30 op .An Omar Polo Aq Mt op@omarpolo.com .
771 2b520ad5 2021-07-09 op All the root directories are opened during the daemon startup; if a
772 2b520ad5 2021-07-09 op root directory is deleted and then re-created,
774 eb699783 2021-01-18 op won't be able to serve files inside that directory until a restart.
775 2b520ad5 2021-07-09 op This restriction only applies to the root directories and not their
778 714685c1 2021-01-30 op a %2F sequence is indistinguishable from a literal slash: this is not
779 714685c1 2021-01-30 op RFC3986-compliant.
781 714685c1 2021-01-30 op a %00 sequence is treated as invalid character and thus rejected.