Brotli for NGINX

Brotli is defined in RFC 7932 and reading the RFC is fun, it is most simply described by

Brotli is an open-source algorithm from Google used for compression It is an alternative to the famous GZIP compression. Several case studies have shown that Brotli excels in compression speed and file size in comparison to GZIP when using the default. Also, all modern browsers support Brotli by now, though only over HTTPS.

An implementation of Brotli is available for NGINX by Google. As it needs to be compiled from source I have attached my code below to build it for Debian/Ubuntu.

Warning: Before any implementing HTTP compression, be aware that you may be exposing yourself to BREACH-attacks!

mkdir $WORKDIR

# Get google/ngx_brotli source code + google/ngx_brotli submodules
git clone git://
cd ngx_brotli
git submodule update --init

# Get the currently installed Nginx source code (Debian package)
apt source nginx
NGINX_SOURCE=$(ls -td -- */ | head -n 1 | cut -d'/' -f1)

# Find the ./configure line Nginx was compiled with
nginx -V

# Call `./configure` with ALL arguments from "configure arguments:" output above, **except** for the `--add-dynamic-module` ones, and append `--add-dynamic-module=../ngx_brotli` to the end
./configure --with-cc-opt='-g -O2 ....................... --add-dynamic-module=../ngx_brotli

# Build and copy build modules to the right place
make modules
mkdir -p /usr/local/lib/nginx/modules/
sudo cp objs/ /usr/local/lib/nginx/modules/
sudo cp objs/ /usr/local/lib/nginx/modules/

# cleanup
rm -rf $WORKDIR

Enable by adding following to enforce Brotli compression in NGINX :

load_module /usr/local/lib/nginx/modules/;
load_module /usr/local/lib/nginx/modules/;

Last updated