Mercurial > prosody-modules

comparison mod_compression_unsafe/README.markdown @ 2776:3092ae96c1f0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_compression: Rename to mod_compression_unsafe and add security note
author Matthew Wild <mwild1@gmail.com>
date Tue, 26 Sep 2017 14:08:39 +0100
parents mod_compression/README.markdown@a5d4a78c7619
children 4b7e6c01aa1c
comparison
equal deleted inserted replaced
2775:8407137c0a3b 2776:3092ae96c1f0
1 **NOTE:** XMPP compression has unresolved [security concerns](https://mail.jabber.org/pipermail/standards/2014-October/029215.html),
2 and this module has been removed from Prosody and renamed.
3
4 While the bandwidth usage of XMPP isn't that much, compressing the data
5 sent to/from your server can give significant benefits to those on slow
6 connections, such as dial-up or mobile networks. Prosody supports
7 compression for client-to-server (if your client supports it) and
8 server-to-server streams using the mod\_compression plugin.
9
10 # Details
11
12 mod\_compression implements [XEP-0138], and supports the zlib compression
13 algorithm.
14
15 ## Dependencies
16
17 The XMPP protocol specifies that all clients and servers supporting
18 compression must support the "zlib" compression method, and this is what
19 Prosody uses. However you will need to install zlib support for Lua on
20 your system. There are different ways of doing this depending on your
21 system. If in doubt whether it is installed correctly, the command
22 `lua -lzlib` in a console should open a Lua prompt with no errors.
23
24 Debian/Ubuntu
25 : `apt-get install lua-zlib`
26
27 LuaRocks
28 : `luarocks install lua-zlib`
29
30 Source
31 : <https://github.com/brimworks/lua-zlib>
32
33 # Usage
34
35 ``` lua
36 modules_enabled = {
37 -- Other modules
38 "compression"; -- Enable mod_compression
39 }
40 ```
41
42 ## Configuration
43
44 The compression level can be set using the `compression_level` option
45 which can be a number from 1 to 9. Higher compression levels will use
46 more resources but less bandwidth.
47
48 ## Example
49
50 ``` lua
51 modules_enabled = {
52 -- Other modules
53 "compression"; -- Enable mod_compression
54 }
55  
56 compression_level = 5
57 ```