Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hanadalee/ngx_http_unzstd_filter_module
A filter that decompresses responses with Content-Encoding: zstd for clients that do not support zstd encoding method
https://github.com/hanadalee/ngx_http_unzstd_filter_module
nginx nginx-module zstd zstd-zstandard-compress-decompress
Last synced: 14 days ago
JSON representation
A filter that decompresses responses with Content-Encoding: zstd for clients that do not support zstd encoding method
- Host: GitHub
- URL: https://github.com/hanadalee/ngx_http_unzstd_filter_module
- Owner: HanadaLee
- License: bsd-2-clause
- Created: 2024-10-29T17:02:37.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-01T15:42:54.000Z (2 months ago)
- Last Synced: 2024-12-20T09:08:55.655Z (14 days ago)
- Topics: nginx, nginx-module, zstd, zstd-zstandard-compress-decompress
- Language: C
- Homepage:
- Size: 26.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Name
ngx_http_unzstd_filter_module is a filter that decompresses responses with “Content-Encoding: zstd” for clients that do not support “zstd” ([Zstandard compression](https://facebook.github.io/zstd/)) encoding method. The module will be useful when it is desirable to store data compressed to save space and reduce I/O costs.
# Table of Content
* [Name](#name)
* [Status](#status)
* [Synopsis](#synopsis)
* [Installation](#installation)
* [Directives](#directives)
* [unzstd](#unzstd)
* [unzstd_force](#unzstd_force)
* [unzstd_buffers](#unzstd_buffers)
* [Author](#author)
* [License](#license)
# Status
This Nginx module is currently considered experimental. Issues and PRs are welcome if you encounter any problems.
> Known Issue: Due to improper handling of zstd library dependencies, this module needs to be built together with [zstd-nginx-module](https://github.com/tokers/zstd-nginx-module). I am currently unable to solve this problem. Welcome to submit PR.
# Synopsis
```nginx
server {
listen 127.0.0.1:8080;
server_name localhost;
location / {
# enable zstd decompression for clients that do not support zstd compression
unzstd on;
proxy_pass http://foo.com;
}
}
```
# Installation
To use theses modules, configure your nginx branch with `--add-module=/path/to/ngx_http_unzstd_filter_module`. Several points should be taken care.
* You can set environment variables `ZSTD_INC` and `ZSTD_LIB` to specify the path to `zstd.h` and the path to zstd shared library represently.
* static library will be tried prior to dynamic library, since this Nginx module uses some **advanced APIs** where static linking is recommended.
* System's zstd bundle will be linked if `ZSTD_INC` and `ZSTD_LIB` are not specified.
# Directives
## unzstd
**Syntax:** *unzstd on | off;*
**Default:** *unzstd off;*
**Context:** *http, server, location*
Enables or disables decompression of zstd compressed responses for clients that lack zstd support.
## unzstd_force
**Syntax:** *unzstd_force string ...;*
**Default:** *-*
**Context:** *http, server, location*
Defines the conditions for forced brotli decompression. If at least one value in the string parameter is not empty and not equal to "0", forced zstd decompression is performed. But it will not try to decompress responses that do not contain the response header Content-Encoding: zstd.
## unzstd_buffers
**Syntax:** *unzstd_buffers number size;*
**Default:** *unzstd_buffers 32 4k | 16 8k;*
**Context:** *http, server, location*
Sets the number and size of buffers used to decompress a response. By default, the buffer size is equal to one memory page. This is either 4K or 8K, depending on a platform.
# Author
Hanada [email protected]
This module is based on [ngx_http_gunzip_module](https://nginx.org/en/docs/http/ngx_http_gunzip_module.html), one of nginx core modules and [ngx_unbrotli](https://github.com/clyfish/ngx_unbrotli), a nginx module for brotli decompression.
# License
This Nginx module is licensed under [BSD 2-Clause License](LICENSE).