Browse code

modules/outbound: Updated documentation

Peter Dunkley authored on 18/05/2013 19:42:53
Showing 2 changed files
... ...
@@ -4,7 +4,7 @@ Peter Dunkley
4 4
 
5 5
    Crocodile RCS Ltd
6 6
 
7
-   Copyright (c) 2012-2013 Crocodile RCS Ltd
7
+   Copyright © 2012-2013 Crocodile RCS Ltd
8 8
      __________________________________________________________________
9 9
 
10 10
    Table of Contents
... ...
@@ -72,7 +72,7 @@ Chapter 1. Admin Guide
72 72
 1.1. Edge Proxy Keep-Alives (STUN)
73 73
 
74 74
    Outbound Edge Proxies MUST support STUN NAT keep-alives on their SIP
75
-   UDP ports. Kamailio supports this though the "stun" module.
75
+   UDP ports. Kamailio supports this though the “stun” module.
76 76
 
77 77
 1.2. Flow Timer
78 78
 
... ...
@@ -81,9 +81,9 @@ Chapter 1. Admin Guide
81 81
    responses to REGISTERs.
82 82
 
83 83
    When using TCP or TLS as the SIP transport care should be taken to set
84
-   the "tcp_connection_lifetime" on the Edge Proxy to a value slightly
84
+   the “tcp_connection_lifetime” on the Edge Proxy to a value slightly
85 85
    larger than the interval the Registrar is using for flow timer. Setting
86
-   "tcp_connection_lifetime" to less than the interval could cause
86
+   “tcp_connection_lifetime” to less than the interval could cause
87 87
    connections to be lost, and setting it to a value much larger than the
88 88
    interval will keep connections open far longer than is required (which
89 89
    is wasteful).
... ...
@@ -91,9 +91,9 @@ Chapter 1. Admin Guide
91 91
    Application-layer keep-alives are optional when the underlying
92 92
    transport already has a keep-alive mechanism. The WebSocket transport
93 93
    has a transport-layer keep-alive. When using the WebSocket transport
94
-   the "keepalive_timeout" should be set to a value a little greater than
94
+   the “keepalive_timeout” should be set to a value a little greater than
95 95
    the Registrar flow timer interval and a little less than the
96
-   "tcp_connection_lifetime".
96
+   “tcp_connection_lifetime”.
97 97
 
98 98
    Example 1.1. Edge Proxy Configuration
99 99
 #!KAMAILIO
... ...
@@ -483,6 +483,9 @@ event_route[tm:branch-failure:FAIL-BRANCH] {
483 483
    The following modules must be loaded before this module:
484 484
      * None
485 485
 
486
+   The following modules are required to make proper use of this module:
487
+     * stun.
488
+
486 489
 2.2. External Libraries or Applications
487 490
 
488 491
    The following libraries must be installed before running Kamailio with
... ...
@@ -445,6 +445,15 @@ event_route[tm:branch-failure:FAIL-BRANCH] {
445 445
 		</listitem>
446 446
 		</itemizedlist>
447 447
 		</para>
448
+		<para>
449
+		The following modules are required to make proper use of this
450
+		module:
451
+		<itemizedlist>
452
+		<listitem>
453
+		<para><emphasis>stun</emphasis>.</para>
454
+		</listitem>
455
+		</itemizedlist>
456
+		</para>
448 457
 	</section>
449 458
 
450 459
 	<section>