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 92e66347 2020-11-06 op \[**-x** *cgi-bin*]
19 92e66347 2020-11-06 op is a very simple and minimal gemini server that can serve static files
20 92e66347 2020-11-06 op and execute CGI scripts.
23 3e4749f7 2020-10-02 op will strip any sequence of
27 3e4749f7 2020-10-02 op in the requests made by clients, so it's impossible to serve content
30 92e66347 2020-11-06 op directory by mistake, and will also refuse to follow symlinks.
31 6980aad6 2020-10-02 op Furthermore, on
36 3e4749f7 2020-10-02 op are used to ensure that
38 92e66347 2020-11-06 op dosen't do anything else than read files from the given directory,
39 92e66347 2020-11-06 op accept network connections and, optionally, execute CGI scripts.
41 3e4749f7 2020-10-02 op It should be noted that
43 3e4749f7 2020-10-02 op is very simple in its implementation, and so it may not be appropriate
44 92e66347 2020-11-06 op for serving sites with lots of users.
45 92e66347 2020-11-06 op After all, the code is single threaded and use a single process,
46 92e66347 2020-11-06 op although it can handle multiple requests concurrently.
48 fab952e1 2020-10-03 op If a user request path is a directory,
50 fab952e1 2020-10-03 op will try to serve a
52 fab952e1 2020-10-03 op file inside that directory.
53 fab952e1 2020-10-03 op If not found, it will return an error 51 (not found) to the user.
55 3e4749f7 2020-10-02 op The options are as follows:
57 3e4749f7 2020-10-02 op **-c** *cert.pem*
59 3e4749f7 2020-10-02 op > The certificate to use, by default is
64 3e4749f7 2020-10-02 op > The root directory to serve.
66 92e66347 2020-11-06 op > won't serve any file that is outside that directory, by default
71 fab952e1 2020-10-03 op > Print the usage and exit.
73 3e4749f7 2020-10-02 op **-k** *key.pem*
75 3e4749f7 2020-10-02 op > The key for the certificate, by default is
78 92e66347 2020-11-06 op **-l** *logfile*
80 2c3a40fa 2020-11-06 op > log to the given file instead of the standard error.
84 0ed56567 2020-11-06 op > Enable execution of CGI scripts inside the given directory (relative
85 0ed56567 2020-11-06 op > to the document root.) Cannot be provided more than once.
89 0ed56567 2020-11-06 op When CGI scripts are enabled for a directory, a request for an
90 0ed56567 2020-11-06 op executable file will execute it and fed its output to the client.
92 92e66347 2020-11-06 op The CGI scripts will inherit the environment from
94 92e66347 2020-11-06 op with these additional variables set:
96 92e66347 2020-11-06 op `SERVER_SOFTWARE`
100 92e66347 2020-11-06 op `SERVER_PROTOCOL`
104 92e66347 2020-11-06 op `SERVER_PORT`
110 92e66347 2020-11-06 op > the request path
112 92e66347 2020-11-06 op `PATH_TRANSLATED`
114 92e66347 2020-11-06 op > the full path: the concatenation of the document root and the request
117 92e66347 2020-11-06 op `QUERY_STRING`
119 92e66347 2020-11-06 op > the query string if present in the request URL, otherwise it
120 92e66347 2020-11-06 op > won't be set.
122 92e66347 2020-11-06 op `REMOTE_ADDR`
124 92e66347 2020-11-06 op > the IP address of the client in dot notation
128 3e4749f7 2020-10-02 op To quickly getting started
130 3e4749f7 2020-10-02 op $ # generate a cert and a key
131 3e4749f7 2020-10-02 op $ openssl req -x509 -newkey rsa:4096 -keyout key.pem \
132 3e4749f7 2020-10-02 op -out cert.pem -days 365 -nodes
134 3e4749f7 2020-10-02 op $ cat <<EOF > docs/index.gmi
135 3e4749f7 2020-10-02 op # Hello world
136 3e4749f7 2020-10-02 op test paragraph...
138 3e4749f7 2020-10-02 op $ gmid -c cert.pem -k key.pem -d docs
140 92e66347 2020-11-06 op Now you can visit gemini://localhost/ with your preferred gemini
143 0ed56567 2020-11-06 op To add some CGI scripts, assuming a setup similar to the previous
144 92e66347 2020-11-06 op example, you can
146 0ed56567 2020-11-06 op $ mkdir docs/cgi-bin
147 0ed56567 2020-11-06 op $ cat <<EOF > docs/cgi-bin/hello-world
149 92e66347 2020-11-06 op printf "20 text/plain\r\n"
150 0ed56567 2020-11-06 op echo "hello world!"
152 92e66347 2020-11-06 op $ gmid -x cgi-bin
154 92e66347 2020-11-06 op Note that the argument to the
159 0ed56567 2020-11-06 op *docs/cgi-bin*,
160 0ed56567 2020-11-06 op since it’s relative to the document root.
164 fab952e1 2020-10-03 op * it doesn't support virtual hosts: the host part of the request URL is
165 3e4749f7 2020-10-02 op completely ignored.
167 3e4749f7 2020-10-02 op * it doesn't fork in the background or anything like that.
