2 f224a3fe 2021-08-24 xhr .\" Copyright (c) 2021 Matthias Schmidt
4 f224a3fe 2021-08-24 xhr .\" Permission to use, copy, modify, and distribute this software for any
5 f224a3fe 2021-08-24 xhr .\" purpose with or without fee is hereby granted, provided that the above
6 f224a3fe 2021-08-24 xhr .\" copyright notice and this permission notice appear in all copies.
8 f224a3fe 2021-08-24 xhr .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 f224a3fe 2021-08-24 xhr .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 f224a3fe 2021-08-24 xhr .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 f224a3fe 2021-08-24 xhr .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 f224a3fe 2021-08-24 xhr .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 f224a3fe 2021-08-24 xhr .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 f224a3fe 2021-08-24 xhr .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 f449654c 2021-08-25 xhr .Dd August 25, 2021
22 f224a3fe 2021-08-24 xhr .Nd Simple gemini server
26 f224a3fe 2021-08-24 xhr .Op Fl p Ar port
27 f224a3fe 2021-08-24 xhr .Sh DESCRIPTION
29 f224a3fe 2021-08-24 xhr is a simple daemon serving static files over the gemini protocol.
30 f224a3fe 2021-08-24 xhr It is intended to have as few knobs as possible and has no support for
31 f224a3fe 2021-08-24 xhr a configuration file.
33 f224a3fe 2021-08-24 xhr The options are as follows:
34 f224a3fe 2021-08-24 xhr .Bl -tag -width Ds
36 f224a3fe 2021-08-24 xhr Enable debug log messages.
37 f224a3fe 2021-08-24 xhr Most useful together with
40 f224a3fe 2021-08-24 xhr Do not daemonize.
41 f224a3fe 2021-08-24 xhr If this option is specified,
43 f224a3fe 2021-08-24 xhr will run in the foreground and log to
45 f224a3fe 2021-08-24 xhr .It Fl p Ar port
46 f224a3fe 2021-08-24 xhr Listen on Port
48 f224a3fe 2021-08-24 xhr instead of the default 1965.
50 f224a3fe 2021-08-24 xhr Display the version and exit.
54 f224a3fe 2021-08-24 xhr listens on the any address (:: and 0.0.0.0) for both IPv4 and IPv6.
57 f224a3fe 2021-08-24 xhr has support for virtual hosts by default.
58 f224a3fe 2021-08-24 xhr To serve files for a specific host you have to place them in a sub directory
59 f224a3fe 2021-08-24 xhr named after the domain under
60 f224a3fe 2021-08-24 xhr .Pa /var/twind .
63 f449654c 2021-08-25 xhr starts as root and then drops privileges to a dedicated
65 f449654c 2021-08-25 xhr By default, two sub-processes are started jailing themselves with
68 f449654c 2021-08-25 xhr .Pa /var/twind .
70 f224a3fe 2021-08-24 xhr The following path cannot be changed, i.e. you have to name your
71 f224a3fe 2021-08-24 xhr TLS certificate and key file exactly as shown.
73 f224a3fe 2021-08-24 xhr .Bl -tag -width Ds -compact
74 f224a3fe 2021-08-24 xhr .It Pa /etc/twind/twind.cert.pem
75 f224a3fe 2021-08-24 xhr TLS certificate for
77 f224a3fe 2021-08-24 xhr .It Pa /etc/twind/twind.key.pem
78 f224a3fe 2021-08-24 xhr Private key for the certificate mentioned above.
79 f224a3fe 2021-08-24 xhr .It Pa /var/twind/
80 f224a3fe 2021-08-24 xhr Default location for the gemini (gmi) files.
81 f224a3fe 2021-08-24 xhr Contains one sub directory for each virtual host.
82 f224a3fe 2021-08-24 xhr .It Pa /var/twind/example.com/
83 f224a3fe 2021-08-24 xhr Subdirectory containing gemini files for the
84 f224a3fe 2021-08-24 xhr .Em example.com
86 f449654c 2021-08-25 xhr .It Pa /var/twind/logs/
87 f449654c 2021-08-25 xhr Subdirectory containing access and error logs.
89 f224a3fe 2021-08-24 xhr .Sh EXIT STATUS
91 f224a3fe 2021-08-24 xhr normally exists with 0 or with -1 if an error occurred.
94 f224a3fe 2021-08-24 xhr was written by
95 f224a3fe 2021-08-24 xhr .An Matthias Schmidt Aq Mt xhr@giessen.ccc.de .
