[sr-dev] git:master: tls: doc: update default value for compression

[Andrei Pelinescu-Onciul]

Module: sip-router
Branch: master
Commit: a120c193e57415db8f188a26bdc85ad160d0e069
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=a120c193e57415db8f188a26bdc85ad160d0e069

Author: Andrei Pelinescu-Onciul <andrei at iptel.org>
Committer: Andrei Pelinescu-Onciul <andrei at iptel.org>
Date:   Fri Mar 19 22:52:09 2010 +0100

tls: doc: update default value for compression

---

 NEWS                       |    4 ++++
 modules/tls/README         |    9 +++++----
 modules/tls/doc/params.xml |    9 +++++----
 3 files changed, 14 insertions(+), 8 deletions(-)

diff --git a/NEWS b/NEWS
index a9b1b57..1e5d4b5 100644
--- a/NEWS
+++ b/NEWS
@@ -42,6 +42,10 @@ modules:
             versions: ssl_release_buffers, ssl_freelist_max_len,
             ssl_max_send_fragment, ssl_read_ahead. For more info see
             modules/doc/tls/README.
+           compression is now disabled by default. To enable it set
+            tls_disable_compression to 0, but note that memory usage will
+            increase dramatically especially for large number of
+            connections (>1000).
 tm:
    - t_reply() can be used both from the main/core onreply_route{} and tm
      onreply_route[...]{}s.
diff --git a/modules/tls/README b/modules/tls/README
index 2ef42bf..e2b0866 100644
--- a/modules/tls/README
+++ b/modules/tls/README
@@ -440,14 +440,15 @@ modparam("tls", "connection_timeout", 60)
 1.8.12. tls_disable_compression (boolean)
 
    If set compression over SSL/TLS will be disabled. Note that compression
-   uses a lot of memory, so if you want to minimize memory usage is a good
-   ideea to disable it.
+   uses a lot of memory (about 10x more then with the compression
+   disabled), so if you want to minimize memory usage is a good idea to
+   disable it.
 
-   By default compression is enabled.
+   By default compression is disabled.
 
    Example 13. Set tls_disable_compression parameter
 ...
-modparam("tls", "tls_disable_compression", 1)
+modparam("tls", "tls_disable_compression", 0) # enable
 ...
 
 1.8.13. ssl_release_buffers (integer)
diff --git a/modules/tls/doc/params.xml b/modules/tls/doc/params.xml
index 9d3d80e..b898dc5 100644
--- a/modules/tls/doc/params.xml
+++ b/modules/tls/doc/params.xml
@@ -259,17 +259,18 @@ modparam("tls", "connection_timeout", 60)
 	<title><varname>tls_disable_compression</varname> (boolean)</title>
 	<para>
 		If set compression over SSL/TLS will be disabled.
-		Note that compression uses a lot of memory, so if you want to minimize
-		memory usage is a good ideea to disable it.
+		Note that compression uses a lot of memory (about 10x more then with
+		the compression disabled), so if you want to minimize
+		memory usage is a good idea to disable it.
 	</para>
 	<para>
-		By default compression is enabled.
+		By default compression is disabled.
 	</para>
 	<example>
 	    <title>Set <varname>tls_disable_compression</varname> parameter</title>
 	    <programlisting>
 ...
-modparam("tls", "tls_disable_compression", 1)
+modparam("tls", "tls_disable_compression", 0) # enable
 ...
 	    </programlisting>
 	</example>