From 8c5e344707866d9c6ee8190f2c648d69cd4cbd3c Mon Sep 17 00:00:00 2001 From: Solene Rapenne Date: Sat, 5 Dec 2020 20:12:13 +0100 Subject: [PATCH] Enhance README with install instructions and tell about chroot for everyone --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7c4fc6f..084b060 100644 --- a/README.md +++ b/README.md @@ -24,11 +24,17 @@ 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. +For all supported OS, it's possible to run **Vger** in a chroot +and drop privileges to a dedicated user. -# Get the sources + +# Install ``` git clone https://tildegit.org/solene/vger.git +cd vger +make +sudo make install ``` # Running tests @@ -75,7 +81,7 @@ Make links to the certificates and key files according to relayd.conf documentat # ln -s /etc/ssl/acme/private/privkey.pem /etc/ssl/private/hostname.example\:1965.key ``` -Enable inetd and relayd and start them: +On OpenBSD, enable inetd and relayd and start them: ``` # rcctl enable relayd inetd # rcctl start relayd inetd