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
66 2b520ad5 2021-07-09 op Write the daemon pid to the given location.
68 2b520ad5 2021-07-09 op will also act as lock: if another process is holding a lock on that
71 2b520ad5 2021-07-09 op will refuse to start.
74 eb699783 2021-01-18 op If no configuration file is given,
76 f28d96d3 2021-01-25 op will look for the following options
77 f28d96d3 2021-01-25 op .Bl -tag -width 14m
80 f28d96d3 2021-01-25 op .It Fl d Pa certs-path
81 f28d96d3 2021-01-25 op Directory where certificates for the config-less mode are stored.
83 f28d96d3 2021-01-25 op .Pa $XDG_DATA_HOME/gmid ,
85 f28d96d3 2021-01-25 op .Pa ~/.local/share/gmid .
86 71cf3975 2021-01-25 op .It Fl H Ar hostname
90 f28d96d3 2021-01-25 op Certificates for the given
92 f28d96d3 2021-01-25 op are searched inside the
94 f28d96d3 2021-01-25 op directory given with the
97 714685c1 2021-01-30 op They have the form
98 f28d96d3 2021-01-25 op .Pa hostname.cert.pem
100 f28d96d3 2021-01-25 op .Pa hostname.key.pem .
101 1de92289 2021-04-15 op If a certificate or key don't exists for a given hostname they
102 714685c1 2021-01-30 op will be automatically generated.
103 ba65dcc8 2021-06-29 op .It Fl h , Fl -help
104 fab952e1 2020-10-03 op Print the usage and exit.
105 721e2325 2020-11-18 op .It Fl p Ar port
106 eb699783 2021-01-18 op The port to listen on, by default 1965.
107 ba65dcc8 2021-06-29 op .It Fl V , Fl -version
108 ba65dcc8 2021-06-29 op Print the version and exit.
110 3abf91b0 2021-02-07 op Verbose mode.
113 3abf91b0 2021-02-07 op options increase the verbosity.
114 f28d96d3 2021-01-25 op .It Fl x Pa path
115 eb699783 2021-01-18 op Enable execution of CGI scripts.
116 eb699783 2021-01-18 op See the description of the
118 eb699783 2021-01-18 op option in the section
120 eb699783 2021-01-18 op below to learn how
122 eb699783 2021-01-18 op is processed.
123 eb699783 2021-01-18 op Cannot be provided more than once.
125 f28d96d3 2021-01-25 op The root directory to serve.
126 f28d96d3 2021-01-25 op By default the current working directory is assumed.
128 eb699783 2021-01-18 op .Sh CONFIGURATION FILE
129 8b743dda 2021-06-29 op The configuration file is divided into three sections:
130 eb699783 2021-01-18 op .Bl -tag -width xxxx
131 8b743dda 2021-06-29 op .It Sy Macros
132 8b743dda 2021-06-29 op User-defined variables may be defined and used later, simplifying the
133 8b743dda 2021-06-29 op configuration file.
134 eb699783 2021-01-18 op .It Sy Global Options
135 eb699783 2021-01-18 op Global settings for
137 eb699783 2021-01-18 op .It Sy Servers
138 f28d96d3 2021-01-25 op Virtual hosts definition.
141 eb699783 2021-01-18 op Within the sections, empty lines are ignored and comments can be put
142 eb699783 2021-01-18 op anywhere in the file using a hash mark
144 eb699783 2021-01-18 op and extend to the end of the current line.
145 eb699783 2021-01-18 op A boolean is either the symbol
149 f28d96d3 2021-01-25 op A string is a sequence of characters wrapped in double quotes,
150 f28d96d3 2021-01-25 op .Dq like this .
151 eaf7f776 2021-06-29 op Multiple strings one next to the other are joined into a single
153 eaf7f776 2021-06-29 op .Bd -literal -offset indent
154 eaf7f776 2021-06-29 op # equivalent to "temporary-failure"
155 eaf7f776 2021-06-29 op block return 40 "temporary" "-" "failure"
158 2b520ad5 2021-07-09 op Furthermore, quoting is necessary only when a string needs to contain
159 2b520ad5 2021-07-09 op spaces, something that looks like a number or a reserved keyword.
160 2b520ad5 2021-07-09 op The last example could have been written also as:
161 2b520ad5 2021-07-09 op .Bd -literal -offset indent
162 2b520ad5 2021-07-09 op block return 40 temporary "-" failure
165 8b743dda 2021-06-29 op Strict ordering of the sections is not enforced, so that is possible
166 8b743dda 2021-06-29 op to mix macros, options and
169 8b743dda 2021-06-29 op However, defining all the
171 8b743dda 2021-06-29 op blocks after the macros and the global options is recommended.
173 8b743dda 2021-06-29 op Macros can be defined that will later be expanded in context.
174 8b743dda 2021-06-29 op Macro names must start with a letter, digit or underscore and may
175 8b743dda 2021-06-29 op contain any of those characters.
176 4f9a2760 2021-07-02 op Macros names may not be reserved words.
177 bfb076ed 2021-06-29 op Macros are not expanded inside quotes.
180 8b743dda 2021-06-29 op .Bd -literal -offset indent
181 8b743dda 2021-06-29 op dir = "/var/gemini"
182 8b743dda 2021-06-29 op cert = "/etc/keys"
184 8b743dda 2021-06-29 op server "foo" {
185 4ede0fe4 2021-06-29 op root $dir "/foo" # -> /var/gemini/foo
186 4ede0fe4 2021-06-29 op cert $cert "/foo.crt" # -> /etc/keys/foo.crt
187 4ede0fe4 2021-06-29 op key $cert "/foo.pem" # -> /etc/keys/foo.pem
190 eb699783 2021-01-18 op .Ss Global Options
191 eb699783 2021-01-18 op .Bl -tag -width 12m
192 ae08ec7d 2021-01-25 op .It Ic chroot Pa path
194 ae08ec7d 2021-01-25 op the process to the given
196 ae08ec7d 2021-01-25 op The daemon has to be run with root privileges and thus the option
198 714685c1 2021-01-30 op needs to be provided, so privileges can be dropped.
201 714685c1 2021-01-30 op will enter the chroot after loading the TLS keys, but before opening
202 714685c1 2021-01-30 op the virtual host root directories.
203 714685c1 2021-01-30 op It's recommended to keep the TLS keys outside the chroot.
204 ae08ec7d 2021-01-25 op Future version of
206 1de92289 2021-04-15 op may enforce this.
207 2b92a447 2021-02-06 op .It Ic ipv6 Ar bool
208 2b520ad5 2021-07-09 op Enable or disable IPv6 support, off by default.
209 d19951cf 2021-07-09 op .It Ic map Ar mime-type Cm to-ext Ar file-extension
211 2b520ad5 2021-07-09 op .Ar mime-type
213 2b520ad5 2021-07-09 op .Ar file-extension .
214 2b92a447 2021-02-06 op Both argument are strings.
215 2b92a447 2021-02-06 op .It Ic port Ar portno
216 2b92a447 2021-02-06 op The port to listen on.
217 2b520ad5 2021-07-09 op 1965 by default.
218 a709ddf5 2021-02-07 op .It Ic prefork Ar number
219 a709ddf5 2021-02-07 op Run the specified number of server processes.
220 a709ddf5 2021-02-07 op This increases the performance and prevents delays when connecting to
222 2b520ad5 2021-07-09 op When not in config-less mode,
224 2b520ad5 2021-07-09 op runs 3 server processes by default.
225 2c3e53da 2021-03-03 op The maximum number allowed is 16.
226 2b92a447 2021-02-06 op .It Ic protocols Ar string
227 2b92a447 2021-02-06 op Specify the TLS protocols to enable.
229 2b92a447 2021-02-06 op .Xr tls_config_parse_protocols 3
230 2b92a447 2021-02-06 op for the valid protocol string values.
231 2b92a447 2021-02-06 op By default, both TLSv1.3 and TLSv1.2 are enabled.
234 2b92a447 2021-02-06 op to enable only TLSv1.3.
235 ae08ec7d 2021-01-25 op .It Ic user Ar string
236 ae08ec7d 2021-01-25 op Run the daemon as the given user.
239 eb699783 2021-01-18 op Every virtual host is defined by a
242 eb699783 2021-01-18 op .Bl -tag -width Ds
243 eb699783 2021-01-18 op .It Ic server Ar hostname Brq ...
244 75fbb178 2021-01-28 op Match the server name using shell globbing rules.
245 2b520ad5 2021-07-09 op It can be an explicit name,
246 de27389e 2021-01-21 op .Ar www.example.com ,
247 de27389e 2021-01-21 op or a name including a wildcards,
248 de27389e 2021-01-21 op .Ar *.example.com .
251 eb699783 2021-01-18 op Followed by a block of options that is enclosed in curly brackets:
252 eb699783 2021-01-18 op .Bl -tag -width Ds
253 cc8c2901 2021-04-29 op .It Ic alias Ar name
254 cc8c2901 2021-04-29 op Specify an additional alias
256 cc8c2901 2021-04-29 op for this server.
257 2b92a447 2021-02-06 op .It Ic auto Ic index Ar bool
258 2b92a447 2021-02-06 op If no index file is found, automatically generate a directory listing.
259 2b520ad5 2021-07-09 op Disabled by default.
260 2b92a447 2021-02-06 op .It Ic block Op Ic return Ar code Op Ar meta
261 2b92a447 2021-02-06 op Send a reply and close the connection;
268 2b520ad5 2021-07-09 op .Dq temporary failure .
271 2b92a447 2021-02-06 op is in the 3x range, then
273 2b520ad5 2021-07-09 op is mandatory.
276 2b520ad5 2021-07-09 op the following special sequences are supported:
277 fd1ae83d 2021-06-11 op .Bl -tag -width Ds -compact
279 2b92a447 2021-02-06 op is replaced with a single
282 2b92a447 2021-02-06 op is replaced with the request path.
284 2b92a447 2021-02-06 op is replaced with the query string of the request.
286 2b92a447 2021-02-06 op is replaced with the server port.
288 2b92a447 2021-02-06 op is replaced with the server name.
290 eb699783 2021-01-18 op .It Ic cert Pa file
291 eb699783 2021-01-18 op Path to the certificate to use for this server.
294 eb699783 2021-01-18 op should contain a PEM encoded certificate.
295 eb699783 2021-01-18 op This option is mandatory.
296 eb699783 2021-01-18 op .It Ic cgi Pa path
297 87f2b68b 2021-02-02 op Execute CGI scripts that matches
299 87f2b68b 2021-02-02 op using shell globbing rules.
300 6119e13e 2021-01-19 op .It Ic default type Ar string
301 6119e13e 2021-01-19 op Set the default media type that is used if the media type for a
302 6119e13e 2021-01-19 op specified extension is not found.
303 6119e13e 2021-01-19 op If not specified, the
304 6119e13e 2021-01-19 op .Ic default type
306 6119e13e 2021-01-19 op .Dq application/octet-stream .
307 2b92a447 2021-02-06 op .It Ic entrypoint Pa path
308 dafaf467 2021-04-15 op Handle all the requests for the current virtual host using the
309 dafaf467 2021-04-15 op CGI script at
311 2b520ad5 2021-07-09 op relative to the current document root.
312 efacb859 2021-07-09 op .It Ic env Ar name Cm = Ar value
313 9cc630aa 2021-04-28 op Set the environment variable
317 9cc630aa 2021-04-28 op when executing CGI scripts.
318 9cc630aa 2021-04-28 op Can be provided more than once.
319 8ff40039 2021-05-24 op .\" don't document the "spawn <prog>" form because it probably won't
321 762b9b99 2021-07-09 op .It Ic fastcgi Oo Ic tcp Oc Pa socket Oo Cm port Ar port Oc
322 8ff40039 2021-05-24 op Enable FastCGI instead of serving files.
325 2b520ad5 2021-07-09 op can either be a UNIX-domain socket or a TCP socket.
326 8ff40039 2021-05-24 op If the FastCGI application is listening on a UNIX domain socket,
328 8ff40039 2021-05-24 op is a local path name within the
330 8ff40039 2021-05-24 op root directory of
332 8ff40039 2021-05-24 op Otherwise, the
334 8ff40039 2021-05-24 op keyword must be provided and
336 8ff40039 2021-05-24 op is interpreted as a hostname or an IP address.
338 8ff40039 2021-05-24 op can be either a port number or the name of a service enclosed in
339 8ff40039 2021-05-24 op double quotes.
340 2b520ad5 2021-07-09 op If not specified defaults to 9000.
341 2b92a447 2021-02-06 op .It Ic index Ar string
342 2b92a447 2021-02-06 op Set the directory index file.
343 2b92a447 2021-02-06 op If not specified, it defaults to
344 2b92a447 2021-02-06 op .Pa index.gmi .
345 2b92a447 2021-02-06 op .It Ic key Pa file
346 2b92a447 2021-02-06 op Specify the private key to use for this server.
349 2b92a447 2021-02-06 op should contain a PEM encoded private key.
350 2b92a447 2021-02-06 op This option is mandatory.
351 05c23a54 2021-01-19 op .It Ic lang Ar string
352 05c23a54 2021-01-19 op Specify the language tag for the text/gemini content served.
353 05c23a54 2021-01-19 op If not specified, no
355 05c23a54 2021-01-19 op parameter will be added in the response.
356 c8b74339 2021-01-24 op .It Ic location Pa path Brq ...
357 c8b74339 2021-01-24 op Specify server configuration rules for a specific location.
360 c8b74339 2021-01-24 op argument will be matched against the request path with shell globbing
362 6016a593 2021-01-30 op In case of multiple location statements in the same context, the first
363 6016a593 2021-01-30 op matching location will be put into effect and the later ones ignored.
364 6016a593 2021-01-30 op Therefore is advisable to match for more specific paths first and for
365 6016a593 2021-01-30 op generic ones later on.
368 c8b74339 2021-01-24 op section may include most of the server configuration rules
370 3d132b28 2021-07-09 op .Ic alias , Ic cert , Ic cgi , Ic entrypoint , Ic env , Ic key ,
371 3d132b28 2021-07-09 op .Ic location No and Ic param .
372 2c43dcce 2021-06-17 op .It Ic log Ar bool
373 2c43dcce 2021-06-17 op Enable or disable the logging for the current server or location block.
374 efacb859 2021-07-09 op .It Ic param Ar name Cm = Ar value
375 ada16f87 2021-06-11 op Set the param
380 2b92a447 2021-02-06 op .It Ic root Pa directory
381 2b520ad5 2021-07-09 op Specify the root directory for this server
382 2b520ad5 2021-07-09 op .Pq alas the current Dq document root .
383 2b520ad5 2021-07-09 op It's relative to the chroot if enabled.
384 02be96c6 2021-02-09 op .It Ic require Ic client Ic ca Pa path
385 02be96c6 2021-02-09 op Allow requests only from clients that provide a certificate signed by
386 02be96c6 2021-02-09 op the CA certificate in
388 02be96c6 2021-02-09 op It needs to be a PEM-encoded certificate and it's not relative to the
390 6abda252 2021-02-06 op .It Ic strip Ar number
393 0773413c 2021-05-15 op components from the beginning of the path before doing a lookup in the
394 0773413c 2021-05-15 op root directory.
395 0773413c 2021-05-15 op It's also considered for the
397 2b92a447 2021-02-06 op parameter in the scope of a
398 6abda252 2021-02-06 op .Ic block return .
401 87f2b68b 2021-02-02 op When a request for an executable file matches the
403 87f2b68b 2021-02-02 op rule, that file will be execute and its output fed to the client.
405 ee655e64 2021-02-01 op The CGI scripts are executed in the directory they reside and inherit
406 a7b9bb4d 2021-01-24 op the environment from
408 0ed56567 2020-11-06 op with these additional variables set:
409 ee655e64 2021-02-01 op .Bl -tag -width 24m
410 28ec6178 2021-01-24 op .It Ev GATEWAY_INTERFACE
412 ee655e64 2021-02-01 op .It Ev GEMINI_DOCUMENT_ROOT
413 ee655e64 2021-02-01 op The root directory of the virtual host.
414 ee655e64 2021-02-01 op .It Ev GEMINI_SCRIPT_FILENAME
415 ee655e64 2021-02-01 op Full path to the CGI script being executed.
416 ee655e64 2021-02-01 op .It Ev GEMINI_URL
417 ee655e64 2021-02-01 op The full IRI of the request.
418 ee655e64 2021-02-01 op .It Ev GEMINI_URL_PATH
419 ee655e64 2021-02-01 op The path of the request.
420 ee655e64 2021-02-01 op .It Ev PATH_INFO
421 ee655e64 2021-02-01 op The portion of the requested path that is derived from the the IRI
422 ee655e64 2021-02-01 op path hierarchy following the part that identifies the script itself.
423 ee655e64 2021-02-01 op Can be unset.
424 ee655e64 2021-02-01 op .It Ev PATH_TRANSLATED
425 ee655e64 2021-02-01 op Present if and only if
426 ee655e64 2021-02-01 op .Ev PATH_INFO
428 ee655e64 2021-02-01 op It represent the translation of the
429 ee655e64 2021-02-01 op .Ev PATH_INFO .
431 ee655e64 2021-02-01 op builds this by appending the
432 ee655e64 2021-02-01 op .Ev PATH_INFO
433 ee655e64 2021-02-01 op to the virtual host directory root.
434 ee655e64 2021-02-01 op .It Ev QUERY_STRING
435 ee655e64 2021-02-01 op The decoded query string.
436 ee655e64 2021-02-01 op .It Ev REMOTE_ADDR , Ev REMOTE_HOST
437 ee655e64 2021-02-01 op Textual representation of the client IP.
438 ee655e64 2021-02-01 op .It Ev REQUEST_METHOD
439 ee655e64 2021-02-01 op This is present only for RFC3875 (CGI) compliance.
440 ee655e64 2021-02-01 op It's always set to the empty string.
441 ee655e64 2021-02-01 op .It Ev SCRIPT_NAME
442 ee655e64 2021-02-01 op The part of the
443 ee655e64 2021-02-01 op .Ev GEMINI_URL_PATH
444 ee655e64 2021-02-01 op that identifies the current CGI script.
445 ee655e64 2021-02-01 op .It Ev SERVER_NAME
446 ee655e64 2021-02-01 op The name of the server
447 ee655e64 2021-02-01 op .It Ev SERVER_PORT
448 ee655e64 2021-02-01 op The port the server is listening on.
449 28ec6178 2021-01-24 op .It Ev SERVER_PROTOCOL
451 0ed56567 2020-11-06 op .It Ev SERVER_SOFTWARE
452 ee655e64 2021-02-01 op The name and version of the server, i.e.
454 677afbd3 2020-12-02 op .It Ev AUTH_TYPE
455 28ec6178 2021-01-24 op The string "Certificate" if the client used a certificate, otherwise
457 677afbd3 2020-12-02 op .It Ev REMOTE_USER
458 677afbd3 2020-12-02 op The subject of the client certificate if provided, otherwise unset.
459 677afbd3 2020-12-02 op .It Ev TLS_CLIENT_ISSUER
460 28ec6178 2021-01-24 op The is the issuer of the client certificate if provided, otherwise
462 677afbd3 2020-12-02 op .It Ev TLS_CLIENT_HASH
463 677afbd3 2020-12-02 op The hash of the client certificate if provided, otherwise unset.
464 ee655e64 2021-02-01 op The format is
465 ee655e64 2021-02-01 op .Dq ALGO:HASH .
466 89541eee 2021-04-13 op .It Ev TLS_VERSION
467 89541eee 2021-04-13 op The TLS version negotiated with the peer.
468 89541eee 2021-04-13 op .It Ev TLS_CIPHER
469 89541eee 2021-04-13 op The cipher suite negotiated with the peer.
470 89541eee 2021-04-13 op .It Ev TLS_CIPHER_STRENGTH
471 89541eee 2021-04-13 op The strength in bits for the symmetric cipher that is being used with
473 b63e30ff 2021-02-07 op .It Ev TLS_CLIENT_NOT_AFTER
474 b63e30ff 2021-02-07 op The time corresponding to the end of the validity period of the peer
475 b63e30ff 2021-02-07 op certificate in the ISO 8601 format
476 b63e30ff 2021-02-07 op .Pq e.g. Dq 2021-02-07T20:17:41Z .
477 b63e30ff 2021-02-07 op .It Ev TLS_CLIENT_NOT_BEFORE
478 b63e30ff 2021-02-07 op The time corresponding to the start of the validity period of the peer
479 b63e30ff 2021-02-07 op certificate in the ISO 8601 format.
483 ada16f87 2021-06-11 op optionally supports FastCGI.
486 ada16f87 2021-06-11 op rule must be present in a server or location block.
487 ada16f87 2021-06-11 op Then, all requests matching that server or location will be handled
488 ada16f87 2021-06-11 op via the specified FastCGI backend.
490 ada16f87 2021-06-11 op By default the following variables
491 ada16f87 2021-06-11 op .Pq parameters
492 ada16f87 2021-06-11 op are sent, and carry the same semantics as with CGI.
493 ada16f87 2021-06-11 op More parameters can be added with the
497 ada16f87 2021-06-11 op .Bl -bullet -compact
499 ada16f87 2021-06-11 op GATEWAY_INTERFACE
501 ada16f87 2021-06-11 op GEMINI_URL_PATH
509 ada16f87 2021-06-11 op REQUEST_METHOD
513 ada16f87 2021-06-11 op SERVER_PROTOCOL
515 ada16f87 2021-06-11 op SERVER_SOFTWARE
521 ada16f87 2021-06-11 op TLS_CLIENT_ISSUER
523 ada16f87 2021-06-11 op TLS_CLIENT_HASH
529 ada16f87 2021-06-11 op TLS_CIPHER_STRENGTH
531 ada16f87 2021-06-11 op TLS_CLIENT_NOT_BEFORE
533 ada16f87 2021-06-11 op TLS_CLIENT_NOT_AFTER
536 75fbb178 2021-01-28 op To auto-detect the MIME type of the response
538 75fbb178 2021-01-28 op looks at the file extension and consults its internal table.
539 75fbb178 2021-01-28 op By default the following mappings are loaded, but they can be
540 75fbb178 2021-01-28 op overridden or extended using the
542 75fbb178 2021-01-28 op configuration option.
543 75fbb178 2021-01-28 op If no MIME is found, the value of
544 75fbb178 2021-01-28 op .Ic default type
545 75fbb178 2021-01-28 op matching the file
547 75fbb178 2021-01-28 op will be used, which is
548 75fbb178 2021-01-28 op .Dq application/octet-stream
551 75fbb178 2021-01-28 op .Bl -tag -offset indent -width 14m -compact
554 75fbb178 2021-01-28 op .It gemini, gmi
562 75fbb178 2021-01-28 op .It markdown, md
563 75fbb178 2021-01-28 op text/markdown
567 75fbb178 2021-01-28 op application/pdf
571 75fbb178 2021-01-28 op image/svg+xml
578 f28d96d3 2021-01-25 op Serve the current directory
579 6980aad6 2020-10-02 op .Bd -literal -offset indent
583 f28d96d3 2021-01-25 op To serve the directory
585 f28d96d3 2021-01-25 op and enable CGI scripts inside
587 0ed56567 2020-11-06 op .Bd -literal -offset indent
588 f28d96d3 2021-01-25 op $ mkdir docs/cgi
589 b7a99061 2021-04-15 op $ cat <<EOF > docs/cgi/hello
591 0ed56567 2020-11-06 op printf "20 text/plain\\r\\n"
592 f28d96d3 2021-01-25 op echo "hello world"
594 f28d96d3 2021-01-25 op $ chmod +x docs/cgi/hello
595 b890467e 2021-03-20 op $ gmid -x '/cgi/*' docs
598 eb699783 2021-01-18 op The following is an example of a possible configuration for a site
599 eb699783 2021-01-18 op that enables only TLSv1.3, adds a mime type for the file extension
600 eb699783 2021-01-18 op "rtf" and defines two virtual host:
601 eb699783 2021-01-18 op .Bd -literal -offset indent
602 eb699783 2021-01-18 op ipv6 on # enable ipv6
604 eb699783 2021-01-18 op protocols "tlsv1.3"
606 d19951cf 2021-07-09 op map "application/rtf" to-ext "rtf"
608 eb699783 2021-01-18 op server "example.com" {
609 eb699783 2021-01-18 op cert "/path/to/cert.pem"
610 eb699783 2021-01-18 op key "/path/to/key.pem"
611 eb699783 2021-01-18 op root "/var/gemini/example.com"
614 eb699783 2021-01-18 op server "it.example.com" {
615 eb699783 2021-01-18 op cert "/path/to/cert.pem"
616 eb699783 2021-01-18 op key "/path/to/key.pem"
617 eb699783 2021-01-18 op root "/var/gemini/it.example.com"
619 2b520ad5 2021-07-09 op # enable cgi scripts inside "cgi-bin"
620 87f2b68b 2021-02-02 op cgi "/cgi-bin/*"
622 2b520ad5 2021-07-09 op # set the language for text/gemini files
627 f28d96d3 2021-01-25 op Yet another example, showing how to enable a
632 f28d96d3 2021-01-25 op .Bd -literal -offset indent
633 f28d96d3 2021-01-25 op chroot "/var/gemini"
636 f28d96d3 2021-01-25 op server "example.com" {
637 2b520ad5 2021-07-09 op cert "/path/to/cert.pem" # absolute path
638 2b520ad5 2021-07-09 op key "/path/to/key.pem" # also absolute
639 2b520ad5 2021-07-09 op root "/example.com" # relative to the chroot
641 4ee08bd1 2021-02-03 op location "/static/*" {
642 2b520ad5 2021-07-09 op # load the following rules only for
643 2b520ad5 2021-07-09 op # requests that matches "/static/*"
645 f28d96d3 2021-01-25 op auto index on
646 f28d96d3 2021-01-25 op index "index.gemini"
650 ef04b551 2021-01-09 op .Sh ACKNOWLEDGEMENTS
653 eb699783 2021-01-18 op .Dq Flexible and Economical
654 eb699783 2021-01-18 op UTF-8 decoder written by
655 f28d96d3 2021-01-25 op .An Bjoern Hoehrmann .
660 714685c1 2021-01-30 op program was written by
661 714685c1 2021-01-30 op .An Omar Polo Aq Mt op@omarpolo.com .
665 2b520ad5 2021-07-09 op All the root directories are opened during the daemon startup; if a
666 2b520ad5 2021-07-09 op root directory is deleted and then re-created,
668 eb699783 2021-01-18 op won't be able to serve files inside that directory until a restart.
669 2b520ad5 2021-07-09 op This restriction only applies to the root directories and not their
672 714685c1 2021-01-30 op a %2F sequence is indistinguishable from a literal slash: this is not
673 714685c1 2021-01-30 op RFC3986-compliant.
675 714685c1 2021-01-30 op a %00 sequence is treated as invalid character and thus rejected.
