goStatic Docker Pulls Docker Build Build Status GoDoc
A really small, multi-arch, static web server for Docker
My goal is to create to smallest docker container for my web static files. The advantage of Go is that you can generate a fully static binary, so that you don't need anything else.
Yeah, decided to drop support of unsecured HTTPS. Two-years ago, when I started GoStatic, there was no automatic HTTPS available. Nowadays, thanks to Let's Encrypt, it's really easy to do so. If you need HTTPS, I recommend caddy.
- A fully static web server embedded in a
SCRATCHimage - No framework
- Web server built for Docker
- Light container
- More secure than official images (see below)
- Log enabled
- Specify custom response headers per path and filetype (info)
Because the official Golang image is wayyyy too big (around 1/2Gb as you can see below) and could be insecure.
For me, the whole point of containers is to have a light container... Many links should provide you with additional info to see my point of view:
- Over 30% of Official Images in Docker Hub Contain High Priority Security Vulnerabilities
- Create The Smallest Possible Docker Container
- Building Docker Images for Static Go Binaries
- Small Docker Images For Go Apps
docker run -d -p 80:8043 -v path/to/website:/srv/http --name goStatic pierrezemb/gostatic
./goStatic --help
Usage of ./goStatic:
-append-header HeaderName:Value
HTTP response header, specified as HeaderName:Value that should be added to all responses.
-context string
The 'context' path on which files are served, e.g. 'doc' will serve the files at 'http://localhost:<port>/doc/'
-default-user-basic-auth string
Define the user (default "gopher")
-enable-basic-auth
Enable basic auth. By default, password are randomly generated. Use --set-basic-auth to set it.
-enable-health
Enable health check endpoint. You can call /health to get a 200 response. Useful for Kubernetes, OpenFaas, etc.
-enable-logging
Enable log request
-fallback string
Default fallback file. Either absolute for a specific asset (/index.html), or relative to recursively resolve (index.html)
-header-config-path string
Path to the config file for custom response headers (default "/config/headerConfig.json")
-https-promote
All HTTP requests should be redirected to HTTPS
-password-length int
Size of the randomized password (default 16)
-path string
The path for the static files (default "/srv/http")
-port int
The listening port (default 8043)
-set-basic-auth string
Define the basic auth. Form must be user:password
The fallback option is principally useful for single-page applications (SPAs) where the browser may request a file, but where part of the path is in fact an internal route in the application, not a file on disk. goStatic supports two possible usages of this option:
- Using an absolute path so that all not found requests resolve to the same file
- Using a relative file, which searches up the tree for the specified file
The second case is useful if you have multiple SPAs within the one filesystem. e.g., / and /admin.
docker buildx create --use --name=cross
docker buildx build --platform=linux/amd64,linux/arm64,linux/arm/v5,linux/arm/v6,linux/arm/v7,darwin/amd64,darwin/arm64,windows/amd64 .