Skip to main content
Version: 3.9



The brotli Plugin dynamically sets the behavior of brotli in Nginx.


This Plugin requires brotli shared libraries.

The example commands to build and install brotli shared libraries:

cd brotli-1.1.0 && mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local/brotli ..
sudo cmake --build . --config Release --target install
sudo sh -c "echo /usr/local/brotli/lib >> /etc/"
sudo ldconfig

If the upstream is returning a compressed response, then the Brotli plugin won't be able to compress it.


NameTypeRequiredDefaultValid valuesDescription
typesarray[string] or "*"False["text/html"]Dynamically sets the brotli_types directive. Special value "*" matches any MIME type.
min_lengthintegerFalse20>= 1Dynamically sets the brotli_min_length directive.
comp_levelintegerFalse6[0, 11]Dynamically sets the brotli_comp_level directive.
modeintegerFalse0[0, 2]Dynamically sets the brotli decompress mode, more info in RFC 7932.
lgwinintegerFalse19[0, 10-24]Dynamically sets the brotli sliding window size, lgwin is Base 2 logarithm of the sliding window size, set to 0 lets compressor decide over the optimal value, more info in RFC 7932.
lgblockintegerFalse0[0, 16-24]Dynamically sets the brotli input block size, lgblock is Base 2 logarithm of the maximum input block size, set to 0 lets compressor decide over the optimal value, more info in RFC 7932.
http_versionnumberFalse1.11.1, 1.0Like the gzip_http_version directive, sets the minimum HTTP version of a request required to compress a response.
varybooleanFalsefalseLike the gzip_vary directive, enables or disables inserting the “Vary: Accept-Encoding” response header field.

Enable Plugin#

The example below enables the brotli Plugin on the specified Route:

curl -i  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
"uri": "/",
"plugins": {
"brotli": {
"upstream": {
"type": "roundrobin",
"nodes": {
"": 1

Example usage#

Once you have configured the Plugin as shown above, you can make a request as shown below:

curl -i -H "Accept-Encoding: br"
HTTP/1.1 200 OK
Content-Type: text/html; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Date: Tue, 05 Dec 2023 03:06:49 GMT
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Server: APISIX/3.6.0
Content-Encoding: br

Warning: Binary output can mess up your terminal. Use "--output -" to tell
Warning: curl to output it to your terminal anyway, or consider "--output
Warning: <FILE>" to save to a file.

Delete Plugin#

To remove the brotli Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.

curl  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
"uri": "/",
"upstream": {
"type": "roundrobin",
"nodes": {
"": 1