[sr-dev] git:master: modules/outbound: Updated documentation

Peter Dunkley peter.dunkley at crocodile-rcs.com
Sat May 18 21:43:29 CEST 2013


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

Author: Peter Dunkley <peter.dunkley at crocodile-rcs.com>
Committer: Peter Dunkley <peter.dunkley at crocodile-rcs.com>
Date:   Sat May 18 20:42:53 2013 +0100

modules/outbound: Updated documentation

---

 modules/outbound/README                 |   15 +++++++++------
 modules/outbound/doc/outbound_admin.xml |    9 +++++++++
 2 files changed, 18 insertions(+), 6 deletions(-)

diff --git a/modules/outbound/README b/modules/outbound/README
index 2f23ab1..1f89d4c 100644
--- a/modules/outbound/README
+++ b/modules/outbound/README
@@ -4,7 +4,7 @@ Peter Dunkley
 
    Crocodile RCS Ltd
 
-   Copyright (c) 2012-2013 Crocodile RCS Ltd
+   Copyright © 2012-2013 Crocodile RCS Ltd
      __________________________________________________________________
 
    Table of Contents
@@ -72,7 +72,7 @@ Chapter 1. Admin Guide
 1.1. Edge Proxy Keep-Alives (STUN)
 
    Outbound Edge Proxies MUST support STUN NAT keep-alives on their SIP
-   UDP ports. Kamailio supports this though the "stun" module.
+   UDP ports. Kamailio supports this though the “stun” module.
 
 1.2. Flow Timer
 
@@ -81,9 +81,9 @@ Chapter 1. Admin Guide
    responses to REGISTERs.
 
    When using TCP or TLS as the SIP transport care should be taken to set
-   the "tcp_connection_lifetime" on the Edge Proxy to a value slightly
+   the “tcp_connection_lifetime” on the Edge Proxy to a value slightly
    larger than the interval the Registrar is using for flow timer. Setting
-   "tcp_connection_lifetime" to less than the interval could cause
+   “tcp_connection_lifetime” to less than the interval could cause
    connections to be lost, and setting it to a value much larger than the
    interval will keep connections open far longer than is required (which
    is wasteful).
@@ -91,9 +91,9 @@ Chapter 1. Admin Guide
    Application-layer keep-alives are optional when the underlying
    transport already has a keep-alive mechanism. The WebSocket transport
    has a transport-layer keep-alive. When using the WebSocket transport
-   the "keepalive_timeout" should be set to a value a little greater than
+   the “keepalive_timeout” should be set to a value a little greater than
    the Registrar flow timer interval and a little less than the
-   "tcp_connection_lifetime".
+   “tcp_connection_lifetime”.
 
    Example 1.1. Edge Proxy Configuration
 #!KAMAILIO
@@ -483,6 +483,9 @@ event_route[tm:branch-failure:FAIL-BRANCH] {
    The following modules must be loaded before this module:
      * None
 
+   The following modules are required to make proper use of this module:
+     * stun.
+
 2.2. External Libraries or Applications
 
    The following libraries must be installed before running Kamailio with
diff --git a/modules/outbound/doc/outbound_admin.xml b/modules/outbound/doc/outbound_admin.xml
index 4cd8f0d..de3d659 100644
--- a/modules/outbound/doc/outbound_admin.xml
+++ b/modules/outbound/doc/outbound_admin.xml
@@ -445,6 +445,15 @@ event_route[tm:branch-failure:FAIL-BRANCH] {
 		</listitem>
 		</itemizedlist>
 		</para>
+		<para>
+		The following modules are required to make proper use of this
+		module:
+		<itemizedlist>
+		<listitem>
+		<para><emphasis>stun</emphasis>.</para>
+		</listitem>
+		</itemizedlist>
+		</para>
 	</section>
 
 	<section>




More information about the sr-dev mailing list