1 3e4749f7 2020-10-02 op .\" Copyright (c) 2020 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 3e4749f7 2020-10-02 op .Dd $Mdocdate: October 2 2020$
19 fab952e1 2020-10-03 op .Nd dead simple zero configuration gemini server
24 15902770 2021-01-15 op .Op Fl c Ar config
27 15902770 2021-01-15 op .Op Fl C Ar cert
28 15902770 2021-01-15 op .Op Fl d Ar root
29 15902770 2021-01-15 op .Op Fl K Ar key
30 721e2325 2020-11-18 op .Op Fl p Ar port
31 eb699783 2021-01-18 op .Op Fl x Ar directory
33 3e4749f7 2020-10-02 op .Sh DESCRIPTION
35 b9220ca4 2021-01-11 op is a simple and minimal gemini server that can serve static files and
36 b9220ca4 2021-01-11 op execute CGI scripts.
37 eb699783 2021-01-18 op It can run without a configuration file with a limited set of features
39 eb699783 2021-01-18 op If a configuration file is given, no other flags shall be given,
44 df6ca41d 2020-12-25 op fully supports IRIs (Internationalized Resource Identifiers, see
47 eb699783 2021-01-18 op The options are as follows:
48 eb699783 2021-01-18 op .Bl -tag -width 12m
49 eb699783 2021-01-18 op .It Fl c Pa config
50 eb699783 2021-01-18 op Specifies the configuration file.
52 eb699783 2021-01-18 op Check that the configuration is valid, but don't start the server.
55 eb699783 2021-01-18 op If no configuration file is given,
57 eb699783 2021-01-18 op will look for the following option
58 3e4749f7 2020-10-02 op .Bl -tag -width 12m
61 eb699783 2021-01-18 op .It Fl C Pa file
62 eb699783 2021-01-18 op The certificate to use.
63 eb699783 2021-01-18 op .It Fl d Pa directory
64 3e4749f7 2020-10-02 op The root directory to serve.
66 eb699783 2021-01-18 op Stays and log in the foreground, do not daemonize the process.
68 fab952e1 2020-10-03 op Print the usage and exit.
69 eb699783 2021-01-18 op .It Fl K Pa file
70 eb699783 2021-01-18 op The key for the certificate.
71 721e2325 2020-11-18 op .It Fl p Ar port
72 eb699783 2021-01-18 op The port to listen on, by default 1965.
73 eb699783 2021-01-18 op .It Fl x Pa directory
74 eb699783 2021-01-18 op Enable execution of CGI scripts.
75 eb699783 2021-01-18 op See the description of the
78 eb699783 2021-01-18 op option in the section
80 eb699783 2021-01-18 op below to learn how
83 eb699783 2021-01-18 op Cannot be provided more than once.
85 eb699783 2021-01-18 op .Sh CONFIGURATION FILE
86 eb699783 2021-01-18 op The configuration file is divided into two sections:
87 eb699783 2021-01-18 op .Bl -tag -width xxxx
88 eb699783 2021-01-18 op .It Sy Global Options
89 eb699783 2021-01-18 op Global settings for
91 eb699783 2021-01-18 op .It Sy Servers
92 eb699783 2021-01-18 op Virtual hosts definition
95 eb699783 2021-01-18 op Within the sections, empty lines are ignored and comments can be put
96 eb699783 2021-01-18 op anywhere in the file using a hash mark
98 eb699783 2021-01-18 op and extend to the end of the current line.
99 eb699783 2021-01-18 op A boolean is either the symbol
103 eb699783 2021-01-18 op .Ss Global Options
104 eb699783 2021-01-18 op .Bl -tag -width 12m
105 eb699783 2021-01-18 op .It Ic daemon Ar bool
106 eb699783 2021-01-18 op Enable or disables the daemon mode.
107 eb699783 2021-01-18 op In daemon mode
109 eb699783 2021-01-18 op will log to syslog and fork in the background.
110 eb699783 2021-01-18 op By default is off.
111 eb699783 2021-01-18 op .It Ic ipv6 Ar bool
112 eb699783 2021-01-18 op Enable or disable IPv6 support.
113 eb699783 2021-01-18 op By default is off.
114 eb699783 2021-01-18 op .It Ic port Ar portno
115 eb699783 2021-01-18 op The port to listen on.
116 eb699783 2021-01-18 op By default is 1965.
117 eb699783 2021-01-18 op .It Ic protocols Ar string
118 eb699783 2021-01-18 op Specify the TLS protocols to enable.
120 eb699783 2021-01-18 op .Xr tls_config_parse_protocols 3
121 eb699783 2021-01-18 op for the valid protocol string values.
122 eb699783 2021-01-18 op By default, both TLSv1.3 and TLSv1.2 are used.
125 eb699783 2021-01-18 op to enable only TLSv1.3.
126 eb699783 2021-01-18 op .It Ic mime Ar mime-type Ar file-extension
127 eb699783 2021-01-18 op Add a mapping for the given
128 eb699783 2021-01-18 op .Ar file-extension
130 eb699783 2021-01-18 op .Ar mime-type .
131 eb699783 2021-01-18 op Both argument are strings.
132 ae08ec7d 2021-01-25 op .It Ic chroot Pa path
134 ae08ec7d 2021-01-25 op the process to the given
136 ae08ec7d 2021-01-25 op The daemon has to be run with root privileges and thus the option
138 ae08ec7d 2021-01-25 op needs to be provided, so
140 ae08ec7d 2021-01-25 op can drop the privileges.
141 ae08ec7d 2021-01-25 op Note that they are dropped after loading the TLS keys, so it's
142 ae08ec7d 2021-01-25 op recommended to put those outside the chroot.
143 ae08ec7d 2021-01-25 op Future version of
145 ae08ec7d 2021-01-25 op may require this.
146 ae08ec7d 2021-01-25 op .It Ic user Ar string
147 ae08ec7d 2021-01-25 op Run the daemon as the given user.
150 eb699783 2021-01-18 op Every virtual host is defined by a
153 eb699783 2021-01-18 op .Bl -tag -width Ds
154 eb699783 2021-01-18 op .It Ic server Ar hostname Brq ...
155 de27389e 2021-01-21 op Match the server name using shell globbing rules. This can be an explicit name,
156 de27389e 2021-01-21 op .Ar www.example.com ,
157 de27389e 2021-01-21 op or a name including a wildcards,
158 de27389e 2021-01-21 op .Ar *.example.com .
161 eb699783 2021-01-18 op Followed by a block of options that is enclosed in curly brackets:
162 eb699783 2021-01-18 op .Bl -tag -width Ds
163 eb699783 2021-01-18 op .It Ic cert Pa file
164 eb699783 2021-01-18 op Path to the certificate to use for this server.
167 eb699783 2021-01-18 op should contain a PEM encoded certificate.
168 eb699783 2021-01-18 op This option is mandatory.
169 eb699783 2021-01-18 op .It Ic key Pa file
170 eb699783 2021-01-18 op Specify the private key to use for this server.
173 eb699783 2021-01-18 op should contain a PEM encoded private key.
174 eb699783 2021-01-18 op This option is mandatory.
175 eb699783 2021-01-18 op .It Ic root Pa directory
176 eb699783 2021-01-18 op Specify the root directory for this server.
177 eb699783 2021-01-18 op This option is mandatory.
178 eb699783 2021-01-18 op .It Ic cgi Pa path
179 eb699783 2021-01-18 op Enable the execution of CGI scripts if
181 eb699783 2021-01-18 op is a prefix of the user request string.
182 eb699783 2021-01-18 op An empty path "" will effectively enable the execution of any file
183 eb699783 2021-01-18 op with the executable bit set inside the root directory.
184 6119e13e 2021-01-19 op .It Ic default type Ar string
185 6119e13e 2021-01-19 op Set the default media type that is used if the media type for a
186 6119e13e 2021-01-19 op specified extension is not found.
187 6119e13e 2021-01-19 op If not specified, the
188 6119e13e 2021-01-19 op .Ic default type
190 6119e13e 2021-01-19 op .Dq application/octet-stream .
191 05c23a54 2021-01-19 op .It Ic lang Ar string
192 05c23a54 2021-01-19 op Specify the language tag for the text/gemini content served.
193 05c23a54 2021-01-19 op If not specified, no
195 05c23a54 2021-01-19 op parameter will be added in the response.
196 e7a2a99b 2021-01-24 op .It Ic index Ar string
197 e7a2a99b 2021-01-24 op Set the directory index file.
198 e7a2a99b 2021-01-24 op If not specified, it defaults to
199 e7a2a99b 2021-01-24 op .Pa index.gmi
200 252908e6 2021-01-24 op .It Ic auto Ic index Ar bool
201 252908e6 2021-01-24 op If no index file is found, automatically generate a directory listing.
202 252908e6 2021-01-24 op It's disabled by default.
203 c8b74339 2021-01-24 op .It Ic location Pa path Brq ...
204 c8b74339 2021-01-24 op Specify server configuration rules for a specific location.
207 c8b74339 2021-01-24 op argument will be matched against the request path with shell globbing
209 c8b74339 2021-01-24 op In case of multiple location statements in the same context, the last
210 c8b74339 2021-01-24 op matching location will be put into effect.
211 c8b74339 2021-01-24 op Therefore is advisable to match for a generic paths first and for more
212 c8b74339 2021-01-24 op specific ones later on.
215 c8b74339 2021-01-24 op section may include most of the server configuration rules
217 c8b74339 2021-01-24 op .Ic cert , Ic key , Ic root , Ic location No and Ic CGI .
220 0ed56567 2020-11-06 op When CGI scripts are enabled for a directory, a request for an
221 0ed56567 2020-11-06 op executable file will execute it and fed its output to the client.
223 a7b9bb4d 2021-01-24 op The CGI scripts are executed in the root directory of the virtual
224 a7b9bb4d 2021-01-24 op host, or in the served directory if run without config, and inherits
225 a7b9bb4d 2021-01-24 op the environment from
227 0ed56567 2020-11-06 op with these additional variables set:
228 a5d310bc 2020-11-10 op .Bl -tag -width 18m
229 28ec6178 2021-01-24 op .It Ev GATEWAY_INTERFACE
231 28ec6178 2021-01-24 op .It Ev SERVER_PROTOCOL
233 0ed56567 2020-11-06 op .It Ev SERVER_SOFTWARE
235 0ed56567 2020-11-06 op .It Ev SERVER_PORT
237 28ec6178 2021-01-24 op .It Ev SERVER_NAME
239 28ec6178 2021-01-24 op This variable is not available when operating without a configuration.
240 a5d310bc 2020-11-10 op .It Ev SCRIPT_NAME
241 28ec6178 2021-01-24 op The (public) path to the script, e.g.
242 28ec6178 2021-01-24 op .Pa "/cgi-bin/example.cgi"
243 a5d310bc 2020-11-10 op .It Ev SCRIPT_EXECUTABLE
244 a5d310bc 2020-11-10 op The full path to the executable.
245 a5d310bc 2020-11-10 op .It Ev REQUEST_URI
246 a5d310bc 2020-11-10 op The user request (without the query parameters.)
247 a5d310bc 2020-11-10 op .It Ev REQUEST_RELATIVE
248 a5d310bc 2020-11-10 op The request relative to the script.
249 0ed56567 2020-11-06 op .It Ev QUERY_STRING
250 a5d310bc 2020-11-10 op The query parameters.
251 a5d310bc 2020-11-10 op .It Ev REMOTE_HOST
252 a5d310bc 2020-11-10 op The remote IP address.
253 677afbd3 2020-12-02 op .It Ev REMOTE_ADDR
254 677afbd3 2020-12-02 op The remote IP address.
255 a5d310bc 2020-11-10 op .It Ev DOCUMENT_ROOT
256 a5d310bc 2020-11-10 op The root directory being served, the one provided with the
260 eb699783 2021-01-18 op or the root directory of the virtual host.
261 677afbd3 2020-12-02 op .It Ev AUTH_TYPE
262 28ec6178 2021-01-24 op The string "Certificate" if the client used a certificate, otherwise
264 677afbd3 2020-12-02 op .It Ev REMOTE_USER
265 677afbd3 2020-12-02 op The subject of the client certificate if provided, otherwise unset.
266 677afbd3 2020-12-02 op .It Ev TLS_CLIENT_ISSUER
267 28ec6178 2021-01-24 op The is the issuer of the client certificate if provided, otherwise
269 677afbd3 2020-12-02 op .It Ev TLS_CLIENT_HASH
270 677afbd3 2020-12-02 op The hash of the client certificate if provided, otherwise unset.
271 677afbd3 2020-12-02 op The format is "ALGO:HASH".
274 a5d310bc 2020-11-10 op Let's say you have a script in
275 a5d310bc 2020-11-10 op .Pa /cgi-bin/script
276 a5d310bc 2020-11-10 op and the user request is
277 a5d310bc 2020-11-10 op .Pa /cgi-bin/script/foo/bar?quux .
279 a5d310bc 2020-11-10 op .Ev SCRIPT_NAME
281 b9220ca4 2021-01-11 op .Pa cgi-bin/script ,
282 a5d310bc 2020-11-10 op .Ev SCRIPT_EXECUTABLE
284 a5d310bc 2020-11-10 op .Pa $DOCUMENT_ROOT/cgi-bin/script ,
285 a5d310bc 2020-11-10 op .Ev REQUEST_URI
287 b9220ca4 2021-01-11 op .Pa cgi-bin/script/foo/bar ,
288 a5d310bc 2020-11-10 op .Ev REQUEST_RELATIVE
292 a5d310bc 2020-11-10 op .Ev QUERY_STRING
296 3e4749f7 2020-10-02 op To quickly getting started
297 6980aad6 2020-10-02 op .Bd -literal -offset indent
298 3e4749f7 2020-10-02 op $ # generate a cert and a key
299 3e4749f7 2020-10-02 op $ openssl req -x509 -newkey rsa:4096 -keyout key.pem \\
300 3e4749f7 2020-10-02 op -out cert.pem -days 365 -nodes
302 3e4749f7 2020-10-02 op $ cat <<EOF > docs/index.gmi
303 3e4749f7 2020-10-02 op # Hello world
304 3e4749f7 2020-10-02 op test paragraph...
306 de27389e 2021-01-21 op $ gmid -C cert.pem -K key.pem -d docs
309 0ed56567 2020-11-06 op Now you can visit gemini://localhost/ with your preferred gemini
312 0ed56567 2020-11-06 op To add some CGI scripts, assuming a setup similar to the previous
313 0ed56567 2020-11-06 op example, you can
314 0ed56567 2020-11-06 op .Bd -literal -offset indent
315 0ed56567 2020-11-06 op $ mkdir docs/cgi-bin
316 0ed56567 2020-11-06 op $ cat <<EOF > docs/cgi-bin/hello-world
318 0ed56567 2020-11-06 op printf "20 text/plain\\r\\n"
319 0ed56567 2020-11-06 op echo "hello world!"
321 de27389e 2021-01-21 op $ gmid -C cert.pem -K key.pem -d docs -x cgi-bin
324 0ed56567 2020-11-06 op Note that the argument to the
329 0ed56567 2020-11-06 op .Pa docs/cgi-bin ,
330 a5d310bc 2020-11-10 op since it's relative to the document root.
332 eb699783 2021-01-18 op The following is an example of a possible configuration for a site
333 eb699783 2021-01-18 op that enables only TLSv1.3, adds a mime type for the file extension
334 eb699783 2021-01-18 op "rtf" and defines two virtual host:
335 eb699783 2021-01-18 op .Bd -literal -offset indent
336 eb699783 2021-01-18 op ipv6 on # enable ipv6
337 eb699783 2021-01-18 op daemon on # enable daemon mode
339 eb699783 2021-01-18 op protocols "tlsv1.3"
341 eb699783 2021-01-18 op mime "application/rtf" "rtf"
343 eb699783 2021-01-18 op server "example.com" {
344 eb699783 2021-01-18 op cert "/path/to/cert.pem"
345 eb699783 2021-01-18 op key "/path/to/key.pem"
346 eb699783 2021-01-18 op root "/var/gemini/example.com"
349 eb699783 2021-01-18 op server "it.example.com" {
350 eb699783 2021-01-18 op cert "/path/to/cert.pem"
351 eb699783 2021-01-18 op key "/path/to/key.pem"
352 eb699783 2021-01-18 op root "/var/gemini/it.example.com"
353 eb699783 2021-01-18 op cgi "/cgi-bin"
357 ef04b551 2021-01-09 op .Sh ACKNOWLEDGEMENTS
360 eb699783 2021-01-18 op .Dq Flexible and Economical
361 eb699783 2021-01-18 op UTF-8 decoder written by
362 eb699783 2021-01-18 op .An Bjoern Hoehrmann
363 eb699783 2021-01-18 op for its IRI parser.
367 eb699783 2021-01-18 op The root directories of all virtual hosts are opened during the daemon
368 eb699783 2021-01-18 op startup; this means that if a root directory gets deleted and then
371 eb699783 2021-01-18 op won't be able to serve files inside that directory until a restart.
372 eb699783 2021-01-18 op This restriction applies only to the root directories and not their content.
374 043acc97 2020-12-25 op a %2F sequence in the path part is indistinguishable from a literal
375 043acc97 2020-12-25 op slash: this is not RFC3986-compliant.
377 00781742 2020-12-25 op a %00 sequence either in the path or in the query part is treated as
378 00781742 2020-12-25 op invalid character and thus rejected.
