doc/index.texi

   1 \input texinfo
   2 @documentencoding UTF-8
   3 @settitle godlighty
   4
   5 @copying
   6 Copyright @copyright{} 2021 @email{stargrave@@stargrave.org, Sergey Matveev}
   7 @end copying
   8
   9 @node Top
  10 @top godlighty
  11
  12 @command{godlighty} is
  13 @url{https://www.gnu.org/philosophy/free-sw.html, free software}
  14 highly-customizable HTTP, HTTP/2, HTTPS server written on pure Go.
  15
  16 Why yet another web-server? Because all others suck even for my simple
  17 ordinary needs: they use hateful OpenSSL, lacks documentation, has
  18 complex configuration format, lack some features, hard to extend with.
  19
  20 @itemize
  21
  22 @item Rather minimalistic pure-Go web-server with few number of
  23 dependencies, producing single statically linked executable. Maximal
  24 reuse of native libraries capabilities.
  25
  26 @item Modern, reliable, secure and fast TLS 1.3 implementation with
  27 ChaCha20-Poly1305, session resumption and SNI.
  28
  29 @item If built with @url{http://www.gostls13.cypherpunks.ru/, gostls13},
  30 then @url{http://www.gost.cypherpunks.ru/, GOST} TLS 1.3 cryptography
  31 will be fully supported, with ability to use GOST-based X.509
  32 certificates if client announces its knowledge of GOST algorithms (with
  33 the fallback to ordinary ECDSA ones).
  34
  35 @item HTTP/1.1, @url{https://en.wikipedia.org/wiki/HTTP%2F2, HTTP/2}
  36 (only when negotiated during ALPN) and keepalives support. Graceful
  37 shutdowns.
  38
  39 @item @code{gzip} and @url{https://facebook.github.io/zstd/, Zstandard}
  40 compression on-the-fly.
  41
  42 @item @code{Range}, @code{ETag} (based on file/directory's
  43 @code{ctime}), @code{Last-Modified} and corresponding precondition
  44 handlers are fully used.
  45
  46 @item Auto-generated directory listings and
  47 read-only @url{https://en.wikipedia.org/wiki/WebDAV, WebDAV} support.
  48
  49 @item Per-domain HTTP basic authorization and TLS client authentication.
  50
  51 @item If corresponding @file{.meta4} files are found, it is parsed and
  52 additional @code{Link}s with @code{Digest}s headers are generated
  53 automatically, based on that @url{http://www.metalinker.org/, Metalink}
  54 file.
  55
  56 @item Very friendly to @url{http://cr.yp.to/daemontools.html, daemontools}.
  57 Can drop (UID, GID, groups) privileges.
  58
  59 @end itemize
  60
  61 Basically all configuration is done directly inside source code. You
  62 have to recompile it every time configuration changes. Is it a problem?
  63 I doubt, because Go is very fast. But it produces huge statically linked
  64 executables, you say! Use @command{bsdiff}/@command{bspatch}!
  65
  66 It is created exclusively to drive my own websites, but if you are
  67 interested, then @code{git clone git://git.stargrave.org/godlighty.git} it.
  68
  69 @include cfg.texi
  70 @include usage.texi
  71
  72 @bye