1 f28d96d3 2021-01-25 op .\" Copyright (c) 2021 Omar Polo <op@omarpolo.com>
  2 3e4749f7 2020-10-02 op .\"
  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.
  6 3e4749f7 2020-10-02 op .\"
  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$
 15 3f47867e 2021-04-16 op .Dt GMID 1
 16 3e4749f7 2020-10-02 op .Os
 17 3e4749f7 2020-10-02 op .Sh NAME
 18 3e4749f7 2020-10-02 op .Nm gmid
 19 714685c1 2021-01-30 op .Nd simple and secure Gemini server
 20 3e4749f7 2020-10-02 op .Sh SYNOPSIS
 21 3e4749f7 2020-10-02 op .Nm
 22 3e4749f7 2020-10-02 op .Bk -words
 23 38d4db74 2021-02-04 op .Op Fl fnv
 24 15902770 2021-01-15 op .Op Fl c Ar config
 25 38d4db74 2021-02-04 op .Ek
 26 38d4db74 2021-02-04 op .Nm
 27 38d4db74 2021-02-04 op .Bk -words
 28 8904fa0e 2021-01-27 op .Op Fl 6hv
 29 f28d96d3 2021-01-25 op .Op Fl d Pa certs-dir
 30 f28d96d3 2021-01-25 op .Op Fl H Ar hostname
 31 721e2325 2020-11-18 op .Op Fl p Ar port
 32 f28d96d3 2021-01-25 op .Op Fl x Pa cgi
 33 f28d96d3 2021-01-25 op .Op Pa dir
 34 3e4749f7 2020-10-02 op .Ek
 35 3e4749f7 2020-10-02 op .Sh DESCRIPTION
 36 3e4749f7 2020-10-02 op .Nm
 37 b9220ca4 2021-01-11 op is a simple and minimal gemini server that can serve static files and
 38 b9220ca4 2021-01-11 op execute CGI scripts.
 39 eb699783 2021-01-18 op It can run without a configuration file with a limited set of features
 40 eb699783 2021-01-18 op available.
 41 3007f565 2021-02-04 op .Pp
 42 3007f565 2021-02-04 op .Nm
 43 3007f565 2021-02-04 op rereads the configuration file when it receives
 44 3007f565 2021-02-04 op .Dv SIGHUP .
 45 3e4749f7 2020-10-02 op .Pp
 46 eb699783 2021-01-18 op The options are as follows:
 47 f28d96d3 2021-01-25 op .Bl -tag -width 14m
 48 eb699783 2021-01-18 op .It Fl c Pa config
 49 f28d96d3 2021-01-25 op Specify the configuration file.
 50 46af8c6c 2021-01-27 op .It Fl f
 51 46af8c6c 2021-01-27 op Stays and logs on the foreground.
 52 eb699783 2021-01-18 op .It Fl n
 53 eb699783 2021-01-18 op Check that the configuration is valid, but don't start the server.
 54 eb699783 2021-01-18 op .El
 55 3e4749f7 2020-10-02 op .Pp
 56 eb699783 2021-01-18 op If no configuration file is given,
 57 fab952e1 2020-10-03 op .Nm
 58 f28d96d3 2021-01-25 op will look for the following options
 59 f28d96d3 2021-01-25 op .Bl -tag -width 14m
 60 85dff1f9 2021-01-11 op .It Fl 6
 61 85dff1f9 2021-01-11 op Enable IPv6.
 62 f28d96d3 2021-01-25 op .It Fl d Pa certs-path
 63 f28d96d3 2021-01-25 op Directory where certificates for the config-less mode are stored.
 64 f28d96d3 2021-01-25 op By default is
 65 f28d96d3 2021-01-25 op .Pa $XDG_DATA_HOME/gmid ,
 66 f28d96d3 2021-01-25 op i.e.
 67 f28d96d3 2021-01-25 op .Pa ~/.local/share/gmid .
 68 71cf3975 2021-01-25 op .It Fl H Ar hostname
 69 f28d96d3 2021-01-25 op The hostname, by default
 70 f28d96d3 2021-01-25 op .Ar localhost .
 71 f28d96d3 2021-01-25 op Certificates for the given
 72 f28d96d3 2021-01-25 op .Ar hostname
 73 f28d96d3 2021-01-25 op are searched inside the
 74 f28d96d3 2021-01-25 op .Pa certs-dir
 75 f28d96d3 2021-01-25 op directory given with the
 76 f28d96d3 2021-01-25 op .Fl d
 77 f28d96d3 2021-01-25 op option.
 78 714685c1 2021-01-30 op They have the form
 79 f28d96d3 2021-01-25 op .Pa hostname.cert.pem
 80 f28d96d3 2021-01-25 op and
 81 f28d96d3 2021-01-25 op .Pa hostname.key.pem .
 82 1de92289 2021-04-15 op If a certificate or key don't exists for a given hostname they
 83 714685c1 2021-01-30 op will be automatically generated.
 84 3e4749f7 2020-10-02 op .It Fl h
 85 fab952e1 2020-10-03 op Print the usage and exit.
 86 721e2325 2020-11-18 op .It Fl p Ar port
 87 eb699783 2021-01-18 op The port to listen on, by default 1965.
 88 8904fa0e 2021-01-27 op .It Fl v
 89 3abf91b0 2021-02-07 op Verbose mode.
 90 3abf91b0 2021-02-07 op Multiple
 91 3abf91b0 2021-02-07 op .Fl v
 92 3abf91b0 2021-02-07 op options increase the verbosity.
 93 f28d96d3 2021-01-25 op .It Fl x Pa path
 94 eb699783 2021-01-18 op Enable execution of CGI scripts.
 95 eb699783 2021-01-18 op See the description of the
 96 eb699783 2021-01-18 op .Ic cgi
 97 eb699783 2021-01-18 op option in the section
 98 eb699783 2021-01-18 op .Sq Servers
 99 eb699783 2021-01-18 op below to learn how
100 f28d96d3 2021-01-25 op .Pa path
101 eb699783 2021-01-18 op is processed.
102 eb699783 2021-01-18 op Cannot be provided more than once.
103 f28d96d3 2021-01-25 op .It Pa dir
104 f28d96d3 2021-01-25 op The root directory to serve.
105 f28d96d3 2021-01-25 op By default the current working directory is assumed.
106 3e4749f7 2020-10-02 op .El
107 eb699783 2021-01-18 op .Sh CONFIGURATION FILE
108 eb699783 2021-01-18 op The configuration file is divided into two sections:
109 eb699783 2021-01-18 op .Bl -tag -width xxxx
110 eb699783 2021-01-18 op .It Sy Global Options
111 eb699783 2021-01-18 op Global settings for
112 eb699783 2021-01-18 op .Nm .
113 eb699783 2021-01-18 op .It Sy Servers
114 f28d96d3 2021-01-25 op Virtual hosts definition.
115 eb699783 2021-01-18 op .El
116 eb699783 2021-01-18 op .Pp
117 eb699783 2021-01-18 op Within the sections, empty lines are ignored and comments can be put
118 eb699783 2021-01-18 op anywhere in the file using a hash mark
119 eb699783 2021-01-18 op .Pq Sq # ,
120 eb699783 2021-01-18 op and extend to the end of the current line.
121 eb699783 2021-01-18 op A boolean is either the symbol
122 eb699783 2021-01-18 op .Sq on
123 eb699783 2021-01-18 op or
124 eb699783 2021-01-18 op .Sq off .
125 f28d96d3 2021-01-25 op A string is a sequence of characters wrapped in double quotes,
126 f28d96d3 2021-01-25 op .Dq like this .
127 eb699783 2021-01-18 op .Ss Global Options
128 eb699783 2021-01-18 op .Bl -tag -width 12m
129 ae08ec7d 2021-01-25 op .It Ic chroot Pa path
130 ae08ec7d 2021-01-25 op .Xr chroot 2
131 ae08ec7d 2021-01-25 op the process to the given
132 ae08ec7d 2021-01-25 op .Pa path .
133 ae08ec7d 2021-01-25 op The daemon has to be run with root privileges and thus the option
134 ae08ec7d 2021-01-25 op .Ic user
135 714685c1 2021-01-30 op needs to be provided, so privileges can be dropped.
136 714685c1 2021-01-30 op Note that
137 ae08ec7d 2021-01-25 op .Nm
138 714685c1 2021-01-30 op will enter the chroot after loading the TLS keys, but before opening
139 714685c1 2021-01-30 op the virtual host root directories.
140 714685c1 2021-01-30 op It's recommended to keep the TLS keys outside the chroot.
141 ae08ec7d 2021-01-25 op Future version of
142 ae08ec7d 2021-01-25 op .Nm
143 1de92289 2021-04-15 op may enforce this.
144 2b92a447 2021-02-06 op .It Ic ipv6 Ar bool
145 2b92a447 2021-02-06 op Enable or disable IPv6 support.
146 2b92a447 2021-02-06 op By default is off.
147 2b92a447 2021-02-06 op .It Ic mime Ar mime-type Ar file-extension
148 2b92a447 2021-02-06 op Add a mapping for the given
149 2b92a447 2021-02-06 op .Ar file-extension
150 2b92a447 2021-02-06 op to the given
151 2b92a447 2021-02-06 op .Ar mime-type .
152 2b92a447 2021-02-06 op Both argument are strings.
153 2b92a447 2021-02-06 op .It Ic port Ar portno
154 2b92a447 2021-02-06 op The port to listen on.
155 2b92a447 2021-02-06 op By default is 1965.
156 a709ddf5 2021-02-07 op .It Ic prefork Ar number
157 a709ddf5 2021-02-07 op Run the specified number of server processes.
158 a709ddf5 2021-02-07 op This increases the performance and prevents delays when connecting to
159 a709ddf5 2021-02-07 op a server.
160 a709ddf5 2021-02-07 op .Nm
161 a709ddf5 2021-02-07 op runs 3 server processes by default, when not in config-less mode.
162 2c3e53da 2021-03-03 op The maximum number allowed is 16.
163 2b92a447 2021-02-06 op .It Ic protocols Ar string
164 2b92a447 2021-02-06 op Specify the TLS protocols to enable.
165 2b92a447 2021-02-06 op Refer to
166 2b92a447 2021-02-06 op .Xr tls_config_parse_protocols 3
167 2b92a447 2021-02-06 op for the valid protocol string values.
168 2b92a447 2021-02-06 op By default, both TLSv1.3 and TLSv1.2 are enabled.
169 2b92a447 2021-02-06 op Use
170 2b92a447 2021-02-06 op .Dq tlsv1.3
171 2b92a447 2021-02-06 op to enable only TLSv1.3.
172 ae08ec7d 2021-01-25 op .It Ic user Ar string
173 ae08ec7d 2021-01-25 op Run the daemon as the given user.
174 eb699783 2021-01-18 op .El
175 eb699783 2021-01-18 op .Ss Servers
176 eb699783 2021-01-18 op Every virtual host is defined by a
177 eb699783 2021-01-18 op .Ic server
178 eb699783 2021-01-18 op block:
179 eb699783 2021-01-18 op .Bl -tag -width Ds
180 eb699783 2021-01-18 op .It Ic server Ar hostname Brq ...
181 75fbb178 2021-01-28 op Match the server name using shell globbing rules.
182 75fbb178 2021-01-28 op This can be an explicit name,
183 de27389e 2021-01-21 op .Ar www.example.com ,
184 de27389e 2021-01-21 op or a name including a wildcards,
185 de27389e 2021-01-21 op .Ar *.example.com .
186 eb699783 2021-01-18 op .El
187 eb699783 2021-01-18 op .Pp
188 eb699783 2021-01-18 op Followed by a block of options that is enclosed in curly brackets:
189 eb699783 2021-01-18 op .Bl -tag -width Ds
190 2b92a447 2021-02-06 op .It Ic auto Ic index Ar bool
191 2b92a447 2021-02-06 op If no index file is found, automatically generate a directory listing.
192 2b92a447 2021-02-06 op It's disabled by default.
193 2b92a447 2021-02-06 op .It Ic block Op Ic return Ar code Op Ar meta
194 2b92a447 2021-02-06 op Send a reply and close the connection;
195 2b92a447 2021-02-06 op .Ar code
196 2b92a447 2021-02-06 op is 40
197 2b92a447 2021-02-06 op and
198 2b92a447 2021-02-06 op .Ar meta
199 2b92a447 2021-02-06 op is
200 2b92a447 2021-02-06 op .Dq temporary failure
201 2b92a447 2021-02-06 op by default.
202 2b92a447 2021-02-06 op If
203 2b92a447 2021-02-06 op .Ar code
204 2b92a447 2021-02-06 op is in the 3x range, then
205 2b92a447 2021-02-06 op .Ar meta
206 2b92a447 2021-02-06 op must be provided.
207 2b92a447 2021-02-06 op Inside
208 2b92a447 2021-02-06 op .Ar meta ,
209 2b92a447 2021-02-06 op the following special sequences are replaced:
210 2b92a447 2021-02-06 op .Bl -tag -compact
211 2b92a447 2021-02-06 op .It \&%\&%
212 2b92a447 2021-02-06 op is replaced with a single
213 2b92a447 2021-02-06 op .Sq \&% .
214 2b92a447 2021-02-06 op .It \&%p
215 2b92a447 2021-02-06 op is replaced with the request path.
216 2b92a447 2021-02-06 op .It \&%q
217 2b92a447 2021-02-06 op is replaced with the query string of the request.
218 2b92a447 2021-02-06 op .It \&%P
219 2b92a447 2021-02-06 op is replaced with the server port.
220 2b92a447 2021-02-06 op .It \&%N
221 2b92a447 2021-02-06 op is replaced with the server name.
222 2b92a447 2021-02-06 op .El
223 eb699783 2021-01-18 op .It Ic cert Pa file
224 eb699783 2021-01-18 op Path to the certificate to use for this server.
225 eb699783 2021-01-18 op The
226 eb699783 2021-01-18 op .Pa file
227 eb699783 2021-01-18 op should contain a PEM encoded certificate.
228 eb699783 2021-01-18 op This option is mandatory.
229 eb699783 2021-01-18 op .It Ic cgi Pa path
230 87f2b68b 2021-02-02 op Execute CGI scripts that matches
231 eb699783 2021-01-18 op .Pa path
232 87f2b68b 2021-02-02 op using shell globbing rules.
233 6119e13e 2021-01-19 op .It Ic default type Ar string
234 6119e13e 2021-01-19 op Set the default media type that is used if the media type for a
235 6119e13e 2021-01-19 op specified extension is not found.
236 6119e13e 2021-01-19 op If not specified, the
237 6119e13e 2021-01-19 op .Ic default type
238 6119e13e 2021-01-19 op is set to
239 6119e13e 2021-01-19 op .Dq application/octet-stream .
240 2b92a447 2021-02-06 op .It Ic entrypoint Pa path
241 dafaf467 2021-04-15 op Handle all the requests for the current virtual host using the
242 dafaf467 2021-04-15 op CGI script at
243 dafaf467 2021-04-15 op .Pa path .
244 9cc630aa 2021-04-28 op .It Ic env Ar name Ar value
245 9cc630aa 2021-04-28 op Set the environment variable
246 9cc630aa 2021-04-28 op .Ar name
247 9cc630aa 2021-04-28 op to
248 9cc630aa 2021-04-28 op .Ar value
249 9cc630aa 2021-04-28 op when executing CGI scripts.
250 9cc630aa 2021-04-28 op Can be provided more than once.
251 2b92a447 2021-02-06 op .It Ic index Ar string
252 2b92a447 2021-02-06 op Set the directory index file.
253 2b92a447 2021-02-06 op If not specified, it defaults to
254 2b92a447 2021-02-06 op .Pa index.gmi .
255 2b92a447 2021-02-06 op .It Ic key Pa file
256 2b92a447 2021-02-06 op Specify the private key to use for this server.
257 2b92a447 2021-02-06 op The
258 2b92a447 2021-02-06 op .Pa file
259 2b92a447 2021-02-06 op should contain a PEM encoded private key.
260 2b92a447 2021-02-06 op This option is mandatory.
261 05c23a54 2021-01-19 op .It Ic lang Ar string
262 05c23a54 2021-01-19 op Specify the language tag for the text/gemini content served.
263 05c23a54 2021-01-19 op If not specified, no
264 05c23a54 2021-01-19 op .Dq lang
265 05c23a54 2021-01-19 op parameter will be added in the response.
266 c8b74339 2021-01-24 op .It Ic location Pa path Brq ...
267 c8b74339 2021-01-24 op Specify server configuration rules for a specific location.
268 c8b74339 2021-01-24 op The
269 c8b74339 2021-01-24 op .Pa path
270 c8b74339 2021-01-24 op argument will be matched against the request path with shell globbing
271 c8b74339 2021-01-24 op rules.
272 6016a593 2021-01-30 op In case of multiple location statements in the same context, the first
273 6016a593 2021-01-30 op matching location will be put into effect and the later ones ignored.
274 6016a593 2021-01-30 op Therefore is advisable to match for more specific paths first and for
275 6016a593 2021-01-30 op generic ones later on.
276 c8b74339 2021-01-24 op A
277 c8b74339 2021-01-24 op .Ic location
278 c8b74339 2021-01-24 op section may include most of the server configuration rules
279 c8b74339 2021-01-24 op except
280 9cc630aa 2021-04-28 op .Ic cert , Ic env , Ic key , Ic root , Ic location ,
281 e3ddf390 2021-02-06 op .Ic entrypoint No and Ic cgi .
282 2b92a447 2021-02-06 op .It Ic root Pa directory
283 2b92a447 2021-02-06 op Specify the root directory for this server.
284 2b92a447 2021-02-06 op This option is mandatory.
285 2b92a447 2021-02-06 op It's relative to the chroot, if enabled.
286 02be96c6 2021-02-09 op .It Ic require Ic client Ic ca Pa path
287 02be96c6 2021-02-09 op Allow requests only from clients that provide a certificate signed by
288 02be96c6 2021-02-09 op the CA certificate in
289 02be96c6 2021-02-09 op .Pa path .
290 02be96c6 2021-02-09 op It needs to be a PEM-encoded certificate and it's not relative to the
291 02be96c6 2021-02-09 op chroot.
292 6abda252 2021-02-06 op .It Ic strip Ar number
293 6abda252 2021-02-06 op Strip
294 6abda252 2021-02-06 op .Ar number
295 6abda252 2021-02-06 op components from the beginning of the path.
296 6abda252 2021-02-06 op It's only considered for the
297 6abda252 2021-02-06 op .Ar meta
298 2b92a447 2021-02-06 op parameter in the scope of a
299 6abda252 2021-02-06 op .Ic block return .
300 6abda252 2021-02-06 op .El
301 72342dc9 2020-11-06 op .Sh CGI
302 87f2b68b 2021-02-02 op When a request for an executable file matches the
303 87f2b68b 2021-02-02 op .Ic cgi
304 87f2b68b 2021-02-02 op rule, that file will be execute and its output fed to the client.
305 72342dc9 2020-11-06 op .Pp
306 ee655e64 2021-02-01 op The CGI scripts are executed in the directory they reside and inherit
307 a7b9bb4d 2021-01-24 op the environment from
308 0ed56567 2020-11-06 op .Nm
309 0ed56567 2020-11-06 op with these additional variables set:
310 ee655e64 2021-02-01 op .Bl -tag -width 24m
311 28ec6178 2021-01-24 op .It Ev GATEWAY_INTERFACE
312 ee655e64 2021-02-01 op .Dq CGI/1.1
313 ee655e64 2021-02-01 op .It Ev GEMINI_DOCUMENT_ROOT
314 ee655e64 2021-02-01 op The root directory of the virtual host.
315 ee655e64 2021-02-01 op .It Ev GEMINI_SCRIPT_FILENAME
316 ee655e64 2021-02-01 op Full path to the CGI script being executed.
317 ee655e64 2021-02-01 op .It Ev GEMINI_URL
318 ee655e64 2021-02-01 op The full IRI of the request.
319 ee655e64 2021-02-01 op .It Ev GEMINI_URL_PATH
320 ee655e64 2021-02-01 op The path of the request.
321 ee655e64 2021-02-01 op .It Ev PATH_INFO
322 ee655e64 2021-02-01 op The portion of the requested path that is derived from the the IRI
323 ee655e64 2021-02-01 op path hierarchy following the part that identifies the script itself.
324 ee655e64 2021-02-01 op Can be unset.
325 ee655e64 2021-02-01 op .It Ev PATH_TRANSLATED
326 ee655e64 2021-02-01 op Present if and only if
327 ee655e64 2021-02-01 op .Ev PATH_INFO
328 ee655e64 2021-02-01 op is set.
329 ee655e64 2021-02-01 op It represent the translation of the
330 ee655e64 2021-02-01 op .Ev PATH_INFO .
331 ee655e64 2021-02-01 op .Nm
332 ee655e64 2021-02-01 op builds this by appending the
333 ee655e64 2021-02-01 op .Ev PATH_INFO
334 ee655e64 2021-02-01 op to the virtual host directory root.
335 ee655e64 2021-02-01 op .It Ev QUERY_STRING
336 ee655e64 2021-02-01 op The decoded query string.
337 ee655e64 2021-02-01 op .It Ev REMOTE_ADDR , Ev REMOTE_HOST
338 ee655e64 2021-02-01 op Textual representation of the client IP.
339 ee655e64 2021-02-01 op .It Ev REQUEST_METHOD
340 ee655e64 2021-02-01 op This is present only for RFC3875 (CGI) compliance.
341 ee655e64 2021-02-01 op It's always set to the empty string.
342 ee655e64 2021-02-01 op .It Ev SCRIPT_NAME
343 ee655e64 2021-02-01 op The part of the
344 ee655e64 2021-02-01 op .Ev GEMINI_URL_PATH
345 ee655e64 2021-02-01 op that identifies the current CGI script.
346 ee655e64 2021-02-01 op .It Ev SERVER_NAME
347 ee655e64 2021-02-01 op The name of the server
348 ee655e64 2021-02-01 op .It Ev SERVER_PORT
349 ee655e64 2021-02-01 op The port the server is listening on.
350 28ec6178 2021-01-24 op .It Ev SERVER_PROTOCOL
351 ee655e64 2021-02-01 op .Dq GEMINI
352 0ed56567 2020-11-06 op .It Ev SERVER_SOFTWARE
353 ee655e64 2021-02-01 op The name and version of the server, i.e.
354 ee655e64 2021-02-01 op .Dq gmid/1.5
355 677afbd3 2020-12-02 op .It Ev AUTH_TYPE
356 28ec6178 2021-01-24 op The string "Certificate" if the client used a certificate, otherwise
357 28ec6178 2021-01-24 op unset.
358 677afbd3 2020-12-02 op .It Ev REMOTE_USER
359 677afbd3 2020-12-02 op The subject of the client certificate if provided, otherwise unset.
360 677afbd3 2020-12-02 op .It Ev TLS_CLIENT_ISSUER
361 28ec6178 2021-01-24 op The is the issuer of the client certificate if provided, otherwise
362 28ec6178 2021-01-24 op unset.
363 677afbd3 2020-12-02 op .It Ev TLS_CLIENT_HASH
364 677afbd3 2020-12-02 op The hash of the client certificate if provided, otherwise unset.
365 ee655e64 2021-02-01 op The format is
366 ee655e64 2021-02-01 op .Dq ALGO:HASH .
367 89541eee 2021-04-13 op .It Ev TLS_VERSION
368 89541eee 2021-04-13 op The TLS version negotiated with the peer.
369 89541eee 2021-04-13 op .It Ev TLS_CIPHER
370 89541eee 2021-04-13 op The cipher suite negotiated with the peer.
371 89541eee 2021-04-13 op .It Ev TLS_CIPHER_STRENGTH
372 89541eee 2021-04-13 op The strength in bits for the symmetric cipher that is being used with
373 89541eee 2021-04-13 op the peer.
374 b63e30ff 2021-02-07 op .It Ev TLS_CLIENT_NOT_AFTER
375 b63e30ff 2021-02-07 op The time corresponding to the end of the validity period of the peer
376 b63e30ff 2021-02-07 op certificate in the ISO 8601 format
377 b63e30ff 2021-02-07 op .Pq e.g. Dq 2021-02-07T20:17:41Z .
378 b63e30ff 2021-02-07 op .It Ev TLS_CLIENT_NOT_BEFORE
379 b63e30ff 2021-02-07 op The time corresponding to the start of the validity period of the peer
380 b63e30ff 2021-02-07 op certificate in the ISO 8601 format.
381 0ed56567 2020-11-06 op .El
382 a5d310bc 2020-11-10 op .Pp
383 75fbb178 2021-01-28 op .Sh MIME
384 75fbb178 2021-01-28 op To auto-detect the MIME type of the response
385 75fbb178 2021-01-28 op .Nm
386 75fbb178 2021-01-28 op looks at the file extension and consults its internal table.
387 75fbb178 2021-01-28 op By default the following mappings are loaded, but they can be
388 75fbb178 2021-01-28 op overridden or extended using the
389 75fbb178 2021-01-28 op .Ic mime
390 75fbb178 2021-01-28 op configuration option.
391 75fbb178 2021-01-28 op If no MIME is found, the value of
392 75fbb178 2021-01-28 op .Ic default type
393 75fbb178 2021-01-28 op matching the file
394 75fbb178 2021-01-28 op .Ic location
395 75fbb178 2021-01-28 op will be used, which is
396 75fbb178 2021-01-28 op .Dq application/octet-stream
397 75fbb178 2021-01-28 op by default.
398 75fbb178 2021-01-28 op .Pp
399 75fbb178 2021-01-28 op .Bl -tag -offset indent -width 14m -compact
400 4d820b6c 2021-04-21 op .It diff
401 4d820b6c 2021-04-21 op text/x-patch
402 75fbb178 2021-01-28 op .It gemini, gmi
403 75fbb178 2021-01-28 op text/gemini
404 75fbb178 2021-01-28 op .It gif
405 75fbb178 2021-01-28 op image/gif
406 75fbb178 2021-01-28 op .It jpeg
407 75fbb178 2021-01-28 op image/jpeg
408 75fbb178 2021-01-28 op .It jpg
409 75fbb178 2021-01-28 op image/jpeg
410 75fbb178 2021-01-28 op .It markdown, md
411 75fbb178 2021-01-28 op text/markdown
412 4d820b6c 2021-04-21 op .It patch
413 4d820b6c 2021-04-21 op text/x-patch
414 75fbb178 2021-01-28 op .It pdf
415 75fbb178 2021-01-28 op application/pdf
416 75fbb178 2021-01-28 op .It png
417 75fbb178 2021-01-28 op image/png
418 75fbb178 2021-01-28 op .It svg
419 75fbb178 2021-01-28 op image/svg+xml
420 75fbb178 2021-01-28 op .It txt
421 75fbb178 2021-01-28 op text/plain
422 75fbb178 2021-01-28 op .It xml
423 75fbb178 2021-01-28 op text/xml
424 75fbb178 2021-01-28 op .El
425 3e4749f7 2020-10-02 op .Sh EXAMPLES
426 f28d96d3 2021-01-25 op Serve the current directory
427 6980aad6 2020-10-02 op .Bd -literal -offset indent
428 f28d96d3 2021-01-25 op $ gmid .
429 6980aad6 2020-10-02 op .Ed
430 3e4749f7 2020-10-02 op .Pp
431 f28d96d3 2021-01-25 op To serve the directory
432 f28d96d3 2021-01-25 op .Pa docs
433 f28d96d3 2021-01-25 op and enable CGI scripts inside
434 f28d96d3 2021-01-25 op .Pa docs/cgi ,
435 f28d96d3 2021-01-25 op you can
436 0ed56567 2020-11-06 op .Bd -literal -offset indent
437 f28d96d3 2021-01-25 op $ mkdir docs/cgi
438 b7a99061 2021-04-15 op $ cat <<EOF > docs/cgi/hello
439 0ed56567 2020-11-06 op #!/bin/sh
440 0ed56567 2020-11-06 op printf "20 text/plain\\r\\n"
441 f28d96d3 2021-01-25 op echo "hello world"
442 0ed56567 2020-11-06 op EOF
443 f28d96d3 2021-01-25 op $ chmod +x docs/cgi/hello
444 b890467e 2021-03-20 op $ gmid -x '/cgi/*' docs
445 0ed56567 2020-11-06 op .Ed
446 0ed56567 2020-11-06 op .Pp
447 eb699783 2021-01-18 op The following is an example of a possible configuration for a site
448 eb699783 2021-01-18 op that enables only TLSv1.3, adds a mime type for the file extension
449 eb699783 2021-01-18 op "rtf" and defines two virtual host:
450 eb699783 2021-01-18 op .Bd -literal -offset indent
451 eb699783 2021-01-18 op ipv6 on		# enable ipv6
452 eb699783 2021-01-18 op 
453 eb699783 2021-01-18 op protocols "tlsv1.3"
454 eb699783 2021-01-18 op 
455 eb699783 2021-01-18 op mime "application/rtf" "rtf"
456 eb699783 2021-01-18 op 
457 eb699783 2021-01-18 op server "example.com" {
458 eb699783 2021-01-18 op 	cert "/path/to/cert.pem"
459 eb699783 2021-01-18 op 	key  "/path/to/key.pem"
460 eb699783 2021-01-18 op 	root "/var/gemini/example.com"
461 eb699783 2021-01-18 op }
462 eb699783 2021-01-18 op 
463 eb699783 2021-01-18 op server "it.example.com" {
464 eb699783 2021-01-18 op 	cert "/path/to/cert.pem"
465 eb699783 2021-01-18 op 	key  "/path/to/key.pem"
466 eb699783 2021-01-18 op 	root "/var/gemini/it.example.com"
467 87f2b68b 2021-02-02 op 	cgi  "/cgi-bin/*"
468 de27389e 2021-01-21 op 	lang "it"
469 eb699783 2021-01-18 op }
470 eb699783 2021-01-18 op .Ed
471 f28d96d3 2021-01-25 op .Pp
472 f28d96d3 2021-01-25 op Yet another example, showing how to enable a
473 f28d96d3 2021-01-25 op .Ic chroot
474 f28d96d3 2021-01-25 op and use
475 f28d96d3 2021-01-25 op .Ic location
476 f28d96d3 2021-01-25 op rule
477 f28d96d3 2021-01-25 op .Bd -literal -offset indent
478 f28d96d3 2021-01-25 op chroot "/var/gemini"
479 f28d96d3 2021-01-25 op user "_gmid"
480 f28d96d3 2021-01-25 op 
481 f28d96d3 2021-01-25 op server "example.com" {
482 f28d96d3 2021-01-25 op 	cert "/path/to/cert.pem"
483 f28d96d3 2021-01-25 op 	key  "/path/to/key.pem"
484 714685c1 2021-01-30 op 	root "/example.com" # in the /var/gemini chroot
485 f28d96d3 2021-01-25 op 
486 4ee08bd1 2021-02-03 op 	location "/static/*" {
487 f28d96d3 2021-01-25 op 		auto index on
488 f28d96d3 2021-01-25 op 		index "index.gemini"
489 f28d96d3 2021-01-25 op 	}
490 f28d96d3 2021-01-25 op }
491 f28d96d3 2021-01-25 op .Ed
492 ef04b551 2021-01-09 op .Sh ACKNOWLEDGEMENTS
493 ef04b551 2021-01-09 op .Nm
494 eb699783 2021-01-18 op uses the
495 eb699783 2021-01-18 op .Dq Flexible and Economical
496 eb699783 2021-01-18 op UTF-8 decoder written by
497 f28d96d3 2021-01-25 op .An Bjoern Hoehrmann .
498 714685c1 2021-01-30 op .Sh AUTHORS
499 714685c1 2021-01-30 op .An -nosplit
500 714685c1 2021-01-30 op The
501 714685c1 2021-01-30 op .Nm
502 714685c1 2021-01-30 op program was written by
503 714685c1 2021-01-30 op .An Omar Polo Aq Mt op@omarpolo.com .
504 3e4749f7 2020-10-02 op .Sh CAVEATS
505 3e4749f7 2020-10-02 op .Bl -bullet
506 3e4749f7 2020-10-02 op .It
507 eb699783 2021-01-18 op The root directories of all virtual hosts are opened during the daemon
508 eb699783 2021-01-18 op startup; this means that if a root directory gets deleted and then
509 eb699783 2021-01-18 op re-created,
510 eb699783 2021-01-18 op .Nm
511 eb699783 2021-01-18 op won't be able to serve files inside that directory until a restart.
512 eb699783 2021-01-18 op This restriction applies only to the root directories and not their content.
513 043acc97 2020-12-25 op .It
514 714685c1 2021-01-30 op a %2F sequence is indistinguishable from a literal slash: this is not
515 714685c1 2021-01-30 op RFC3986-compliant.
516 00781742 2020-12-25 op .It
517 714685c1 2021-01-30 op a %00 sequence is treated as invalid character and thus rejected.
518 3e4749f7 2020-10-02 op .El