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 zero configuration 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 .Op Fl l Ar access.log
28 .Ek
29 .Sh DESCRIPTION
30 .Nm
31 is a very simple and minimal gemini server.
32 It only supports serving static content, and strive to be as simple as
33 possible.
34 .Pp
35 .Nm
36 will strip any sequence of
37 .Pa ../
38 or trailing
39 .Pa ..
40 in the requests made by clients, so it's impossible to serve content
41 outside the
42 .Pa docs
43 directory by mistake, and will also refuse to follow symlink.
44 Furthermore, on
45 .Ox ,
46 .Xr pledge 2
47 and
48 .Xr unveil 2
49 are used to ensure that
50 .Nm
51 dosen't do anything else than read files from the given directory and
52 accept network connections.
53 .Pp
54 It should be noted that
55 .Nm
56 is very simple in its implementation, and so it may not be appropriate
57 for serving site with lots of users.
58 After all, the code is single threaded and use a single process
59 (multiple requests are handled concurrently thanks to async I/O.)
60 .Pp
61 If a user request path is a directory,
62 .Nm
63 will try to serve a
64 .Pa index.gmi
65 file inside that directory.
66 If not found, it will return an error 51 (not found) to the user.
67 .Pp
68 The options are as follows:
69 .Bl -tag -width 12m
70 .It Fl c Ar cert.pem
71 The certificate to use, by default is
72 .Pa cert.pem .
73 .It Fl d Ar docs
74 The root directory to serve.
75 .Nm
76 won't serve any file that is outside that directory.
77 .It Fl h
78 Print the usage and exit.
79 .It Fl k Ar key.pem
80 The key for the certificate, by default is
81 .Pa key.pem .
82 .It Fl l Ar access.log
83 log to the given file instead of the standard error.
84 .El
85 .Sh EXAMPLES
86 To quickly getting started
87 .Bd -literal -offset indent
88 $ # generate a cert and a key
89 $ openssl req -x509 -newkey rsa:4096 -keyout key.pem \\
90         -out cert.pem -days 365 -nodes
91 $ mkdir docs
92 $ cat <<EOF > docs/index.gmi
93 # Hello world
94 test paragraph...
95 EOF
96 $ gmid -c cert.pem -k key.pem -d docs
97 .Ed
98 .Pp
99 now you can visit gemini://localhost/ with your preferred gemini client.
100 .Sh CAVEATS
101 .Bl -bullet
102 .It
103 it doesn't support virtual hosts: the host part of the request URL is
104 completely ignored.
105 .It
106 it doesn't fork in the background or anything like that.
107 .El