Blame


1 7edcf2b3 2023-06-24 op .\" Copyright (c) 2022, 2023 Omar Polo <op@omarpolo.com>
2 1595c277 2022-04-07 op .\"
3 1595c277 2022-04-07 op .\" Permission to use, copy, modify, and distribute this software for any
4 1595c277 2022-04-07 op .\" purpose with or without fee is hereby granted, provided that the above
5 1595c277 2022-04-07 op .\" copyright notice and this permission notice appear in all copies.
6 1595c277 2022-04-07 op .\"
7 1595c277 2022-04-07 op .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 1595c277 2022-04-07 op .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 1595c277 2022-04-07 op .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 1595c277 2022-04-07 op .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 1595c277 2022-04-07 op .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 1595c277 2022-04-07 op .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 1595c277 2022-04-07 op .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14 7edcf2b3 2023-06-24 op .Dd June 24, 2023
15 1595c277 2022-04-07 op .Dt GMID.CONF 5
16 1595c277 2022-04-07 op .Os
17 1595c277 2022-04-07 op .Sh NAME
18 1595c277 2022-04-07 op .Nm gmid.conf
19 1595c277 2022-04-07 op .Nd gmid Gemini server configuration file
20 1595c277 2022-04-07 op .Sh DESCRIPTION
21 1595c277 2022-04-07 op .Nm
22 1595c277 2022-04-07 op is the configuration file format for the
23 9b15e4c6 2022-09-08 op .Xr gmid 8
24 1595c277 2022-04-07 op Gemini server.
25 1595c277 2022-04-07 op .Pp
26 7edcf2b3 2023-06-24 op The configuration file is divided into the following sections:
27 7edcf2b3 2023-06-24 op .Bl -tag -width Ds
28 1595c277 2022-04-07 op .It Sy Macros
29 1595c277 2022-04-07 op User-defined variables may be defined and used later, simplifying the
30 1595c277 2022-04-07 op configuration file.
31 1595c277 2022-04-07 op .It Sy Global Options
32 1595c277 2022-04-07 op Global settings for
33 7edcf2b3 2023-06-24 op .Xr gmid 8 .
34 1595c277 2022-04-07 op .It Sy Servers
35 1595c277 2022-04-07 op Virtual hosts definition.
36 1595c277 2022-04-07 op .It Sy Types
37 1595c277 2022-04-07 op Media types and extensions.
38 1595c277 2022-04-07 op .El
39 1595c277 2022-04-07 op .Pp
40 1595c277 2022-04-07 op Within the sections, empty lines are ignored and comments can be put
41 1595c277 2022-04-07 op anywhere in the file using a hash mark
42 7edcf2b3 2023-06-24 op .Pq Sq #
43 1595c277 2022-04-07 op and extend to the end of the current line.
44 1595c277 2022-04-07 op A boolean is either the symbol
45 1595c277 2022-04-07 op .Sq on
46 1595c277 2022-04-07 op or
47 1595c277 2022-04-07 op .Sq off .
48 1595c277 2022-04-07 op A string is a sequence of characters wrapped in double quotes,
49 1595c277 2022-04-07 op .Dq like this .
50 1595c277 2022-04-07 op Multiple strings one next to the other are joined into a single
51 1595c277 2022-04-07 op string:
52 1595c277 2022-04-07 op .Bd -literal -offset indent
53 1595c277 2022-04-07 op # equivalent to "temporary-failure"
54 1595c277 2022-04-07 op block return 40 "temporary" "-" "failure"
55 1595c277 2022-04-07 op .Ed
56 1595c277 2022-04-07 op .Pp
57 1595c277 2022-04-07 op Furthermore, quoting is necessary only when a string needs to contain
58 1595c277 2022-04-07 op special characters
59 1595c277 2022-04-07 op .Pq like spaces or punctuation ,
60 1595c277 2022-04-07 op something that looks like a number or a reserved keyword.
61 1595c277 2022-04-07 op The last example could have been written also as:
62 1595c277 2022-04-07 op .Bd -literal -offset indent
63 1595c277 2022-04-07 op block return 40 temporary "-" failure
64 1595c277 2022-04-07 op .Ed
65 1595c277 2022-04-07 op .Pp
66 1595c277 2022-04-07 op Strict ordering of the sections is not enforced, so that is possible
67 1595c277 2022-04-07 op to mix macros, options and
68 1595c277 2022-04-07 op .Ic server
69 1595c277 2022-04-07 op blocks.
70 1595c277 2022-04-07 op However, defining all the
71 1595c277 2022-04-07 op .Ic server
72 1595c277 2022-04-07 op blocks after the macros and the global options is recommended.
73 1595c277 2022-04-07 op .Pp
74 1595c277 2022-04-07 op Newlines are often optional, except around top-level instructions, and
75 1595c277 2022-04-07 op semicolons
76 1595c277 2022-04-07 op .Dq \&;
77 1595c277 2022-04-07 op can also be optionally used to separate options.
78 1595c277 2022-04-07 op .Pp
79 1595c277 2022-04-07 op Additional configuration files can be included with the
80 1595c277 2022-04-07 op .Ic include
81 1595c277 2022-04-07 op keyword, for example:
82 1595c277 2022-04-07 op .Bd -literal -offset indent
83 1595c277 2022-04-07 op include "/etc/gmid.conf.local"
84 1595c277 2022-04-07 op .Ed
85 1595c277 2022-04-07 op .Ss Macros
86 1595c277 2022-04-07 op Macros can be defined that will later be expanded in context.
87 1595c277 2022-04-07 op Macro names must start with a letter, digit or underscore and may
88 1595c277 2022-04-07 op contain any of those characters.
89 1595c277 2022-04-07 op Macros names may not be reserved words.
90 1595c277 2022-04-07 op Macros are not expanded inside quotes.
91 1595c277 2022-04-07 op .Pp
92 1595c277 2022-04-07 op Two kinds of macros are supported: variable-like and proper macros.
93 1595c277 2022-04-07 op When a macro is invoked with a
94 1595c277 2022-04-07 op .Dq $
95 1595c277 2022-04-07 op before its name its expanded as a string, whereas when it's invoked
96 1595c277 2022-04-07 op with a
97 1595c277 2022-04-07 op .Dq @
98 1595c277 2022-04-07 op its expanded in-place.
99 1595c277 2022-04-07 op .Pp
100 1595c277 2022-04-07 op For example:
101 1595c277 2022-04-07 op .Bd -literal -offset indent
102 1595c277 2022-04-07 op dir = "/var/gemini"
103 1595c277 2022-04-07 op certdir = "/etc/keys"
104 1595c277 2022-04-07 op common = "lang it; auto index on"
105 1595c277 2022-04-07 op
106 1595c277 2022-04-07 op server "foo" {
107 7edcf2b3 2023-06-24 op root $dir "/foo" # "/var/gemini/foo"
108 7edcf2b3 2023-06-24 op cert $certdir "/foo.pem" # "/etc/keys/foo.pem"
109 7edcf2b3 2023-06-24 op key $certdir "/foo.key" # "/etc/keys/foo.key"
110 1595c277 2022-04-07 op @common
111 1595c277 2022-04-07 op }
112 1595c277 2022-04-07 op .Ed
113 1595c277 2022-04-07 op .Ss Global Options
114 1595c277 2022-04-07 op .Bl -tag -width 12m
115 1595c277 2022-04-07 op .It Ic chroot Ar path
116 1595c277 2022-04-07 op .Xr chroot 2
117 1595c277 2022-04-07 op the process to the given
118 1595c277 2022-04-07 op .Ar path .
119 1595c277 2022-04-07 op The daemon has to be run with root privileges and thus the option
120 1595c277 2022-04-07 op .Ic user
121 7edcf2b3 2023-06-24 op needs to be provided too, so privileges can be dropped afterwards.
122 7edcf2b3 2023-06-24 op All the paths in the configuration file are relative to the chroot
123 7edcf2b3 2023-06-24 op directory, except for the
124 7edcf2b3 2023-06-24 op .Ic cert ,
125 7edcf2b3 2023-06-24 op .Ic key
126 7edcf2b3 2023-06-24 op and
127 7edcf2b3 2023-06-24 op .Ic ocsp
128 7edcf2b3 2023-06-24 op paths.
129 287ab865 2023-06-24 op Defaults to the
130 287ab865 2023-06-24 op .Ic user
131 287ab865 2023-06-24 op home directory, if provided.
132 1595c277 2022-04-07 op .It Ic prefork Ar number
133 1595c277 2022-04-07 op Run the specified number of server processes.
134 1595c277 2022-04-07 op This increases the performance and prevents delays when connecting to
135 1595c277 2022-04-07 op a server.
136 7edcf2b3 2023-06-24 op .Xr gmid 8
137 1595c277 2022-04-07 op runs 3 server processes by default.
138 1595c277 2022-04-07 op The maximum number allowed is 16.
139 1595c277 2022-04-07 op .It Ic protocols Ar string
140 1595c277 2022-04-07 op Specify the TLS protocols to enable.
141 1595c277 2022-04-07 op Refer to
142 1595c277 2022-04-07 op .Xr tls_config_parse_protocols 3
143 1595c277 2022-04-07 op for the valid protocol string values.
144 1595c277 2022-04-07 op By default, both TLSv1.3 and TLSv1.2 are enabled.
145 1595c277 2022-04-07 op Use
146 1595c277 2022-04-07 op .Dq tlsv1.3
147 1595c277 2022-04-07 op to enable only TLSv1.3.
148 1595c277 2022-04-07 op .It Ic user Ar string
149 1595c277 2022-04-07 op Run the daemon as the given user.
150 1595c277 2022-04-07 op .El
151 1595c277 2022-04-07 op .Ss Servers
152 1595c277 2022-04-07 op Every virtual host is defined by a
153 1595c277 2022-04-07 op .Ic server
154 1595c277 2022-04-07 op block:
155 1595c277 2022-04-07 op .Bl -tag -width Ds
156 1595c277 2022-04-07 op .It Ic server Ar hostname Brq ...
157 1595c277 2022-04-07 op Match the server name using shell globbing rules.
158 1595c277 2022-04-07 op It can be an explicit name,
159 1595c277 2022-04-07 op .Ar www.example.com ,
160 1595c277 2022-04-07 op or a name including a wildcards,
161 1595c277 2022-04-07 op .Ar *.example.com .
162 1595c277 2022-04-07 op .El
163 1595c277 2022-04-07 op .Pp
164 1595c277 2022-04-07 op Followed by a block of options that is enclosed in curly brackets:
165 1595c277 2022-04-07 op .Bl -tag -width Ds
166 1595c277 2022-04-07 op .It Ic alias Ar name
167 1595c277 2022-04-07 op Specify an additional alias
168 1595c277 2022-04-07 op .Ar name
169 1595c277 2022-04-07 op for this server.
170 1595c277 2022-04-07 op .It Ic auto Ic index Ar bool
171 1595c277 2022-04-07 op If no index file is found, automatically generate a directory listing.
172 1595c277 2022-04-07 op Disabled by default.
173 1595c277 2022-04-07 op .It Ic block Op Ic return Ar code Op Ar meta
174 1595c277 2022-04-07 op Send a reply and close the connection;
175 1595c277 2022-04-07 op by default
176 1595c277 2022-04-07 op .Ar code
177 1595c277 2022-04-07 op is 40
178 1595c277 2022-04-07 op and
179 1595c277 2022-04-07 op .Ar meta
180 1595c277 2022-04-07 op is
181 1595c277 2022-04-07 op .Dq temporary failure .
182 1595c277 2022-04-07 op If
183 1595c277 2022-04-07 op .Ar code
184 1595c277 2022-04-07 op is in the 3x range, then
185 1595c277 2022-04-07 op .Ar meta
186 1595c277 2022-04-07 op is mandatory.
187 1595c277 2022-04-07 op Inside
188 1595c277 2022-04-07 op .Ar meta ,
189 1595c277 2022-04-07 op the following special sequences are supported:
190 1595c277 2022-04-07 op .Bl -tag -width Ds -compact
191 1595c277 2022-04-07 op .It \&%\&%
192 1595c277 2022-04-07 op is replaced with a single
193 1595c277 2022-04-07 op .Sq \&% .
194 1595c277 2022-04-07 op .It \&%p
195 1595c277 2022-04-07 op is replaced with the request path.
196 1595c277 2022-04-07 op .It \&%q
197 1595c277 2022-04-07 op is replaced with the query string of the request.
198 1595c277 2022-04-07 op .It \&%P
199 1595c277 2022-04-07 op is replaced with the server port.
200 1595c277 2022-04-07 op .It \&%N
201 1595c277 2022-04-07 op is replaced with the server name.
202 1595c277 2022-04-07 op .El
203 1595c277 2022-04-07 op .It Ic cert Ar file
204 1595c277 2022-04-07 op Path to the certificate to use for this server.
205 1595c277 2022-04-07 op .Ar file
206 1595c277 2022-04-07 op should contain a PEM encoded certificate.
207 1595c277 2022-04-07 op This option is mandatory.
208 9b15e4c6 2022-09-08 op .It Ic default type Ar string
209 9b15e4c6 2022-09-08 op Set the default media type that is used if the media type for a
210 9b15e4c6 2022-09-08 op specified extension is not found.
211 9b15e4c6 2022-09-08 op If not specified, the
212 9b15e4c6 2022-09-08 op .Ic default type
213 9b15e4c6 2022-09-08 op is set to
214 9b15e4c6 2022-09-08 op .Dq application/octet-stream .
215 9b15e4c6 2022-09-08 op .It Ic fastcgi Oo Ic tcp Oc Ar socket Oo Cm port Ar port Oc
216 9b15e4c6 2022-09-08 op Enable
217 9b15e4c6 2022-09-08 op .Sx FastCGI
218 9b15e4c6 2022-09-08 op instead of serving files.
219 9b15e4c6 2022-09-08 op The
220 9b15e4c6 2022-09-08 op .Ar socket
221 9b15e4c6 2022-09-08 op can either be a UNIX-domain socket or a TCP socket.
222 9b15e4c6 2022-09-08 op If the FastCGI application is listening on a UNIX domain socket,
223 9b15e4c6 2022-09-08 op .Ar socket
224 9b15e4c6 2022-09-08 op is a local path name within the
225 9b15e4c6 2022-09-08 op .Xr chroot 2
226 9b15e4c6 2022-09-08 op root directory of
227 9b15e4c6 2022-09-08 op .Nm .
228 9b15e4c6 2022-09-08 op Otherwise, the
229 9b15e4c6 2022-09-08 op .Ic tcp
230 9b15e4c6 2022-09-08 op keyword must be provided and
231 9b15e4c6 2022-09-08 op .Ar socket
232 9b15e4c6 2022-09-08 op is interpreted as a hostname or an IP address.
233 9b15e4c6 2022-09-08 op .Ar port
234 9b15e4c6 2022-09-08 op can be either a port number or the name of a service enclosed in
235 9b15e4c6 2022-09-08 op double quotes.
236 9b15e4c6 2022-09-08 op If not specified defaults to 9000.
237 9b15e4c6 2022-09-08 op .It Ic index Ar string
238 9b15e4c6 2022-09-08 op Set the directory index file.
239 9b15e4c6 2022-09-08 op If not specified, it defaults to
240 9b15e4c6 2022-09-08 op .Pa index.gmi .
241 9b15e4c6 2022-09-08 op .It Ic key Ar file
242 9b15e4c6 2022-09-08 op Specify the private key to use for this server.
243 9b15e4c6 2022-09-08 op .Ar file
244 9b15e4c6 2022-09-08 op should contain a PEM encoded private key.
245 9b15e4c6 2022-09-08 op This option is mandatory.
246 9b15e4c6 2022-09-08 op .It Ic lang Ar string
247 9b15e4c6 2022-09-08 op Specify the language tag for the text/gemini content served.
248 9b15e4c6 2022-09-08 op If not specified, no
249 9b15e4c6 2022-09-08 op .Dq lang
250 9b15e4c6 2022-09-08 op parameter will be added in the response.
251 7edcf2b3 2023-06-24 op .It Ic listen on Ar address Ic port Ar number
252 7edcf2b3 2023-06-24 op Set the listen address and port.
253 7edcf2b3 2023-06-24 op This statement can be specified multiple times.
254 7edcf2b3 2023-06-24 op If
255 7edcf2b3 2023-06-24 op .Ar address
256 7edcf2b3 2023-06-24 op is
257 7edcf2b3 2023-06-24 op .Sq *
258 7edcf2b3 2023-06-24 op then
259 7edcf2b3 2023-06-24 op .Xr gmid 8
260 7edcf2b3 2023-06-24 op will listen on all IPv4 and IPv6 addresses.
261 7edcf2b3 2023-06-24 op .Ar 0.0.0.0
262 7edcf2b3 2023-06-24 op means to listen on all IPv4 addresses and
263 7edcf2b3 2023-06-24 op .Ar ::
264 7edcf2b3 2023-06-24 op all IPv6 addresses.
265 9b15e4c6 2022-09-08 op .It Ic location Ar path Brq ...
266 9b15e4c6 2022-09-08 op Specify server configuration rules for a specific location.
267 1595c277 2022-04-07 op .Ar path
268 9b15e4c6 2022-09-08 op argument will be matched against the request path with shell globbing
269 9b15e4c6 2022-09-08 op rules.
270 9b15e4c6 2022-09-08 op In case of multiple location statements in the same context, the first
271 9b15e4c6 2022-09-08 op matching location will be put into effect and the later ones ignored.
272 9b15e4c6 2022-09-08 op Therefore is advisable to match for more specific paths first and for
273 9b15e4c6 2022-09-08 op generic ones later on.
274 9b15e4c6 2022-09-08 op A
275 9b15e4c6 2022-09-08 op .Ic location
276 9b15e4c6 2022-09-08 op section may include most of the server configuration rules
277 9b15e4c6 2022-09-08 op except
278 7edcf2b3 2023-06-24 op .Ic alias , Ic cert , Ic key , Ic listen , Ic location , Ic param
279 7edcf2b3 2023-06-24 op and
280 7edcf2b3 2023-06-24 op .Ic proxy .
281 9b15e4c6 2022-09-08 op .It Ic log Ar bool
282 9b15e4c6 2022-09-08 op Enable or disable the logging for the current server or location block.
283 9b15e4c6 2022-09-08 op .It Ic param Ar name Cm = Ar value
284 9b15e4c6 2022-09-08 op Set the param
285 9b15e4c6 2022-09-08 op .Ar name
286 9b15e4c6 2022-09-08 op to
287 9b15e4c6 2022-09-08 op .Ar value
288 9b15e4c6 2022-09-08 op for FastCGI.
289 9b15e4c6 2022-09-08 op By default the following parameters are defined:
290 1595c277 2022-04-07 op .Bl -tag -width 24m
291 1595c277 2022-04-07 op .It Ev GATEWAY_INTERFACE
292 1595c277 2022-04-07 op .Dq CGI/1.1
293 1595c277 2022-04-07 op .It Ev GEMINI_DOCUMENT_ROOT
294 1595c277 2022-04-07 op The root directory of the virtual host.
295 1595c277 2022-04-07 op .It Ev GEMINI_SCRIPT_FILENAME
296 9b15e4c6 2022-09-08 op Full path to the FastCGI script being executed.
297 1595c277 2022-04-07 op .It Ev GEMINI_URL
298 1595c277 2022-04-07 op The full IRI of the request.
299 1595c277 2022-04-07 op .It Ev GEMINI_URL_PATH
300 1595c277 2022-04-07 op The path of the request.
301 97b306cb 2022-11-27 op .It Ev GEMINI_SEARCH_STRING
302 97b306cb 2022-11-27 op The decoded
303 97b306cb 2022-11-27 op .Ev QUERY_STRING
304 97b306cb 2022-11-27 op if defined in the request and if it doesn't contain any unencoded
305 97b306cb 2022-11-27 op .Sq =
306 97b306cb 2022-11-27 op characters, otherwise unset.
307 1595c277 2022-04-07 op .It Ev PATH_INFO
308 1595c277 2022-04-07 op The portion of the requested path that is derived from the the IRI
309 1595c277 2022-04-07 op path hierarchy following the part that identifies the script itself.
310 1595c277 2022-04-07 op Can be unset.
311 1595c277 2022-04-07 op .It Ev PATH_TRANSLATED
312 1595c277 2022-04-07 op Present if and only if
313 1595c277 2022-04-07 op .Ev PATH_INFO
314 1595c277 2022-04-07 op is set.
315 1595c277 2022-04-07 op It represent the translation of the
316 1595c277 2022-04-07 op .Ev PATH_INFO .
317 1595c277 2022-04-07 op .Nm gmid
318 1595c277 2022-04-07 op builds this by appending the
319 1595c277 2022-04-07 op .Ev PATH_INFO
320 1595c277 2022-04-07 op to the virtual host directory root.
321 1595c277 2022-04-07 op .It Ev QUERY_STRING
322 77718c12 2022-11-27 op The URL-encoded search or parameter string.
323 1595c277 2022-04-07 op .It Ev REMOTE_ADDR , Ev REMOTE_HOST
324 1595c277 2022-04-07 op Textual representation of the client IP.
325 1595c277 2022-04-07 op .It Ev REQUEST_METHOD
326 1595c277 2022-04-07 op This is present only for RFC3875 (CGI) compliance.
327 1595c277 2022-04-07 op It's always set to the empty string.
328 1595c277 2022-04-07 op .It Ev SCRIPT_NAME
329 9b15e4c6 2022-09-08 op The virtual URI path to the script.
330 1595c277 2022-04-07 op .It Ev SERVER_NAME
331 1595c277 2022-04-07 op The name of the server
332 1595c277 2022-04-07 op .It Ev SERVER_PORT
333 1595c277 2022-04-07 op The port the server is listening on.
334 1595c277 2022-04-07 op .It Ev SERVER_PROTOCOL
335 1595c277 2022-04-07 op .Dq GEMINI
336 1595c277 2022-04-07 op .It Ev SERVER_SOFTWARE
337 1595c277 2022-04-07 op The name and version of the server, i.e.
338 1f6de749 2022-07-04 op .Dq gmid/1.8.4
339 1595c277 2022-04-07 op .It Ev AUTH_TYPE
340 1595c277 2022-04-07 op The string "Certificate" if the client used a certificate, otherwise
341 1595c277 2022-04-07 op unset.
342 1595c277 2022-04-07 op .It Ev REMOTE_USER
343 1595c277 2022-04-07 op The subject of the client certificate if provided, otherwise unset.
344 1595c277 2022-04-07 op .It Ev TLS_CLIENT_ISSUER
345 1595c277 2022-04-07 op The is the issuer of the client certificate if provided, otherwise
346 1595c277 2022-04-07 op unset.
347 1595c277 2022-04-07 op .It Ev TLS_CLIENT_HASH
348 1595c277 2022-04-07 op The hash of the client certificate if provided, otherwise unset.
349 1595c277 2022-04-07 op The format is
350 1595c277 2022-04-07 op .Dq ALGO:HASH .
351 1595c277 2022-04-07 op .It Ev TLS_VERSION
352 1595c277 2022-04-07 op The TLS version negotiated with the peer.
353 1595c277 2022-04-07 op .It Ev TLS_CIPHER
354 1595c277 2022-04-07 op The cipher suite negotiated with the peer.
355 1595c277 2022-04-07 op .It Ev TLS_CIPHER_STRENGTH
356 1595c277 2022-04-07 op The strength in bits for the symmetric cipher that is being used with
357 1595c277 2022-04-07 op the peer.
358 1595c277 2022-04-07 op .It Ev TLS_CLIENT_NOT_AFTER
359 1595c277 2022-04-07 op The time corresponding to the end of the validity period of the peer
360 1595c277 2022-04-07 op certificate in the ISO 8601 format
361 1595c277 2022-04-07 op .Pq e.g. Dq 2021-02-07T20:17:41Z .
362 1595c277 2022-04-07 op .It Ev TLS_CLIENT_NOT_BEFORE
363 1595c277 2022-04-07 op The time corresponding to the start of the validity period of the peer
364 1595c277 2022-04-07 op certificate in the ISO 8601 format.
365 1595c277 2022-04-07 op .El
366 1595c277 2022-04-07 op .It Ic ocsp Ar file
367 1595c277 2022-04-07 op Specify an OCSP response to be stapled during TLS handshakes
368 1595c277 2022-04-07 op with this server.
369 1595c277 2022-04-07 op The
370 1595c277 2022-04-07 op .Ar file
371 1595c277 2022-04-07 op should contain a DER-format OCSP response retrieved from an
372 1595c277 2022-04-07 op OCSP server for the
373 1595c277 2022-04-07 op .Ic cert
374 1595c277 2022-04-07 op in use.
375 1595c277 2022-04-07 op If the OCSP response in
376 1595c277 2022-04-07 op .Ar file
377 1595c277 2022-04-07 op is empty, OCSP stapling will not be used.
378 1595c277 2022-04-07 op The default is to not use OCSP stapling.
379 d2da235a 2022-10-05 op .It Ic proxy Oo Cm proto Ar name Oc Oo Cm for-host Ar host Oo Cm port Ar port Oc Oc Brq ...
380 1595c277 2022-04-07 op Set up a reverse proxy.
381 1595c277 2022-04-07 op The optional matching rules
382 1595c277 2022-04-07 op .Cm proto
383 1595c277 2022-04-07 op and
384 1595c277 2022-04-07 op .Cm for-host
385 1595c277 2022-04-07 op can be used to enable proxying only for protocols matching
386 1595c277 2022-04-07 op .Ar name
387 1595c277 2022-04-07 op .Po Dq gemini
388 1595c277 2022-04-07 op by default
389 1595c277 2022-04-07 op .Pc
390 1595c277 2022-04-07 op and/or whose request IRI matches
391 1595c277 2022-04-07 op .Ar host
392 1595c277 2022-04-07 op and
393 1595c277 2022-04-07 op .Ar port
394 1595c277 2022-04-07 op .Pq 1965 by default .
395 1595c277 2022-04-07 op Matching happens using shell globbing rules.
396 1595c277 2022-04-07 op .Pp
397 1595c277 2022-04-07 op In case of multiple matching proxy blocks in the same context, the
398 1595c277 2022-04-07 op first matching proxy will be put into effect and the later ones
399 1595c277 2022-04-07 op ignored.
400 1595c277 2022-04-07 op .Pp
401 1595c277 2022-04-07 op Valid options are:
402 1595c277 2022-04-07 op .Bl -tag -width Ds
403 1595c277 2022-04-07 op .It Ic cert Ar file
404 1595c277 2022-04-07 op Specify the client certificate to use when making requests.
405 1595c277 2022-04-07 op .It Ic key Ar file
406 1595c277 2022-04-07 op Specify the client certificate key to use when making requests.
407 1595c277 2022-04-07 op .It Ic protocols Ar string
408 1595c277 2022-04-07 op Specify the TLS protocols allowed when making remote requests.
409 1595c277 2022-04-07 op Refer to the
410 1595c277 2022-04-07 op .Xr tls_config_parse_protocols 3
411 1595c277 2022-04-07 op function for the valid protocol string values.
412 1595c277 2022-04-07 op By default, both TLSv1.2 and TLSv1.3 are enabled.
413 d2da235a 2022-10-05 op .It Ic relay-to Ar host Op Cm port Ar port
414 1595c277 2022-04-07 op Relay the request to the given
415 1595c277 2022-04-07 op .Ar host
416 1595c277 2022-04-07 op at the given
417 1595c277 2022-04-07 op .Ar port ,
418 1595c277 2022-04-07 op 1965 by default.
419 1595c277 2022-04-07 op This is the only mandatory option in a
420 1595c277 2022-04-07 op .Ic proxy
421 1595c277 2022-04-07 op block.
422 1595c277 2022-04-07 op .It Ic require Ic client Ic ca Ar file
423 1595c277 2022-04-07 op Allow the proxying only from clients that provide a certificate
424 1595c277 2022-04-07 op signed by the CA certificate in
425 1595c277 2022-04-07 op .Ar file .
426 1595c277 2022-04-07 op .It Ic sni Ar hostname
427 1595c277 2022-04-07 op Use the given
428 1595c277 2022-04-07 op .Ar hostname
429 1595c277 2022-04-07 op instead of the one extracted from the
430 1595c277 2022-04-07 op .Ic relay-to
431 1595c277 2022-04-07 op rule for the TLS handshake with the proxied gemini server.
432 1595c277 2022-04-07 op .It Ic use-tls Ar bool
433 1595c277 2022-04-07 op Specify whether to use TLS when connecting to the proxied host.
434 1595c277 2022-04-07 op Enabled by default.
435 1595c277 2022-04-07 op .It Ic verifyname Ar bool
436 1595c277 2022-04-07 op Enable or disable the TLS server name verification.
437 1595c277 2022-04-07 op Enabled by default.
438 1595c277 2022-04-07 op .El
439 1595c277 2022-04-07 op .It Ic root Ar directory
440 1595c277 2022-04-07 op Specify the root directory for this server
441 1595c277 2022-04-07 op .Pq alas the current Dq document root .
442 1595c277 2022-04-07 op It's relative to the chroot if enabled.
443 1595c277 2022-04-07 op .It Ic require Ic client Ic ca Ar path
444 1595c277 2022-04-07 op Allow requests only from clients that provide a certificate signed by
445 1595c277 2022-04-07 op the CA certificate in
446 1595c277 2022-04-07 op .Ar path .
447 1595c277 2022-04-07 op It needs to be a PEM-encoded certificate and it's not relative to the
448 1595c277 2022-04-07 op chroot.
449 1595c277 2022-04-07 op .It Ic strip Ar number
450 1595c277 2022-04-07 op Strip
451 1595c277 2022-04-07 op .Ar number
452 1595c277 2022-04-07 op components from the beginning of the path before doing a lookup in the
453 1595c277 2022-04-07 op root directory.
454 1595c277 2022-04-07 op It's also considered for the
455 1595c277 2022-04-07 op .Ar meta
456 1595c277 2022-04-07 op parameter in the scope of a
457 1595c277 2022-04-07 op .Ic block return .
458 1595c277 2022-04-07 op .El
459 1595c277 2022-04-07 op .Ss Types
460 1595c277 2022-04-07 op The
461 1595c277 2022-04-07 op .Ic types
462 1595c277 2022-04-07 op section must include one or more lines of the following syntax, enclosed
463 1595c277 2022-04-07 op in curly brances:
464 1595c277 2022-04-07 op .Bl -tag -width Ds
465 7edcf2b3 2023-06-24 op .It Ar type Ns / Ns Ar subtype Ar name Op Ar name ...
466 1595c277 2022-04-07 op Set the media
467 1595c277 2022-04-07 op .Ar type
468 1595c277 2022-04-07 op and
469 1595c277 2022-04-07 op .Ar subtype
470 1595c277 2022-04-07 op to the specified extension
471 1595c277 2022-04-07 op .Ar name .
472 1595c277 2022-04-07 op One or more names can be specified per line.
473 1595c277 2022-04-07 op Earch line may end with an optional semicolon.
474 1595c277 2022-04-07 op .It Ic include Ar file
475 1595c277 2022-04-07 op Include types definition from an external file, for example
476 1595c277 2022-04-07 op .Pa /usr/share/misc/mime.types .
477 1595c277 2022-04-07 op .El
478 1595c277 2022-04-07 op .Pp
479 1595c277 2022-04-07 op By default
480 1595c277 2022-04-07 op .Nm gmid
481 5f03bf17 2022-04-08 op uses the following mapping if no
482 5f03bf17 2022-04-08 op .Ic types
483 93cab6dc 2022-04-08 op block is defined:
484 7edcf2b3 2023-06-24 op .Pp
485 1595c277 2022-04-07 op .Bl -tag -offset indent -width 15m -compact
486 1595c277 2022-04-07 op .It application/pdf
487 1595c277 2022-04-07 op pdf
488 1595c277 2022-04-07 op .It image/gif
489 1595c277 2022-04-07 op gif
490 1595c277 2022-04-07 op .It image/jpeg
491 aa6b8cf8 2022-04-08 op jpg jpeg
492 1595c277 2022-04-07 op .It image/png
493 1595c277 2022-04-07 op png
494 1595c277 2022-04-07 op .It image/svg+xml
495 1595c277 2022-04-07 op svg
496 1595c277 2022-04-07 op .It text/gemini
497 1595c277 2022-04-07 op gemini gmi
498 1595c277 2022-04-07 op .It text/markdown
499 1595c277 2022-04-07 op markdown md
500 1595c277 2022-04-07 op .It text/x-patch
501 1595c277 2022-04-07 op diff patch
502 1595c277 2022-04-07 op .It text/xml
503 1595c277 2022-04-07 op xml
504 1595c277 2022-04-07 op .El
505 93cab6dc 2022-04-08 op .Pp
506 93cab6dc 2022-04-08 op As an exception,
507 93cab6dc 2022-04-08 op .Nm gmid
508 93cab6dc 2022-04-08 op uses the MIME type
509 93cab6dc 2022-04-08 op .Ar text/gemini
510 93cab6dc 2022-04-08 op for file extensions
511 93cab6dc 2022-04-08 op .Ar gemini
512 93cab6dc 2022-04-08 op or
513 93cab6dc 2022-04-08 op .Ar gmi
514 93cab6dc 2022-04-08 op if no mapping was found.
515 1595c277 2022-04-07 op .Sh EXAMPLES
516 1595c277 2022-04-07 op The following is an example of a possible configuration for a site
517 1595c277 2022-04-07 op that enables only TLSv1.3, adds the MIME types mapping from
518 1595c277 2022-04-07 op .Pa /usr/share/misc/mime.types
519 1595c277 2022-04-07 op and defines two virtual host:
520 1595c277 2022-04-07 op .Bd -literal -offset indent
521 1595c277 2022-04-07 op protocols "tlsv1.3"
522 1595c277 2022-04-07 op
523 1595c277 2022-04-07 op types {
524 1595c277 2022-04-07 op include "/usr/share/misc/mime.types"
525 1595c277 2022-04-07 op }
526 1595c277 2022-04-07 op
527 1595c277 2022-04-07 op server "example.com" {
528 7edcf2b3 2023-06-24 op listen on * port 1965
529 1595c277 2022-04-07 op cert "/etc/ssl/example.com.pem"
530 1595c277 2022-04-07 op key "/etc/ssl/private/example.com.key"
531 1595c277 2022-04-07 op root "/var/gemini/example.com"
532 1595c277 2022-04-07 op }
533 1595c277 2022-04-07 op
534 1595c277 2022-04-07 op server "example.it" {
535 7edcf2b3 2023-06-24 op listen on * port 1965
536 1595c277 2022-04-07 op cert "/etc/ssl/example.it.pem"
537 1595c277 2022-04-07 op key "/etc/ssl/private/example.it.key"
538 1595c277 2022-04-07 op root "/var/gemini/example.it"
539 1595c277 2022-04-07 op
540 1595c277 2022-04-07 op # set the language for text/gemini files
541 1595c277 2022-04-07 op lang "it"
542 1595c277 2022-04-07 op }
543 1595c277 2022-04-07 op .Ed
544 1595c277 2022-04-07 op .Pp
545 1595c277 2022-04-07 op Yet another example, showing how to enable a
546 1595c277 2022-04-07 op .Ic chroot
547 1595c277 2022-04-07 op and use
548 1595c277 2022-04-07 op .Ic location
549 1595c277 2022-04-07 op rule
550 1595c277 2022-04-07 op .Bd -literal -offset indent
551 1595c277 2022-04-07 op chroot "/var/gemini"
552 1595c277 2022-04-07 op user "_gmid"
553 1595c277 2022-04-07 op
554 1595c277 2022-04-07 op server "example.com" {
555 7edcf2b3 2023-06-24 op listen on * port 1965
556 7edcf2b3 2023-06-24 op
557 1595c277 2022-04-07 op # absolute paths:
558 1595c277 2022-04-07 op cert "/etc/ssl/example.com.pem"
559 1595c277 2022-04-07 op key "/etc/ssl/private/example.com.key"
560 1595c277 2022-04-07 op
561 1595c277 2022-04-07 op # relative to the chroot:
562 1595c277 2022-04-07 op root "/example.com"
563 1595c277 2022-04-07 op
564 1595c277 2022-04-07 op location "/static/*" {
565 1595c277 2022-04-07 op # load the following rules only for
566 1595c277 2022-04-07 op # requests that matches "/static/*"
567 1595c277 2022-04-07 op
568 1595c277 2022-04-07 op auto index on
569 1595c277 2022-04-07 op index "index.gemini"
570 1595c277 2022-04-07 op }
571 1595c277 2022-04-07 op }
572 1595c277 2022-04-07 op .Ed
573 1595c277 2022-04-07 op .Sh SEE ALSO
574 9b15e4c6 2022-09-08 op .Xr gmid 8 ,
575 1595c277 2022-04-07 op .Xr slowcgi 8
576 1595c277 2022-04-07 op .Sh AUTHORS
577 1595c277 2022-04-07 op .An -nosplit
578 1595c277 2022-04-07 op The
579 1595c277 2022-04-07 op .Nm gmid
580 1595c277 2022-04-07 op program was written by
581 1595c277 2022-04-07 op .An Omar Polo Aq Mt op@omarpolo.com .