From ff78ea5049f2eb869393b4901eff3939a684fe8e Mon Sep 17 00:00:00 2001 From: Solene Rapenne Date: Fri, 5 Feb 2021 21:28:41 +0100 Subject: [PATCH] Documentation rewording --- README.md | 10 ++++++---- vger.8 | 3 ++- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 16e4137..b4fcf69 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # A simplistic and secure Gemini server -**Vger** is a gemini server supporting chroot, virtualhosts, default -language choice, redirections and MIME types detection. +**Vger** is a gemini server supporting chroot, virtualhosts, CGI, +default language choice, redirections and MIME types detection. **Vger** design is relying on inetd and a daemon to take care of TLS. The idea is to delegate TLS and network to daemons which @@ -22,7 +22,9 @@ The average setup should look like: **Vger** is perfectly secure if run on **OpenBSD**, using `unveil()` the filesystem access is restricted to one directory (default to `/var/gemini/`) and with `pledge()` only systems calls related to -reading files and reading input/output are allowed. +reading files and reading input/output are allowed. More explanations +about Vger security can be found +[on this link](https://dataswamp.org/~solene/2021-01-14-vger-security.html). For all supported OS, it's possible to run **Vger** in a chroot and drop privileges to a dedicated user. @@ -57,7 +59,7 @@ without a `-d` parameter. - `-u username`: enable chroot to the data directory and drop privileges to `username`. - `-m MIME` : use MIME as default instead of "application/octet-stream". - `-i` : Enable auto index if no "index.gmi" file is found in a directory. -- `-c CGI_PATH` : Exec CGI_PATH instead of serving it. +- `-c CGI_PATH` : files in CGI_PATH are executed and their output is returned to the client. # How to configure Vger using relayd and inetd diff --git a/vger.8 b/vger.8 index bcc772a..2854f68 100644 --- a/vger.8 +++ b/vger.8 @@ -44,7 +44,8 @@ will read the file /var/gemini/hostname.example/file.gmi .It Op Fl c Enable CGI support. .Ar cgi_path -will be executed as a cgi script. This path is relative to the directory set with +will be executed as a cgi script instead of returning its content. +This path is relative to the directory set with .Fl d flag. If using virtualhost, you must insert the virtualhost directory in the cgi path. As example, for a request gemini://hostname.example/cgi-bin/hello.cgi, one must set: