update docs + README

Signed-off-by: kim (grufwub) <grufwub@gmail.com>

Former-commit-id: eef14c7da280da725611d07a5ae9d2f4fe0018d0
development
kim (grufwub) 4 years ago
parent 2e97b28ce5
commit b2cbcc32f3

@ -9,7 +9,12 @@ I work on open-source projects like this and many others for
free. If you would like to help support my work that would be hugely
appreciated 💕 https://liberapay.com/grufwub/
Binary releases in `build/`
Binary releases at:
- `gemini://iim.gay/files/gophi/`
- `gopher://iim.gay/1/files/gophi/`
For now, Gophi compilation is reliant on a version of Go that has latest POSIX
syscall fixes cherry picked, e.g. [my fork](https://github.com/grufwub/go/tree/go1.15.5-posix-syscall-fix)
# Features
@ -32,8 +37,8 @@ Binary releases in `build/`
- Separate system and access logging
- Chroot and privilege dropping support (see [extra notes](docs/MISC.md)
for more information)
- Chroot and dropping permissions to provided user+group (see [extra notes](docs/MISC.md)
for why you may want to do this over manually executing binary in a chroot)
- Only 1 external dependency, `go-toml` brought in by my own `go-config`
library

@ -6,8 +6,13 @@ Go strings. Support for more encoding schemes is planned for the future
# Chroots & Privilege Dropping
For now, Gophi compilation is reliant on a version of Go that has latest POSIX
syscall fixes cherry picked, e.g. [my fork](https://github.com/grufwub/go/tree/go1.15.5-posix-syscall-fix)
If you use a chroot and want to execute CGI scripts, you'll need to set it
up accordingly (symlink appropriate virtual filesystems).
NOTE: if you use a chroot and want to execute CGI scripts, you'll need to set it
up accordingly (symlink appropriate virtual filesystems)
A chroot is generally not compatible with user spaces, unless you bind
mount the user spaces to directories within the chroot i.e.
```
/home/user/public_gopher -> /var/examplechroot/home/user/public_gopher
/home/user/public_gemini -> /var/examplechroot/home/user/public_gemini
```

Loading…
Cancel
Save