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