Blame


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