gophi/README.md
kim (grufwub) 6009e56337 make README more truthful!
Signed-off-by: kim (grufwub) <grufwub@gmail.com>
2020-09-22 10:43:05 +01:00

48 lines
1.2 KiB
Markdown

# Gophi
A server with Gopher & (soon-to-be) Gemini protocol support in GoLang!
The two protocols are supported separately, and as such you compile
the server with support for one or the other, not both.
Unix (like) OSes only. Cross-compiled to way too many architectures.
Build-script now much improved, but still not pretty...
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/
WARNING: the (currently non-extant) development branch is filled with lava,
fear and capitalism.
# Features
- Built with security, concurrency and efficiency in mind
- ZERO external dependencies
- LRU file caching with user-controlled cache size, max cached file size
and cache refresh frequency
- CGI/1.1 support
- URL encoding with query support
- Path access restrictions with regex (see [usage](docs/USAGE.md))
- Request remapping with regex (see [usage](docs/USAGE.md))
- User server spaces (see [usage](docs/USAGE.md))
- Separate system and access logging
# Further Docs
[Usage](docs/USAGE.md)
[CGI compliance](docs/CGI.md)
[Gopher specific information](docs/GOPHER.md)
[Extra notes](docs/MISC.md)