gophi/README.md
kim (grufwub) e3c57da7a7 fix readme doc links
Signed-off-by: kim (grufwub) <grufwub@gmail.com>
2020-07-12 12:46:35 +01:00

1.2 KiB

Gophor

PLEASE NOTE THIS README IS OUT-OF-DATE SINCE THE REWRITE.

A Gopher (and soon, Gemini!) server written in GoLang.

Unix (like) OSes only. Cross-compiled to way too many architectures. Build-script now much improved, but still not pretty...

I'm unemployed and 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 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])

  • Separate system and access logging

Further Docs

(Usage)[https://github.com/grufwub/gophor/blob/master/docs/USAGE.md]

(CGI compliance)[https://github.com/grufwub/gophor/blob/master/docs/CGI.md]

(Gopher specific information)[https://github.com/grufwub/gophor/blob/master/docs/GOPHER.md]

(Extra notes)[https://github.com/grufwub/gophor/blob/master/docs/MISC.md]