You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-1Lines changed: 9 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,8 @@ zstd-nginx-module - Nginx module for the [Zstandard compression](https://faceboo
14
14
*[zstd_min_length](#zstd_min_length)
15
15
*[zstd_types](#zstd_types)
16
16
*[zstd_buffers](#zstd_buffers)
17
+
*[Variables](#variables)
18
+
*[$zstd_ratio](#$zstd_ratio)
17
19
*[Author](#author)
18
20
19
21
# Status
@@ -44,7 +46,7 @@ server {
44
46
45
47
# Installation
46
48
47
-
To use this module, configure your nginx branch with `--add-module=/path/to/zstd-nginx-module`. several points should be taken care.
49
+
To use this module, configure your nginx branch with `--add-module=/path/to/zstd-nginx-module`. Several points should be taken care.
48
50
49
51
* 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.
50
52
* static library will be tried prior to dynamic library, since this Nginx module uses some **advanced APIs** where static linking is recommended.
@@ -100,6 +102,12 @@ Enables ztd of responses for the specified MIME types in addition to "text/html"
100
102
101
103
Sets the number and size of buffers used to compress a response. By default, the buffer size is equal to one memory page. This is either 4K or 8K, depending on a platform.
102
104
105
+
# Variables
106
+
107
+
## $zstd_ratio
108
+
109
+
Achieved compression ratio, computed as the ratio between the original and compressed response sizes.
0 commit comments