Mercurial > prosody-modules

comparison mod_compression/README.markdown @ 2483:b3097323278f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_compression/README: Some cleanup and rewording
author Kim Alvefur <zash@zash.se>
date Sun, 05 Feb 2017 14:46:23 +0100
parents c96a53b0b820
children 560378965b82
comparison
equal deleted inserted replaced
2482:c96a53b0b820 2483:b3097323278f
1 While the bandwidth usage of XMPP isn't great, compressing the data sent 1 While the bandwidth usage of XMPP isn't that much, compressing the data
2 to/from your server can give significant benefits to those on slow 2 sent to/from your server can give significant benefits to those on slow
3 connections, such as dial-up or mobile networks. Prosody supports 3 connections, such as dial-up or mobile networks. Prosody supports
4 compression for client-to-server (if your client supports it) and 4 compression for client-to-server (if your client supports it) and
5 server-to-server streams using the mod\_compression plugin. 5 server-to-server streams using the mod\_compression plugin.
6 6
7 # Details 7 # Details
8 8
9 mod\_compression implements 9 mod\_compression implements [XEP-0138], and supports the zlib compression
10 [XEP-0138](http://xmpp.org/extensions/xep-0138.html "http://xmpp.org/extensions/xep-0138.html"){.urlextern}, 10 algorithm.
11 and supports the zlib compression algorithm.
12 11
13 ## Dependencies 12 ## Dependencies
14 13
15 The XMPP protocol specifies that all clients and servers supporting 14 The XMPP protocol specifies that all clients and servers supporting
16 compression must support the "zlib" compression method, and this is what 15 compression must support the "zlib" compression method, and this is what
29 -- Other modules 28 -- Other modules
30 "compression"; -- Enable mod_compression 29 "compression"; -- Enable mod_compression
31 } 30 }
32 ``` 31 ```
33 32
34 Configuration 33 ## Configuration
35 -------------
36 34
37 Option Default Notes 35 The compression level can be set using the `compression_level` option
38 -------------------- --------- -------------------------------------------------------------------------------------------------------------------- 36 which can be a number from 1 to 9. Higher compression levels will use
39 compression\_level 7 Can be a number from 1 to 9, where 9 is best. Higher compression levels will use more resources but less bandwidth 37 more resources but less bandwidth.
40 38
41 Example 39 ## Example
42 -------
43 40
44 ``` lua 41 ``` lua
45 modules_enabled = { 42 modules_enabled = {
46 -- Other modules 43 -- Other modules
47 "compression"; -- Enable mod_compression 44 "compression"; -- Enable mod_compression