1 .\" Copyright (c) 2020 Omar Polo <op@omarpolo.com>
2 .\"
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.
6 .\"
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$
15 .Dt GMIND 1
16 .Os
17 .Sh NAME
18 .Nm gmid
19 .Nd dead simple gemini server
20 .Sh SYNOPSIS
21 .Nm
22 .Bk -words
23 .Op Fl h
24 .Op Fl c Ar cert.pem
25 .Op Fl d Ar docs
26 .Op Fl k Ar key.pem
27 .Ek
28 .Sh DESCRIPTION
29 .Nm
30 is a very simple and minimal gemini server.
31 It only supports serving static content, and strive to be as simple as
32 possible.
33 .Pp
34 .Nm
35 will strip any sequence of
36 .Pa ../
37 or trailing
38 .Pa ..
39 in the requests made by clients, so it's impossible to serve content
40 outside the
41 .Pa docs
42 directory by mistake.
43 Furthermore, on OpenBSD,
44 .Xr pledge 3
45 and
46 .Xr unveil 3
47 are used to ensure that
48 .Nm
49 dosen't do anything else than read files from the given directory and
50 accept network connections.
51 .Pp
52 It should be noted that
53 .Nm
54 is very simple in its implementation, and so it may not be appropriate
55 for serving site with lots of users.
56 After all, the code is single threaded and use a single process.
57 .Pp
58 The options are as follows:
59 .Bl -tag -width 12m
60 .It Fl c Ar cert.pem
61 The certificate to use, by default is
62 .Pa cert.pem
63 .It Fl d Ar docs
64 The root directory to serve.
65 .Nm
66 won't serve any file that is outside that directory.
67 .It Fl h
68 Print the usage and exit
69 .It Fl k Ar key.pem
70 The key for the certificate, by default is
71 .Pa key.pem
72 .El
73 .Sh EXAMPLES
74 To quickly getting started
75 .Bd -literal -indent
76 $ # generate a cert and a key
77 $ openssl req -x509 -newkey rsa:4096 -keyout key.pem \\
78         -out cert.pem -days 365 -nodes
79 $ mkdir docs
80 $ cat <<EOF > docs/index.gmi
81 # Hello world
82 test paragraph...
83 EOF
84 $ gmid -c cert.pem -k key.pem -d docs
85 .El
86 .Pp
87 now you can visit gemini://localhost/ with your preferred gemini client.
88 .Sh CAVEATS
89 .Bl -bullet
90 .It
91 it doesn't support virtual host: the host part of the request URL is
92 completely ignored.
93 .It
94 it doesn't fork in the background or anything like that.
95 .El