2 @documentencoding UTF-8
6 Copyright @copyright{} 2021 @email{stargrave@@stargrave.org, Sergey Matveev}
12 @command{godlighty} is highly-customizable HTTP, HTTP/2, HTTPS server
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.
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.
25 @item Modern, reliable, secure and fast TLS 1.3 implementation with
26 ChaCha20-Poly1305, session resumption and SNI.
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).
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
38 @item @code{gzip} and @url{https://facebook.github.io/zstd/, Zstandard}
39 compression on-the-fly.
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.
45 @item Auto-generated directory listings and
46 read-only @url{https://en.wikipedia.org/wiki/WebDAV, WebDAV} support.
48 @item Per-domain HTTP basic authorization and TLS client authentication.
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}.
54 @item Very friendly to @url{http://cr.yp.to/daemontools.html, daemontools}.
55 Can drop (UID, GID, groups) privileges.
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}!
64 Send @code{SIGINFO} (@code{SIGUSR1} on Linux) signal to get current
65 daemon's configuration.
67 Initially @command{godlighty} has basic static files handlers (with
68 compression, HTTP preconditions are enabled of course). In the example
69 below there are nearly all default functions.
72 Hosts["example.com"] = &godlighty.HostCfg{
73 Root: "/www/example.com",
74 TLS: &godlighty.TLSCfg{
75 Cert: "/path/to/example.com.pem",
76 Key: "/path/to/example.com.key.pem",
77 CACert: "/path/to/ca.pem",
81 MIMEs: map[string]string{
82 ".special": "text/x-special-type",
87 If your keys and certificates are in single file and you use common CA
88 certificate, then it is trivial to DRY:
93 CACert = path.Join(Etc, "ca.pem")
96 func newTLSCfg(host string) *godlighty.TLSCfg {
97 return &godlighty.TLSCfg{
98 Cert: path.Join(Etc, host+".pem"),
99 Key: path.Join(Etc, host+".pem"),
105 But there are hooks that can do anything more. For example if you want
106 to run CGI script or make a redirection:
111 Hooks: []godlighty.Hook{
112 func(w http.ResponseWriter, r *http.Request) bool {
113 if r.URL.Path == "/" {
114 http.Redirect(w, r, "//here.we.go/", http.StatusMovedPermanently)
119 func(w http.ResponseWriter, r *http.Request) bool {
121 Path: "/usr/local/libexec/git-core/git-http-backend",
124 "GIT_PROJECT_ROOT=" + root,
125 "GIT_HTTP_EXPORT_ALL=",
133 You can separate your configuration files and add them through
138 blog.stargrave.org.go
144 if.mirror.cypherpunks.ru.go
145 lists.cypherpunks.ru.go
156 func addStaticCfg(host, root string) {
157 if !path.IsAbs(root) {
158 root = path.Join(WWW, root)
160 godlighty.Hosts[host] = &godlighty.HostCfg{
162 TLS: newTLSCfg(host),
166 func addStaticListedDir(host, root string) {
167 addStaticCfg(host, root)
168 godlighty.Hosts[host].DirList = true
169 godlighty.Hosts[host].WebDAV = true
174 addStaticCfg("paster.stargrave.org", "/storage/paster/pastes")
175 addStaticCfg("www.godlighty.stargrave.org", "godlighty.stargrave.org")
176 addStaticCfg("www.nncpgo.org", "nncpgo.org")
177 addStaticListedDir("www.mds.cypherpunks.ru", "/storage/audiobook/mds")
182 It is created exclusively to drive my own websites, but if you are
183 interested, then @code{git clone git://git.stargrave.org/godlighty.git} it.