4 fab952e1 2020-10-03 op **gmid** - dead simple zero configuration gemini server
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 92e66347 2020-11-06 op \[**-l** *logfile*]
14 721e2325 2020-11-18 op \[**-p** *port*]
15 92e66347 2020-11-06 op \[**-x** *cgi-bin*]
20 92e66347 2020-11-06 op is a very simple and minimal gemini server that can serve static files
21 92e66347 2020-11-06 op and execute CGI scripts.
24 3e4749f7 2020-10-02 op will strip any sequence of
28 a5d310bc 2020-11-10 op in the requests made by clients and will refuse to follow symlinks.
29 6980aad6 2020-10-02 op Furthermore, on
34 3e4749f7 2020-10-02 op are used to ensure that
36 92e66347 2020-11-06 op dosen't do anything else than read files from the given directory,
37 92e66347 2020-11-06 op accept network connections and, optionally, execute CGI scripts.
39 3e4749f7 2020-10-02 op It should be noted that
41 3e4749f7 2020-10-02 op is very simple in its implementation, and so it may not be appropriate
42 92e66347 2020-11-06 op for serving sites with lots of users.
43 92e66347 2020-11-06 op After all, the code is single threaded and use a single process,
44 92e66347 2020-11-06 op although it can handle multiple requests concurrently.
46 fab952e1 2020-10-03 op If a user request path is a directory,
48 fab952e1 2020-10-03 op will try to serve a
50 fab952e1 2020-10-03 op file inside that directory.
52 3e4749f7 2020-10-02 op The options are as follows:
54 3e4749f7 2020-10-02 op **-c** *cert.pem*
56 3e4749f7 2020-10-02 op > The certificate to use, by default is
61 3e4749f7 2020-10-02 op > The root directory to serve.
63 a5d310bc 2020-11-10 op > won't serve any file that is outside that directory.
64 a5d310bc 2020-11-10 op > By default is
69 fab952e1 2020-10-03 op > Print the usage and exit.
71 3e4749f7 2020-10-02 op **-k** *key.pem*
73 3e4749f7 2020-10-02 op > The key for the certificate, by default is
76 92e66347 2020-11-06 op **-l** *logfile*
78 2c3a40fa 2020-11-06 op > log to the given file instead of the standard error.
82 721e2325 2020-11-18 op > The port to bind to, by default 1965.
86 0ed56567 2020-11-06 op > Enable execution of CGI scripts inside the given directory (relative
87 0ed56567 2020-11-06 op > to the document root.) Cannot be provided more than once.
91 0ed56567 2020-11-06 op When CGI scripts are enabled for a directory, a request for an
92 0ed56567 2020-11-06 op executable file will execute it and fed its output to the client.
94 92e66347 2020-11-06 op The CGI scripts will inherit the environment from
96 92e66347 2020-11-06 op with these additional variables set:
98 92e66347 2020-11-06 op `SERVER_SOFTWARE`
102 92e66347 2020-11-06 op `SERVER_PORT`
106 a5d310bc 2020-11-10 op `SCRIPT_NAME`
108 a5d310bc 2020-11-10 op > The (public) path to the script.
110 a5d310bc 2020-11-10 op `SCRIPT_EXECUTABLE`
112 a5d310bc 2020-11-10 op > The full path to the executable.
114 a5d310bc 2020-11-10 op `REQUEST_URI`
116 a5d310bc 2020-11-10 op > The user request (without the query parameters.)
118 a5d310bc 2020-11-10 op `REQUEST_RELATIVE`
120 a5d310bc 2020-11-10 op > The request relative to the script.
122 92e66347 2020-11-06 op `QUERY_STRING`
124 a5d310bc 2020-11-10 op > The query parameters.
126 a5d310bc 2020-11-10 op `REMOTE_HOST`
128 a5d310bc 2020-11-10 op > The remote IP address.
130 a5d310bc 2020-11-10 op `DOCUMENT_ROOT`
132 a5d310bc 2020-11-10 op > The root directory being served, the one provided with the
134 a5d310bc 2020-11-10 op > parameter to
137 a5d310bc 2020-11-10 op Let's say you have a script in
138 a5d310bc 2020-11-10 op */cgi-bin/script*
139 a5d310bc 2020-11-10 op and the user request is
140 a5d310bc 2020-11-10 op */cgi-bin/script/foo/bar?quux*.
142 a5d310bc 2020-11-10 op `SCRIPT_NAME`
144 a5d310bc 2020-11-10 op */cgi-bin/script*,
145 a5d310bc 2020-11-10 op `SCRIPT_EXECUTABLE`
147 a5d310bc 2020-11-10 op *$DOCUMENT\_ROOT/cgi-bin/script*,
148 a5d310bc 2020-11-10 op `REQUEST_URI`
150 a5d310bc 2020-11-10 op */cgi-bin/script/foo/bar*,
151 a5d310bc 2020-11-10 op `REQUEST_RELATIVE`
153 a5d310bc 2020-11-10 op *foo/bar and*
154 a5d310bc 2020-11-10 op `QUERY_STRING`
160 3e4749f7 2020-10-02 op To quickly getting started
162 3e4749f7 2020-10-02 op $ # generate a cert and a key
163 3e4749f7 2020-10-02 op $ openssl req -x509 -newkey rsa:4096 -keyout key.pem \
164 3e4749f7 2020-10-02 op -out cert.pem -days 365 -nodes
166 3e4749f7 2020-10-02 op $ cat <<EOF > docs/index.gmi
167 3e4749f7 2020-10-02 op # Hello world
168 3e4749f7 2020-10-02 op test paragraph...
170 3e4749f7 2020-10-02 op $ gmid -c cert.pem -k key.pem -d docs
172 92e66347 2020-11-06 op Now you can visit gemini://localhost/ with your preferred gemini
175 0ed56567 2020-11-06 op To add some CGI scripts, assuming a setup similar to the previous
176 92e66347 2020-11-06 op example, you can
178 0ed56567 2020-11-06 op $ mkdir docs/cgi-bin
179 0ed56567 2020-11-06 op $ cat <<EOF > docs/cgi-bin/hello-world
181 92e66347 2020-11-06 op printf "20 text/plain\r\n"
182 0ed56567 2020-11-06 op echo "hello world!"
184 92e66347 2020-11-06 op $ gmid -x cgi-bin
186 92e66347 2020-11-06 op Note that the argument to the
191 0ed56567 2020-11-06 op *docs/cgi-bin*,
192 a5d310bc 2020-11-10 op since it's relative to the document root.
196 fab952e1 2020-10-03 op * it doesn't support virtual hosts: the host part of the request URL is
197 3e4749f7 2020-10-02 op completely ignored.
199 3e4749f7 2020-10-02 op * it doesn't fork in the background or anything like that.
