A minimal HTTP server for serving static files (and websites).
It provides a few handy features for serving files and static websites:
- support for HTTP/2
- support for TLS (HTTPS)
- support for HTTP Basic Authentication
- directory listing in HTML and JSON format
- serve
index.html/index.htmfiles for the contaning directory - serve the corresponding
.html/.htmfile for a path without the suffix (when such path doesn't exist)
Pre-built binaries are available for different achitectures on the releases page.
Alternatively, it can be run simply as
go run ./cmd/h2staticand built with
go build ./cmd/h2staticwhich produces a h2static binary.
To run the server on HTTPS, a key/certificate pair in PEM format is required. The service can be run with
h2static -tls-cert cert.pem -tls-key key.pemWhen requesting a path that matches a directory, it's possible to get the
listing in JSON format by setting the Accept header to application/json in
the request:
$ curl -s -H "Accept: application/json" http:https://localhost:8080/ | jq
{
"Name": "/",
"IsRoot": true,
"Entries": [
{
"Name": "bar.txt",
"IsDir": false,
"Size": 11
},
{
"Name": "foo.txt",
"IsDir": false,
"Size": 6
},
{
"Name": "subdir",
"IsDir": true,
"Size": 0
}
]
}
It's possible to enable Basic-authentication for the static serve via the --basic-auth authfile option. The authfile should have the following format:
user1:bc547750b92797f955b36112cc9bdd5cddf7d0862151d03a167ada8995aa24a9ad24610b36a68bc02da24141ee51670aea13ed6469099a4453f335cb239db5da
user2:92a891f888e79d1c2e8b82663c0f37cc6d61466c508ec62b8132588afe354712b20bb75429aa20aa3ab7cfcc58836c734306b43efd368080a2250831bf7f363f
where passwords are SHA-512 hashed. A simple way to generate the hash is via:
echo -n PASSWORD | sha512sum
911b0a07a8cacfebc5f1f45596d67017136c950499fa5b4ff6faffa031f3cec7f197853d1660712c154e1f59c60f682e34ea9b5cbd2d8d5adb0c834f963f30de -and copying the resulting hash to the file.
Note that the password file is read once at startup, subsequent changes to it won't affect authentication.
Full usage options are as follows:
Usage of h2static:
-addr string
address and port to listen on (default ":8080")
-allow-outside-symlinks
allow symlinks with target outside of directory
-basic-auth string
password file for Basic Auth (each line should be in the form "user:SHA512-hash")
-css string
file to override builtin CSS for listing
-dir string
directory to serve (default ".")
-disable-h2
disable HTTP/2 support
-disable-index
disable directory index
-disable-lookup-with-suffix
disable matching files with .htm(l) suffix for paths without suffix
-log
log requests
-request-path-prefix string
prefix to strip from request path (e.g. when behind a reverse proxy)
-show-dotfiles
show files whose name starts with a dot
-tls-cert string
certificate file for TLS connections
-tls-key string
key file for TLS connections
The tool can be installed from the Snap Store, on systems where Snaps are supported, via
sudo snap install h2staticThe h2static binary should be available in path.
It's also possible to configure the service in the snap so that it run
automatically. See snap info h2static for details about the available snap
settings.
