1 .\" Copyright (c) 2021, 2022 Omar Polo <op@omarpolo.com>
3 .\" Permission to use, copy, modify, and distribute this software for any
4 .\" purpose with or without fee is hereby granted, provided that the above
5 .\" copyright notice and this permission notice appear in all copies.
7 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 .Nd simple and secure Gemini server
24 .Op Fl D Ar macro Ns = Ns Ar value
30 is a simple and minimal gemini server that can serve static files,
31 talk to FastCGI applications and act as a gemini reverse proxy.
32 It can run without a configuration file with a limited set of features
36 rereads the configuration file when it receives
39 The options are as follows:
41 .It Fl D Ar macro Ns = Ns Ar value
47 Overrides the definition of
49 in the config file if present.
52 Do not daemonize and log to stderr.
54 Specifies the configuration file.
58 Print the usage and exit.
60 Check that the configuration is valid, but don't start the server.
61 If specified two or more time, dump the configuration in addition to
64 Write daemon's pid to the given location.
66 will also act as lock: if another process is holding a lock on that
70 .It Fl V , Fl -version
71 Print the version and exit.
76 options increase the verbosity.
79 Messages and requests are logged by
83 facility or printed on
86 Requests are logged with the
89 Each request log entry has the following fields, separated by
94 Client IP address and the source port number, separated by a colon
108 a configuration file and a X.509 certificate must be provided.
109 A self-signed certificate, which are commonly used in the Geminispace,
110 can be generated using for e.g.\&
112 .Bd -literal -offset indent
113 # openssl req \-x509 \-newkey rsa:4096 \-nodes \e
114 \-keyout /etc/ssl/private/example.com.key \e
115 \-out /etc/ssl/example.com.pem \e
116 \-days 365 \-subj "/CN=example.com"
117 # chmod 600 /etc/ssl/example.com.crt
118 # chmod 600 /etc/ssl/private/example.com.key
124 .Bd -literal -offset indent
125 # gmid -c /etc/gmid.conf
132 .Dq Flexible and Economical
133 UTF-8 decoder written by
134 .An Bjoern Hoehrmann .
139 program was written by
140 .An Omar Polo Aq Mt op@omarpolo.com .
144 All the root directories are opened during the daemon startup; if a
145 root directory is deleted and then re-created,
147 won't be able to serve files inside that directory until a restart.
148 This restriction only applies to the root directories and not their
151 a %2F sequence is indistinguishable from a literal slash: this is not
154 a %00 sequence is treated as invalid character and thus rejected.