1 9b15e4c6 2022-09-08 op .\" Copyright (c) 2021, 2022 Omar Polo <op@omarpolo.com>
3 9b15e4c6 2022-09-08 op .\" Permission to use, copy, modify, and distribute this software for any
4 9b15e4c6 2022-09-08 op .\" purpose with or without fee is hereby granted, provided that the above
5 9b15e4c6 2022-09-08 op .\" copyright notice and this permission notice appear in all copies.
7 9b15e4c6 2022-09-08 op .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 9b15e4c6 2022-09-08 op .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 9b15e4c6 2022-09-08 op .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 9b15e4c6 2022-09-08 op .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 9b15e4c6 2022-09-08 op .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 9b15e4c6 2022-09-08 op .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 9b15e4c6 2022-09-08 op .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14 9b15e4c6 2022-09-08 op .Dd September 8, 2022
19 9b15e4c6 2022-09-08 op .Nd simple and secure Gemini server
24 9b15e4c6 2022-09-08 op .Op Fl c Ar config
25 9b15e4c6 2022-09-08 op .Op Fl D Ar macro Ns = Ns Ar value
26 9b15e4c6 2022-09-08 op .Op Fl P Ar pidfile
28 9b15e4c6 2022-09-08 op .Sh DESCRIPTION
30 9b15e4c6 2022-09-08 op is a simple and minimal gemini server that can serve static files,
31 9b15e4c6 2022-09-08 op talk to FastCGI applications and act as a gemini reverse proxy.
32 9b15e4c6 2022-09-08 op It can run without a configuration file with a limited set of features
36 9b15e4c6 2022-09-08 op rereads the configuration file when it receives
39 9b15e4c6 2022-09-08 op The options are as follows:
40 9b15e4c6 2022-09-08 op .Bl -tag -width 14m
41 9b15e4c6 2022-09-08 op .It Fl c Ar config
42 9b15e4c6 2022-09-08 op Specifies the configuration file.
43 9b15e4c6 2022-09-08 op The default is
44 9b15e4c6 2022-09-08 op .Pa /etc/gmid.conf .
45 9b15e4c6 2022-09-08 op .It Fl D Ar macro Ns = Ns Ar value
50 9b15e4c6 2022-09-08 op on the command line.
51 9b15e4c6 2022-09-08 op Overrides the definition of
53 9b15e4c6 2022-09-08 op in the config file if present.
55 9b15e4c6 2022-09-08 op Stays and logs on the foreground.
56 9b15e4c6 2022-09-08 op .It Fl h , Fl -help
57 9b15e4c6 2022-09-08 op Print the usage and exit.
59 9b15e4c6 2022-09-08 op Check that the configuration is valid, but don't start the server.
60 9b15e4c6 2022-09-08 op If specified two or more time, dump the configuration in addition to
62 9b15e4c6 2022-09-08 op .It Fl P Ar pidfile
63 9b15e4c6 2022-09-08 op Write daemon's pid to the given location.
65 9b15e4c6 2022-09-08 op will also act as lock: if another process is holding a lock on that
68 9b15e4c6 2022-09-08 op will refuse to start.
69 9b15e4c6 2022-09-08 op .It Fl V , Fl -version
70 9b15e4c6 2022-09-08 op Print the version and exit.
75 9b15e4c6 2022-09-08 op options increase the verbosity.
78 9b15e4c6 2022-09-08 op Messages and requests are logged by
82 9b15e4c6 2022-09-08 op facility or printed on
85 9b15e4c6 2022-09-08 op Requests are logged with the
88 9b15e4c6 2022-09-08 op Each request log entry has the following fields, separated by
91 9b15e4c6 2022-09-08 op .Bl -bullet -compact
93 9b15e4c6 2022-09-08 op Client IP address and the source port number, separated by a colon
100 9b15e4c6 2022-09-08 op Response status
102 9b15e4c6 2022-09-08 op Response meta
107 9b15e4c6 2022-09-08 op a configuration file and a X.509 certificate must be provided.
108 9b15e4c6 2022-09-08 op A self-signed certificate, which are commonly used in the Geminispace,
109 9b15e4c6 2022-09-08 op can be generated using for e.g.\&
110 9b15e4c6 2022-09-08 op .Xr openssl 1 :
111 9b15e4c6 2022-09-08 op .Bd -literal -offset indent
112 9b15e4c6 2022-09-08 op # openssl req \-x509 \-newkey rsa:4096 \-nodes \e
113 9b15e4c6 2022-09-08 op \-keyout /etc/ssl/private/example.com.key \e
114 9b15e4c6 2022-09-08 op \-out /etc/ssl/example.com.pem \e
115 9b15e4c6 2022-09-08 op \-days 365 \-subj "/CN=example.com"
116 9b15e4c6 2022-09-08 op # chmod 600 /etc/ssl/example.com.crt
117 9b15e4c6 2022-09-08 op # chmod 600 /etc/ssl/private/example.com.key
122 9b15e4c6 2022-09-08 op can be started with
123 9b15e4c6 2022-09-08 op .Bd -literal -offset indent
124 9b15e4c6 2022-09-08 op # gmid -c /etc/gmid.conf
127 9b15e4c6 2022-09-08 op .Xr gmid.conf 5
128 9b15e4c6 2022-09-08 op .Sh ACKNOWLEDGEMENTS
131 9b15e4c6 2022-09-08 op .Dq Flexible and Economical
132 9b15e4c6 2022-09-08 op UTF-8 decoder written by
133 9b15e4c6 2022-09-08 op .An Bjoern Hoehrmann .
138 9b15e4c6 2022-09-08 op program was written by
139 9b15e4c6 2022-09-08 op .An Omar Polo Aq Mt op@omarpolo.com .
143 9b15e4c6 2022-09-08 op All the root directories are opened during the daemon startup; if a
144 9b15e4c6 2022-09-08 op root directory is deleted and then re-created,
146 9b15e4c6 2022-09-08 op won't be able to serve files inside that directory until a restart.
147 9b15e4c6 2022-09-08 op This restriction only applies to the root directories and not their
150 9b15e4c6 2022-09-08 op a %2F sequence is indistinguishable from a literal slash: this is not
151 9b15e4c6 2022-09-08 op RFC3986-compliant.
153 9b15e4c6 2022-09-08 op a %00 sequence is treated as invalid character and thus rejected.
