1 .\" Copyright (c) 2021, 2022, 2023 Omar Polo <op@omarpolo.com>
2 .\"
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.
6 .\"
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.
14 .Dd July 24, 2023
15 .Dt GMID 8
16 .Os
17 .Sh NAME
18 .Nm gmid
19 .Nd simple and secure Gemini server
20 .Sh SYNOPSIS
21 .Nm
22 .Bk -words
23 .Op Fl fhnVv
24 .Op Fl c Ar config
25 .Op Fl D Ar macro Ns = Ns Ar value
26 .Op Fl P Ar pidfile
27 .Ek
28 .Sh DESCRIPTION
29 .Nm
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 .Pp
33 .Nm
34 rereads the configuration file when it receives
35 .Dv SIGHUP
36 and reopens log files when it receives
37 .Dv SIGUSR1 .
38 .Pp
39 The options are as follows:
40 .Bl -tag -width 14m
41 .It Fl c Ar config
42 Specifies the configuration file.
43 The default is
44 .Pa /etc/gmid.conf .
45 .It Fl D Ar macro Ns = Ns Ar value
46 Define
47 .Ar macro
48 to be set to
49 .Ar value
50 on the command line.
51 Overrides the definition of
52 .Ar macro
53 in the config file if present.
54 .It Fl f
55 Stays and logs on the foreground.
56 .It Fl h , Fl -help
57 Print the usage and exit.
58 .It Fl n
59 Check that the configuration is valid, but don't start the server.
60 If specified two or more time, dump the configuration in addition to
61 verify it.
62 .It Fl P Ar pidfile
63 Write daemon's pid to the given location.
64 .Ar pidfile
65 will also act as lock: if another process is holding a lock on that
66 file,
67 .Nm
68 will refuse to start.
69 .It Fl V , Fl -version
70 Print the version and exit.
71 .It Fl v
72 Verbose mode.
73 .El
74 .Sh LOGGING
75 Messages and requests are logged by
76 .Xr syslog 3
77 using the
78 .Dv DAEMON
79 facility or printed on
80 .Em stderr .
81 .Pp
82 Requests are logged with the
83 .Dv NOTICE
84 severity.
85 Each request log entry has the following fields, separated by
86 whitespace:
87 .Pp
88 .Bl -bullet -compact
89 .It
90 Client IP address and the source port number, separated by a colon
91 .It
92 .Sy GET
93 keyword
94 .It
95 Request URL
96 .It
97 Response status
98 .It
99 Response meta
100 .El
101 .Sh EXAMPLES
102 To run
103 .Nm
104 a configuration file and a X.509 certificate must be provided.
105 A self-signed certificate, which are commonly used in the Geminispace,
106 can be generated using for e.g.\&
107 .Xr openssl 1 :
108 .Bd -literal -offset indent
109 # openssl req \-x509 \-newkey rsa:4096 \-nodes \e
110 	\-keyout /etc/ssl/private/example.com.key \e
111 	\-out /etc/ssl/example.com.pem \e
112 	\-days 365 \-subj "/CN=example.com"
113 # chmod 600 /etc/ssl/example.com.crt
114 # chmod 600 /etc/ssl/private/example.com.key
115 .Ed
116 .Pp
117 Then
118 .Nm
119 can be started with
120 .Bd -literal -offset indent
121 # gmid -c /etc/gmid.conf
122 .Ed
123 .Sh SEE ALSO
124 .Xr gmid.conf 5
125 .Sh ACKNOWLEDGEMENTS
126 .Nm
127 uses the
128 .Dq Flexible and Economical
129 UTF-8 decoder written by
130 .An Bjoern Hoehrmann .
131 .Sh AUTHORS
132 .An -nosplit
133 The
134 .Nm
135 program was written by
136 .An Omar Polo Aq Mt op@omarpolo.com .
137 .Sh CAVEATS
138 .Bl -bullet
139 .It
140 All the root directories are opened during the daemon configuration;
141 if a root directory is deleted and then re-created,
142 .Nm
143 won't be able to serve files inside that directory until a reload.
144 This restriction only applies to the root directories and not their
145 content.
146 .It
147 a %2F sequence is indistinguishable from a literal slash: this is not
148 RFC3986-compliant.
149 .It
150 a %00 sequence is treated as invalid character and thus rejected.
151 .El