haproxy-brotli 0.1.0

HAProxy filter for brotli compression support
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

# haproxy-brotli

A Rust-based brotli module for [HAProxy] 3.2+ Community Edition using the [Lua Filter API].

It implemented as a native Lua module written in Rust using [mlua] and [haproxy-api] crates.

[HAProxy]: https://www.haproxy.org
[Lua Filter API]: https://www.arpalert.org/src/haproxy-lua-api/3.2/index.html
[mlua]: https://github.com/mlua-rs/mlua
[haproxy-api]: https://github.com/khvzak/haproxy-api-rs

## Usage and Configuration

Please check the [module](module) and [tests](tests) directories for working examples.

### HAProxy Configuration

```
global
    master-worker
    lua-load-per-thread brotli.lua

...

listen http-in
    bind *:8080
    filter lua.brotli offload type:text/,application/json
```

Create a file named `brotli.lua` with the following content:

```lua
local brotli = require("haproxy_brotli_module")
brotli.register()
```

Only `GET`/`POST` requests with the `Accept-Encoding: br` header will be compressed.

### Configuration Options

The `filter lua.brotli` directive supports the following options:

- `offload`: Remove the `Accept-Encoding` header to prevent backend servers from compressing responses.
- `type:` A comma-separated list of MIME type prefixes to compress. Default is empty (all types).
- `quality:N` Compression quality level (0-11). Default is 5.
- `window:N` The sliding window size (in bits) to use for compression (10-24). Default is 22.

## License

This project is licensed under the [MIT license](LICENSE)