mirror of https://github.com/omar-polo/gmid.git
181 lines
4.4 KiB
Groff
181 lines
4.4 KiB
Groff
.\" Copyright (c) 2020 Omar Polo <op@omarpolo.com>
|
|
.\"
|
|
.\" Permission to use, copy, modify, and distribute this software for any
|
|
.\" purpose with or without fee is hereby granted, provided that the above
|
|
.\" copyright notice and this permission notice appear in all copies.
|
|
.\"
|
|
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
.Dd $Mdocdate: October 2 2020$
|
|
.Dt GMIND 1
|
|
.Os
|
|
.Sh NAME
|
|
.Nm gmid
|
|
.Nd dead simple zero configuration gemini server
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Bk -words
|
|
.Op Fl h
|
|
.Op Fl c Ar cert.pem
|
|
.Op Fl d Ar docs
|
|
.Op Fl k Ar key.pem
|
|
.Op Fl l Ar logfile
|
|
.Op Fl x Ar cgi-bin
|
|
.Ek
|
|
.Sh DESCRIPTION
|
|
.Nm
|
|
is a very simple and minimal gemini server that can serve static files
|
|
and execute CGI scripts.
|
|
.Pp
|
|
.Nm
|
|
will strip any sequence of
|
|
.Pa ../
|
|
or trailing
|
|
.Pa ..
|
|
in the requests made by clients and will refuse to follow symlinks.
|
|
Furthermore, on
|
|
.Ox ,
|
|
.Xr pledge 2
|
|
and
|
|
.Xr unveil 2
|
|
are used to ensure that
|
|
.Nm
|
|
dosen't do anything else than read files from the given directory,
|
|
accept network connections and, optionally, execute CGI scripts.
|
|
.Pp
|
|
It should be noted that
|
|
.Nm
|
|
is very simple in its implementation, and so it may not be appropriate
|
|
for serving sites with lots of users.
|
|
After all, the code is single threaded and use a single process,
|
|
although it can handle multiple requests concurrently.
|
|
.Pp
|
|
If a user request path is a directory,
|
|
.Nm
|
|
will try to serve a
|
|
.Pa index.gmi
|
|
file inside that directory.
|
|
.Pp
|
|
The options are as follows:
|
|
.Bl -tag -width 12m
|
|
.It Fl c Ar cert.pem
|
|
The certificate to use, by default is
|
|
.Pa cert.pem .
|
|
.It Fl d Ar docs
|
|
The root directory to serve.
|
|
.Nm
|
|
won't serve any file that is outside that directory.
|
|
By default is
|
|
.Pa docs .
|
|
.It Fl h
|
|
Print the usage and exit.
|
|
.It Fl k Ar key.pem
|
|
The key for the certificate, by default is
|
|
.Pa key.pem .
|
|
.It Fl l Ar logfile
|
|
log to the given file instead of the standard error.
|
|
.It Fl x Ar dir
|
|
Enable execution of CGI scripts inside the given directory (relative
|
|
to the document root.) Cannot be provided more than once.
|
|
.El
|
|
.Sh CGI
|
|
When CGI scripts are enabled for a directory, a request for an
|
|
executable file will execute it and fed its output to the client.
|
|
.Pp
|
|
The CGI scripts will inherit the environment from
|
|
.Nm
|
|
with these additional variables set:
|
|
.Bl -tag -width 18m
|
|
.It Ev SERVER_SOFTWARE
|
|
"gmid"
|
|
.It Ev SERVER_PORT
|
|
"1965"
|
|
.It Ev SCRIPT_NAME
|
|
The (public) path to the script.
|
|
.It Ev SCRIPT_EXECUTABLE
|
|
The full path to the executable.
|
|
.It Ev REQUEST_URI
|
|
The user request (without the query parameters.)
|
|
.It Ev REQUEST_RELATIVE
|
|
The request relative to the script.
|
|
.It Ev QUERY_STRING
|
|
The query parameters.
|
|
.It Ev REMOTE_HOST
|
|
The remote IP address.
|
|
.It Ev DOCUMENT_ROOT
|
|
The root directory being served, the one provided with the
|
|
.Ar d
|
|
parameter to
|
|
.Nm
|
|
.El
|
|
.Pp
|
|
Let's say you have a script in
|
|
.Pa /cgi-bin/script
|
|
and the user request is
|
|
.Pa /cgi-bin/script/foo/bar?quux .
|
|
Then
|
|
.Ev SCRIPT_NAME
|
|
will be
|
|
.Pa /cgi-bin/script ,
|
|
.Ev SCRIPT_EXECUTABLE
|
|
will be
|
|
.Pa $DOCUMENT_ROOT/cgi-bin/script ,
|
|
.Ev REQUEST_URI
|
|
will be
|
|
.Pa /cgi-bin/script/foo/bar ,
|
|
.Ev REQUEST_RELATIVE
|
|
will be
|
|
.Pa foo/bar and
|
|
.Ev QUERY_STRING
|
|
will be
|
|
.Ar quux .
|
|
.Sh EXAMPLES
|
|
To quickly getting started
|
|
.Bd -literal -offset indent
|
|
$ # generate a cert and a key
|
|
$ openssl req -x509 -newkey rsa:4096 -keyout key.pem \\
|
|
-out cert.pem -days 365 -nodes
|
|
$ mkdir docs
|
|
$ cat <<EOF > docs/index.gmi
|
|
# Hello world
|
|
test paragraph...
|
|
EOF
|
|
$ gmid -c cert.pem -k key.pem -d docs
|
|
.Ed
|
|
.Pp
|
|
Now you can visit gemini://localhost/ with your preferred gemini
|
|
client.
|
|
.Pp
|
|
To add some CGI scripts, assuming a setup similar to the previous
|
|
example, you can
|
|
.Bd -literal -offset indent
|
|
$ mkdir docs/cgi-bin
|
|
$ cat <<EOF > docs/cgi-bin/hello-world
|
|
#!/bin/sh
|
|
printf "20 text/plain\\r\\n"
|
|
echo "hello world!"
|
|
EOF
|
|
$ gmid -x cgi-bin
|
|
.Ed
|
|
.Pp
|
|
Note that the argument to the
|
|
.Fl x
|
|
option is
|
|
.Pa cgi-bin
|
|
and not
|
|
.Pa docs/cgi-bin ,
|
|
since it's relative to the document root.
|
|
.Sh CAVEATS
|
|
.Bl -bullet
|
|
.It
|
|
it doesn't support virtual hosts: the host part of the request URL is
|
|
completely ignored.
|
|
.It
|
|
it doesn't fork in the background or anything like that.
|
|
.El
|