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 highly-customizable HTTP, HTTP/2, HTTPS server
  13 written on pure Go.
  14
  15 Why yet another web-server? Because all others suck even for my simple
  16 ordinary needs: they use hateful OpenSSL, lacks documentation, has
  17 complex configuration format, lack some features, hard to extend with.
  18
  19 @itemize
  20
  21 @item Rather minimalistic pure-Go web-server with few number of
  22 dependencies, producing single statically linked executable. Maximal
  23 reuse of native libraries capabilities.
  24
  25 @item Modern, reliable, secure and fast TLS 1.3 implementation with
  26 ChaCha20-Poly1305, session resumption and SNI.
  27
  28 @item If built with @url{http://www.gostls13.cypherpunks.ru/, gostls13},
  29 then @url{http://www.gost.cypherpunks.ru/, GOST} TLS 1.3 cryptography
  30 will be fully supported, with ability to use GOST-based X.509
  31 certificates if client announces its knowledge of GOST algorithms (with
  32 the fallback to ordinary ECDSA ones).
  33
  34 @item HTTP/1.1, @url{https://en.wikipedia.org/wiki/HTTP%2F2, HTTP/2}
  35 (only when negotiated during ALPN) and keepalives support. Graceful
  36 shutdowns.
  37
  38 @item @code{gzip} and @url{https://facebook.github.io/zstd/, Zstandard}
  39 compression on-the-fly.
  40
  41 @item @code{Range}, @code{ETag} (based on file/directory's
  42 @code{ctime}), @code{Last-Modified} and corresponding precondition
  43 handlers are fully used.
  44
  45 @item Auto-generated directory listings and
  46 read-only @url{https://en.wikipedia.org/wiki/WebDAV, WebDAV} support.
  47
  48 @item Per-domain HTTP basic authorization and TLS client authentication.
  49
  50 @item If corresponding @file{.meta4} files are found, then @code{Link}
  51 header is generated automatically to that
  52 @url{http://www.metalinker.org/, Metalink}.
  53
  54 @item Very friendly to @url{http://cr.yp.to/daemontools.html, daemontools}.
  55 Can drop (UID, GID, groups) privileges.
  56
  57 @end itemize
  58
  59 Basically all configuration is done directly inside source code. You
  60 have to recompile it every time configuration changes. Is it a problem?
  61 I doubt, because Go is very fast. But it produces huge statically linked
  62 executables, you say! Use @command{bsdiff}/@command{bspatch}!
  63
  64 Send @code{SIGINFO} signal to get current daemon's configuration.
  65
  66 Initially @command{godlighty} has basic static files handlers (with
  67 compression, HTTP preconditions are enabled of course). In the example
  68 below there are nearly all default functions.
  69
  70 @verbatim
  71 Hosts["example.com"] = &godlighty.HostCfg{
  72     Root: "/www/example.com",
  73     TLS: &godlighty.TLSCfg{
  74         Cert: "/path/to/example.com.pem",
  75         Key: "/path/to/example.com.key.pem",
  76         CACert: "/path/to/ca.pem",
  77     },
  78     DirList: true,
  79     WebDAV: true,
  80     MIMEs: map[string]string{
  81         ".special": "text/x-special-type",
  82     },
  83 }
  84 @end verbatim
  85
  86 If your keys and certificates are in single file and you use common CA
  87 certificate, then it is trivial to DRY:
  88
  89 @verbatim
  90 var (
  91     Etc = "/whatever"
  92     CACert = path.Join(Etc, "ca.pem")
  93 )
  94
  95 func newTLSCfg(host string) *godlighty.TLSCfg {
  96     return &godlighty.TLSCfg{
  97         Cert:   path.Join(Etc, host+".pem"),
  98         Key:    path.Join(Etc, host+".pem"),
  99         CACert: CACert,
 100     }
 101 }
 102 @end verbatim
 103
 104 But there are hooks that can do anything more. For example if you want
 105 to run CGI script or make a redirection:
 106
 107 @verbatim
 108 HostCfg{
 109     ...,
 110     Hooks: []godlighty.Hook{
 111         func(w http.ResponseWriter, r *http.Request) bool {
 112             if r.URL.Path == "/" {
 113                 http.Redirect(w, r, "//here.we.go/", http.StatusMovedPermanently)
 114                 return true
 115             }
 116             return false
 117         },
 118         func(w http.ResponseWriter, r *http.Request) bool {
 119             cgi.Handler{
 120                 Path: "/usr/local/libexec/git-core/git-http-backend",
 121                 Dir:  "/var/empty",
 122                 Env: []string{
 123                     "GIT_PROJECT_ROOT=" + root,
 124                     "GIT_HTTP_EXPORT_ALL=",
 125                 },
 126             }.ServeHTTP(w, r)
 127             return true
 128         },
 129     },
 130 @end verbatim
 131
 132 You can separate your configuration files and add them through
 133 @code{init()} call:
 134
 135 @verbatim
 136 $ ls rc
 137 blog.stargrave.org.go
 138 ca.cypherpunks.ru.go
 139 cgi.go
 140 cryptoanarchy.ru.go
 141 git.go
 142 go.go
 143 if.mirror.cypherpunks.ru.go
 144 lists.cypherpunks.ru.go
 145 mime.go
 146 static.go
 147 tls.go
 148 [...]
 149
 150 $ cat rc/static
 151 package rc
 152
 153 import "path"
 154
 155 func addStaticCfg(host, root string) {
 156     if !path.IsAbs(root) {
 157         root = path.Join(WWW, root)
 158     }
 159     godlighty.Hosts[host] = &godlighty.HostCfg{
 160         Root: root,
 161         TLS:  newTLSCfg(host),
 162     }
 163 }
 164
 165 func addStaticListedDir(host, root string) {
 166     addStaticCfg(host, root)
 167     godlighty.Hosts[host].DirList = true
 168     godlighty.Hosts[host].WebDAV = true
 169 }
 170
 171 func init() {
 172     [...]
 173     addStaticCfg("paster.stargrave.org", "/storage/paster/pastes")
 174     addStaticCfg("www.godlighty.stargrave.org", "godlighty.stargrave.org")
 175     addStaticCfg("www.nncpgo.org", "nncpgo.org")
 176     addStaticListedDir("www.mds.cypherpunks.ru", "/storage/audiobook/mds")
 177     [...]
 178 }
 179 @end verbatim
 180
 181 It is created exclusively to drive my own websites, but if you are
 182 interested, then @code{git clone git://git.stargrave.org/godlighty.git} it.
 183
 184 @bye