1 3e4749f7 2020-10-02 op 
 2 3e4749f7 2020-10-02 op # NAME
 3 3e4749f7 2020-10-02 op 
 4 fab952e1 2020-10-03 op **gmid** - dead simple zero configuration gemini server
 5 3e4749f7 2020-10-02 op 
 6 3e4749f7 2020-10-02 op # SYNOPSIS
 7 3e4749f7 2020-10-02 op 
 8 3e4749f7 2020-10-02 op **gmid**
 9 3e4749f7 2020-10-02 op \[**-h**]
10 3e4749f7 2020-10-02 op \[**-c** *cert.pem*]
11 3e4749f7 2020-10-02 op \[**-d** *docs*]
12 3e4749f7 2020-10-02 op \[**-k** *key.pem*]
13 3e4749f7 2020-10-02 op 
14 3e4749f7 2020-10-02 op # DESCRIPTION
15 3e4749f7 2020-10-02 op 
16 3e4749f7 2020-10-02 op **gmid**
17 3e4749f7 2020-10-02 op is a very simple and minimal gemini server.
18 3e4749f7 2020-10-02 op It only supports serving static content, and strive to be as simple as
19 3e4749f7 2020-10-02 op possible.
20 3e4749f7 2020-10-02 op 
21 3e4749f7 2020-10-02 op **gmid**
22 3e4749f7 2020-10-02 op will strip any sequence of
23 3e4749f7 2020-10-02 op *../*
24 3e4749f7 2020-10-02 op or trailing
25 3e4749f7 2020-10-02 op *..*
26 3e4749f7 2020-10-02 op in the requests made by clients, so it's impossible to serve content
27 3e4749f7 2020-10-02 op outside the
28 3e4749f7 2020-10-02 op *docs*
29 fab952e1 2020-10-03 op directory by mistake, and will also refuse to follow symlink.
30 6980aad6 2020-10-02 op Furthermore, on
31 6980aad6 2020-10-02 op OpenBSD,
32 6980aad6 2020-10-02 op pledge(2)
33 3e4749f7 2020-10-02 op and
34 6980aad6 2020-10-02 op unveil(2)
35 3e4749f7 2020-10-02 op are used to ensure that
36 3e4749f7 2020-10-02 op **gmid**
37 3e4749f7 2020-10-02 op dosen't do anything else than read files from the given directory and
38 3e4749f7 2020-10-02 op accept network connections.
39 3e4749f7 2020-10-02 op 
40 3e4749f7 2020-10-02 op It should be noted that
41 3e4749f7 2020-10-02 op **gmid**
42 3e4749f7 2020-10-02 op is very simple in its implementation, and so it may not be appropriate
43 3e4749f7 2020-10-02 op for serving site with lots of users.
44 3e4749f7 2020-10-02 op After all, the code is single threaded and use a single process.
45 3e4749f7 2020-10-02 op 
46 fab952e1 2020-10-03 op If a user request path is a directory,
47 fab952e1 2020-10-03 op **gmid**
48 fab952e1 2020-10-03 op will try to serve a
49 fab952e1 2020-10-03 op *index.gmi*
50 fab952e1 2020-10-03 op file inside that directory.
51 fab952e1 2020-10-03 op If not found, it will return an error 51 (not found) to the user.
52 fab952e1 2020-10-03 op 
53 3e4749f7 2020-10-02 op The options are as follows:
54 3e4749f7 2020-10-02 op 
55 3e4749f7 2020-10-02 op **-c** *cert.pem*
56 3e4749f7 2020-10-02 op 
57 3e4749f7 2020-10-02 op > The certificate to use, by default is
58 fab952e1 2020-10-03 op > *cert.pem*.
59 3e4749f7 2020-10-02 op 
60 3e4749f7 2020-10-02 op **-d** *docs*
61 3e4749f7 2020-10-02 op 
62 3e4749f7 2020-10-02 op > The root directory to serve.
63 3e4749f7 2020-10-02 op > **gmid**
64 3e4749f7 2020-10-02 op > won't serve any file that is outside that directory.
65 3e4749f7 2020-10-02 op 
66 3e4749f7 2020-10-02 op **-h**
67 3e4749f7 2020-10-02 op 
68 fab952e1 2020-10-03 op > Print the usage and exit.
69 3e4749f7 2020-10-02 op 
70 3e4749f7 2020-10-02 op **-k** *key.pem*
71 3e4749f7 2020-10-02 op 
72 3e4749f7 2020-10-02 op > The key for the certificate, by default is
73 fab952e1 2020-10-03 op > *key.pem*.
74 3e4749f7 2020-10-02 op 
75 3e4749f7 2020-10-02 op # EXAMPLES
76 3e4749f7 2020-10-02 op 
77 3e4749f7 2020-10-02 op To quickly getting started
78 3e4749f7 2020-10-02 op 
79 3e4749f7 2020-10-02 op 	$ # generate a cert and a key
80 3e4749f7 2020-10-02 op 	$ openssl req -x509 -newkey rsa:4096 -keyout key.pem \
81 3e4749f7 2020-10-02 op 	        -out cert.pem -days 365 -nodes
82 3e4749f7 2020-10-02 op 	$ mkdir docs
83 3e4749f7 2020-10-02 op 	$ cat <<EOF > docs/index.gmi
84 3e4749f7 2020-10-02 op 	# Hello world
85 3e4749f7 2020-10-02 op 	test paragraph...
86 3e4749f7 2020-10-02 op 	EOF
87 3e4749f7 2020-10-02 op 	$ gmid -c cert.pem -k key.pem -d docs
88 3e4749f7 2020-10-02 op 
89 6980aad6 2020-10-02 op now you can visit gemini://localhost/ with your preferred gemini client.
90 3e4749f7 2020-10-02 op 
91 3e4749f7 2020-10-02 op # CAVEATS
92 3e4749f7 2020-10-02 op 
93 fab952e1 2020-10-03 op *	it doesn't support virtual hosts: the host part of the request URL is
94 3e4749f7 2020-10-02 op 	completely ignored.
95 3e4749f7 2020-10-02 op 
96 3e4749f7 2020-10-02 op *	it doesn't fork in the background or anything like that.
97 3e4749f7 2020-10-02 op