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*]
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
22 3e4749f7 2020-10-02 op will strip any sequence of
26 3e4749f7 2020-10-02 op in the requests made by clients, so it's impossible to serve content
29 fab952e1 2020-10-03 op directory by mistake, and will also refuse to follow symlink.
30 6980aad6 2020-10-02 op Furthermore, on
35 3e4749f7 2020-10-02 op are used to ensure that
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.
40 3e4749f7 2020-10-02 op It should be noted that
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.
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.
51 fab952e1 2020-10-03 op If not found, it will return an error 51 (not found) to the user.
53 3e4749f7 2020-10-02 op The options are as follows:
55 3e4749f7 2020-10-02 op **-c** *cert.pem*
57 3e4749f7 2020-10-02 op > The certificate to use, by default is
62 3e4749f7 2020-10-02 op > The root directory to serve.
64 3e4749f7 2020-10-02 op > won't serve any file that is outside that directory.
68 fab952e1 2020-10-03 op > Print the usage and exit.
70 3e4749f7 2020-10-02 op **-k** *key.pem*
72 3e4749f7 2020-10-02 op > The key for the certificate, by default is
77 3e4749f7 2020-10-02 op To quickly getting started
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
83 3e4749f7 2020-10-02 op $ cat <<EOF > docs/index.gmi
85 3e4749f7 2020-10-02 op test paragraph...
87 3e4749f7 2020-10-02 op $ gmid -c cert.pem -k key.pem -d docs
89 6980aad6 2020-10-02 op now you can visit gemini://localhost/ with your preferred gemini client.
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.
96 3e4749f7 2020-10-02 op * it doesn't fork in the background or anything like that.