Browse code

tls: doc: update default value for compression

Andrei Pelinescu-Onciul authored on 19/03/2010 21:52:09
Showing 3 changed files
... ...
@@ -42,6 +42,10 @@ modules:
42 42
             versions: ssl_release_buffers, ssl_freelist_max_len,
43 43
             ssl_max_send_fragment, ssl_read_ahead. For more info see
44 44
             modules/doc/tls/README.
45
+           compression is now disabled by default. To enable it set
46
+            tls_disable_compression to 0, but note that memory usage will
47
+            increase dramatically especially for large number of
48
+            connections (>1000).
45 49
 tm:
46 50
    - t_reply() can be used both from the main/core onreply_route{} and tm
47 51
      onreply_route[...]{}s.
... ...
@@ -440,14 +440,15 @@ modparam("tls", "connection_timeout", 60)
440 440
 1.8.12. tls_disable_compression (boolean)
441 441
 
442 442
    If set compression over SSL/TLS will be disabled. Note that compression
443
-   uses a lot of memory, so if you want to minimize memory usage is a good
444
-   ideea to disable it.
443
+   uses a lot of memory (about 10x more then with the compression
444
+   disabled), so if you want to minimize memory usage is a good idea to
445
+   disable it.
445 446
 
446
-   By default compression is enabled.
447
+   By default compression is disabled.
447 448
 
448 449
    Example 13. Set tls_disable_compression parameter
449 450
 ...
450
-modparam("tls", "tls_disable_compression", 1)
451
+modparam("tls", "tls_disable_compression", 0) # enable
451 452
 ...
452 453
 
453 454
 1.8.13. ssl_release_buffers (integer)
... ...
@@ -259,17 +259,18 @@ modparam("tls", "connection_timeout", 60)
259 259
 	<title><varname>tls_disable_compression</varname> (boolean)</title>
260 260
 	<para>
261 261
 		If set compression over SSL/TLS will be disabled.
262
-		Note that compression uses a lot of memory, so if you want to minimize
263
-		memory usage is a good ideea to disable it.
262
+		Note that compression uses a lot of memory (about 10x more then with
263
+		the compression disabled), so if you want to minimize
264
+		memory usage is a good idea to disable it.
264 265
 	</para>
265 266
 	<para>
266
-		By default compression is enabled.
267
+		By default compression is disabled.
267 268
 	</para>
268 269
 	<example>
269 270
 	    <title>Set <varname>tls_disable_compression</varname> parameter</title>
270 271
 	    <programlisting>
271 272
 ...
272
-modparam("tls", "tls_disable_compression", 1)
273
+modparam("tls", "tls_disable_compression", 0) # enable
273 274
 ...
274 275
 	    </programlisting>
275 276
 	</example>