Skip to content

Commit 881dc27

Browse files
committed
doc: added a warning about the use of zstd_dict_file.
1 parent 47e77c8 commit 881dc27

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,8 @@ The `ngx_http_zstd_filter_module` module is a filter that compresses responses u
8181

8282
Specifies the external dictionary.
8383

84+
**WARNING:** Be careful! The content-coding registration only specifies a means to signal the use of the zstd format, and does not additionally specify any mechanism for advertising/negotiating/synchronizing the use of a specific dictionary between client and server. Use the `zstd_dict_file` only if you can insure that both ends (server and client) are capable of using the same dictionary (e.g. advertise with a HTTP header). See https://github.com/tokers/zstd-nginx-module/issues/2 for the details.
85+
8486
### zstd
8587

8688
**Syntax:** *zstd on | off;*

0 commit comments

Comments
 (0)