[sr-dev] git:master:74560dcd: Merge pull request #1394 from tverlaan/nathelper_fix_documentation

[GitHub]

Module: kamailio
Branch: master
Commit: 74560dcd9bd4f7a00a9f82caded66f79a22940aa
URL: https://github.com/kamailio/kamailio/commit/74560dcd9bd4f7a00a9f82caded66f79a22940aa

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: GitHub <noreply at github.com>
Date: 2018-01-11T11:25:51+01:00

Merge pull request #1394 from tverlaan/nathelper_fix_documentation

nathelper: fix force_socket documentation

---

Modified: src/modules/nathelper/README
Modified: src/modules/nathelper/doc/nathelper_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/74560dcd9bd4f7a00a9f82caded66f79a22940aa.diff
Patch: https://github.com/kamailio/kamailio/commit/74560dcd9bd4f7a00a9f82caded66f79a22940aa.patch

---

diff --git a/src/modules/nathelper/README b/src/modules/nathelper/README
index 867e7aad88..55a1245053 100644
--- a/src/modules/nathelper/README
+++ b/src/modules/nathelper/README
@@ -249,14 +249,15 @@ Chapter 1. Admin Guide
 
 4.1. force_socket (string)
 
-   Socket to be used when sending NAT pings for UDP communication. If no
-   one specified, the OS will choose a socket.
+   Socket to be used when sending NAT pings for UDP communication.
+   It uses the first socket it finds based on the IP address. If
+   no one specified, the OS will choose a socket.
 
    Default value is “NULL”.
 
    Example 1.1. Set force_socket parameter
 ...
-modparam("nathelper", "force_socket", "localhost:33333")
+modparam("nathelper", "force_socket", "127.0.0.1")
 ...
 
 4.2. natping_interval (integer)
diff --git a/src/modules/nathelper/doc/nathelper_admin.xml b/src/modules/nathelper/doc/nathelper_admin.xml
index c032fc3a84..feb5b5cbe4 100644
--- a/src/modules/nathelper/doc/nathelper_admin.xml
+++ b/src/modules/nathelper/doc/nathelper_admin.xml
@@ -128,7 +128,8 @@
 		<title><varname>force_socket</varname> (string)</title>
 		<para>
 		Socket to be used when sending NAT pings for UDP communication.
-		If no one specified, the OS will choose a socket.
+		It uses the first socket it finds based on the IP address. If
+		no one specified, the OS will choose a socket.
 		</para>
 		<para>
 		<emphasis>
@@ -139,7 +140,7 @@
 		<title>Set <varname>force_socket</varname> parameter</title>
 		<programlisting format="linespecific">
 ...
-modparam("nathelper", "force_socket", "localhost:33333")
+modparam("nathelper", "force_socket", "127.0.0.1")
 ...
 </programlisting>
 		</example>