1 .\" Copyright (c) 2020 Omar Polo <op@omarpolo.com>
3 .\" Permission to use, copy, modify, and distribute this software for any
4 .\" purpose with or without fee is hereby granted, provided that the above
5 .\" copyright notice and this permission notice appear in all copies.
7 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14 .Dd $Mdocdate: October 2 2020$
19 .Nd dead simple zero configuration gemini server
35 is a simple and minimal gemini server that can serve static files and
37 It can run without a configuration file with a limited set of features
39 If a configuration file is given, no other flags shall be given,
44 fully supports IRIs (Internationalized Resource Identifiers, see
47 The options are as follows:
50 Specifies the configuration file.
52 Check that the configuration is valid, but don't start the server.
55 If no configuration file is given,
57 will look for the following option
62 The certificate to use.
64 The root directory to serve.
66 Stays and log in the foreground, do not daemonize the process.
68 Print the usage and exit.
70 The key for the certificate.
72 The port to listen on, by default 1965.
74 Enable execution of CGI scripts.
75 See the description of the
83 Cannot be provided more than once.
85 .Sh CONFIGURATION FILE
86 The configuration file is divided into two sections:
92 Virtual hosts definition
95 Within the sections, empty lines are ignored and comments can be put
96 anywhere in the file using a hash mark
98 and extend to the end of the current line.
99 A boolean is either the symbol
105 .It Ic daemon Ar bool
106 Enable or disables the daemon mode.
109 will log to syslog and fork in the background.
112 Enable or disable IPv6 support.
114 .It Ic port Ar portno
115 The port to listen on.
117 .It Ic protocols Ar string
118 Specify the TLS protocols to enable.
120 .Xr tls_config_parse_protocols 3
121 for the valid protocol string values.
122 By default, both TLSv1.3 and TLSv1.2 are used.
125 to enable only TLSv1.3.
126 .It Ic mime Ar mime-type Ar file-extension
127 Add a mapping for the given
131 Both argument are strings.
132 .It Ic default type Ar string
133 Set the default media type that is used if the media type for a
134 specified extension is not found.
135 If not specified, the
138 .Dq application/octet-stream .
141 Every virtual host is defined by a
145 .It Ic server Ar hostname Brq ...
148 Followed by a block of options that is enclosed in curly brackets:
151 Path to the certificate to use for this server.
154 should contain a PEM encoded certificate.
155 This option is mandatory.
157 Specify the private key to use for this server.
160 should contain a PEM encoded private key.
161 This option is mandatory.
162 .It Ic root Pa directory
163 Specify the root directory for this server.
164 This option is mandatory.
166 Enable the execution of CGI scripts if
168 is a prefix of the user request string.
169 An empty path "" will effectively enable the execution of any file
170 with the executable bit set inside the root directory.
173 When CGI scripts are enabled for a directory, a request for an
174 executable file will execute it and fed its output to the client.
176 The CGI scripts will inherit the environment from
178 with these additional variables set:
180 .It Ev SERVER_SOFTWARE
185 The (public) path to the script.
186 .It Ev SCRIPT_EXECUTABLE
187 The full path to the executable.
189 The user request (without the query parameters.)
190 .It Ev REQUEST_RELATIVE
191 The request relative to the script.
193 The query parameters.
195 The remote IP address.
197 The remote IP address.
199 The root directory being served, the one provided with the
203 or the root directory of the virtual host.
205 The string "Certificate" if the client used a certificate, otherwise unset.
207 The subject of the client certificate if provided, otherwise unset.
208 .It Ev TLS_CLIENT_ISSUER
209 The is the issuer of the client certificate if provided, otherwise unset.
210 .It Ev TLS_CLIENT_HASH
211 The hash of the client certificate if provided, otherwise unset.
212 The format is "ALGO:HASH".
215 Let's say you have a script in
217 and the user request is
218 .Pa /cgi-bin/script/foo/bar?quux .
223 .Ev SCRIPT_EXECUTABLE
225 .Pa $DOCUMENT_ROOT/cgi-bin/script ,
228 .Pa cgi-bin/script/foo/bar ,
237 To quickly getting started
238 .Bd -literal -offset indent
239 $ # generate a cert and a key
240 $ openssl req -x509 -newkey rsa:4096 -keyout key.pem \\
241 -out cert.pem -days 365 -nodes
243 $ cat <<EOF > docs/index.gmi
247 $ gmid -c cert.pem -k key.pem -d docs
250 Now you can visit gemini://localhost/ with your preferred gemini
253 To add some CGI scripts, assuming a setup similar to the previous
255 .Bd -literal -offset indent
257 $ cat <<EOF > docs/cgi-bin/hello-world
259 printf "20 text/plain\\r\\n"
265 Note that the argument to the
271 since it's relative to the document root.
273 The following is an example of a possible configuration for a site
274 that enables only TLSv1.3, adds a mime type for the file extension
275 "rtf" and defines two virtual host:
276 .Bd -literal -offset indent
277 ipv6 on # enable ipv6
278 daemon on # enable daemon mode
282 mime "application/rtf" "rtf"
284 server "example.com" {
285 cert "/path/to/cert.pem"
286 key "/path/to/key.pem"
287 root "/var/gemini/example.com"
290 server "it.example.com" {
291 cert "/path/to/cert.pem"
292 key "/path/to/key.pem"
293 root "/var/gemini/it.example.com"
300 .Dq Flexible and Economical
301 UTF-8 decoder written by
307 The root directories of all virtual hosts are opened during the daemon
308 startup; this means that if a root directory gets deleted and then
311 won't be able to serve files inside that directory until a restart.
312 This restriction applies only to the root directories and not their content.
314 a %2F sequence in the path part is indistinguishable from a literal
315 slash: this is not RFC3986-compliant.
317 a %00 sequence either in the path or in the query part is treated as
318 invalid character and thus rejected.
