Add manual page

This commit is contained in:
Solene Rapenne 2020-12-03 21:40:16 +01:00
parent 2cf92e196c
commit aa3b495dbf
2 changed files with 77 additions and 0 deletions

View file

@ -10,6 +10,7 @@ vger: main.c
install: vger
install -o root -g wheel vger ${PREFIX}/bin/
install -o root -g wheel vger.8 ${PREFIX}/man/man8/
test: vger
cd tests && sh

vger.8 Normal file
View file

@ -0,0 +1,76 @@
.Dd $Mdocdate: December 03 2020 $
.Dt VGER 8
.Nm vger
.Nd inetd gemini server
.Nm vger
.Op Fl l Ar lang
.Op Fl v
.Op Fl d Ar path
is a secure gemini server that is meant to be run on
.Xr inetd 8
behind a relay daemon offering TLS capabilities like
.Xr relayd 8 .
.Bl -tag -width Ds
.It Op Fl l Ar lang
Set the default lang in the return code to
.Ar lang
instead of "en".
.It Op Fl v
Enable virtualhost support, the hostname in the query will be considered as a directory name.
As example, for request gemini://fqdn.local/file.gmi
will read the file /var/gemini/fqdn.local/file.gmi
.It Op Fl d Ar path
.Ar path
instead of the default "/var/gemini/" path to look for files.
will use
.Xr unveil 2
on this path in read-only to prevent file access outside this directory.
is meant to be run by
.Xr inetd 8 .
can be used on any port because it won't be public.
/etc/inetd.conf example using a dedicated gemini_user:
.Bd -literal -offset indent
11965 stream tcp nowait gemini_user /usr/local/bin/vger vger
The public port TCP/1965 must be served by a daemon like
.Xr relayd 8
which negociate TLS connections and forward them
to the inetd daemon on the
.Xr relayd.conf 5
configuration example:
.Bd -literal -offset indent
log connection
relay "gemini" {
listen on port 1965 tls
forward to port 11965
.Xr unveil 2 ,
.Xr relayd.conf 5 ,
.Xr inetd 8 ,
.Xr relayd 8
.An See the LICENSE file for the authors .
See the LICENSE file for the terms of redistribution.