Gzip middleware for Negroni
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
gzip
.gitignore
LICENSE
Makefile
README.md

README.md

gzip

Gzip middleware for Negroni.

Mostly a copy of the Martini gzip module with small changes to make it function under Negroni. Support for setting the compression level has also been added and tests have been written. Test coverage is 100% according to go cover.

Usage

package main

import (
    "fmt"
    "net/http"

    "github.com/urfave/negroni"
    "github.com/phyber/negroni-gzip/gzip"
)

func main() {
    mux := http.NewServeMux()
    mux.HandleFunc("/", func(w http.ResponseWriter, req *http.Request) {
    	  fmt.Fprintf(w, "Welcome to the home page!")
    })

    n := negroni.Classic()
    n.Use(gzip.Gzip(gzip.DefaultCompression))
    n.UseHandler(mux)
    n.Run(":3000")
}

Make sure to include the Gzip middleware above any other middleware that alter the response body.

Tips

As noted above, any middleware that alters response body will need to be below the Gzip middleware. If you wish to gzip static files served by the default negroni Static middleware you will need to include negroni.Static() after gzip.Gzip().

    n := negroni.New()
    n.Use(negroni.NewRecovery())
    n.Use(negroni.NewLogger())
    n.Use(gzip.Gzip(gzip.DefaultCompression))
    n.Use(negroni.NewStatic(http.Dir("public")))

Warning

Compressing TLS traffic may leak the page contents to an attacker if the page contains user input. See the BREACH article on Wikipedia for more information.

Authors

And many others. Check the commit log for a complete list.