fileserver

Enhanced file server for Go.

1. Provides ETag header generation (hex encoded md5 hash);
2. Compression with gzip.

Installation

To get started, run:

go get github.com/ffss92/fileserver

Usage

1. Serving static files

To get started using fileserver as a package in your application, simply mount it to your current router:

static := os.DirFS("static")
mux := http.NewServeMux()
// Stripping prefix is important here, or else your files won't be found.
mux.Handle("/static/", http.StripPrefix("/static/", fileserver.ServeFS(static)))
// Or
mux.Handle("/static/", http.StripPrefix("/static/", fileserver.Serve("assets")))

2. Serving Single-Page Applications

To serve a SPA, you can use the ServeSPA method by provided the FS of it's contents and a fallback file, like this:

spa := os.DirFS("ui/dist")
mux.Handle("/", http.StripPrefix("/", fileserver.ServeSPA(spa, "index.html")))

Roadmap

• Attempt to serve index.html instead of returning a 404 if a directory is requested. For example, requests to /static/dir will attempt serve /static/dir/index.html, if present.