topoh: documented mask_ip parameter

(cherry picked from commit 15ece92703aa691333d06a79b7e9901bf893bf74)

modules/topoh/README

@@ -26,12 +26,13 @@ Daniel-Constantin Mierla
         3. Exported Parameters
 
               3.1. mask_key (str)
-              3.2. mask_callid (integer)
-              3.3. uparam_name (str)
-              3.4. uparam_prefix (str)
-              3.5. vparam_name (str)
-              3.6. vparam_prefix (str)
-              3.7. callid_prefix (str)
+              3.2. mask_ip (str)
+              3.3. mask_callid (integer)
+              3.4. uparam_name (str)
+              3.5. uparam_prefix (str)
+              3.6. vparam_name (str)
+              3.7. vparam_prefix (str)
+              3.8. callid_prefix (str)
 
         4. Exported Functions
 
@@ -40,12 +41,13 @@ Daniel-Constantin Mierla
    List of Examples
 
    1.1. Set mask_key parameter
-   1.2. Set mask_callid parameter
-   1.3. Set uparam_name parameter
-   1.4. Set uparam_prefix parameter
-   1.5. Set vparam_name parameter
-   1.6. Set vparam_prefix parameter
-   1.7. Set callid_prefix parameter
+   1.2. Set mask_ip parameter
+   1.3. Set mask_callid parameter
+   1.4. Set uparam_name parameter
+   1.5. Set uparam_prefix parameter
+   1.6. Set vparam_name parameter
+   1.7. Set vparam_prefix parameter
+   1.8. Set callid_prefix parameter
 
 Chapter 1. Admin Guide
 
@@ -60,12 +62,13 @@ Chapter 1. Admin Guide
    3. Exported Parameters
 
         3.1. mask_key (str)
-        3.2. mask_callid (integer)
-        3.3. uparam_name (str)
-        3.4. uparam_prefix (str)
-        3.5. vparam_name (str)
-        3.6. vparam_prefix (str)
-        3.7. callid_prefix (str)
+        3.2. mask_ip (str)
+        3.3. mask_callid (integer)
+        3.4. uparam_name (str)
+        3.5. uparam_prefix (str)
+        3.6. vparam_name (str)
+        3.7. vparam_prefix (str)
+        3.8. callid_prefix (str)
 
    4. Exported Functions
 
@@ -107,12 +110,13 @@ Chapter 1. Admin Guide
 3. Exported Parameters
 
    3.1. mask_key (str)
-   3.2. mask_callid (integer)
-   3.3. uparam_name (str)
-   3.4. uparam_prefix (str)
-   3.5. vparam_name (str)
-   3.6. vparam_prefix (str)
-   3.7. callid_prefix (str)
+   3.2. mask_ip (str)
+   3.3. mask_callid (integer)
+   3.4. uparam_name (str)
+   3.5. uparam_prefix (str)
+   3.6. vparam_name (str)
+   3.7. vparam_prefix (str)
+   3.8. callid_prefix (str)
 
 3.1. mask_key (str)
 
@@ -125,7 +129,20 @@ Chapter 1. Admin Guide
 modparam("topoh", "mask_key", "some secret here")
 ...
 
-3.2. mask_callid (integer)
+3.2. mask_ip (str)
+
+   IP address to be used in masked headers to build valid SIP URIs. Can be
+   any IP address, does not affect routing when used on the main SIP
+   server.
+
+   Default value is "10.1.1.10".
+
+   Example 1.2. Set mask_ip parameter
+...
+modparam("topoh", "mask_ip", "192.168.0.1")
+...
+
+3.3. mask_callid (integer)
 
    Whether to encode or not the call-id. Some SIP extensions include the
    call-id in SIP message payload or header, so it is safe to not encode
@@ -134,62 +151,62 @@ modparam("topoh", "mask_key", "some secret here")
 
    Default value is 0 (do not mask).
 
-   Example 1.2. Set mask_callid parameter
+   Example 1.3. Set mask_callid parameter
 ...
 modparam("topoh", "mask_callid", 1)
 ...
 
-3.3. uparam_name (str)
+3.4. uparam_name (str)
 
    Name of URI param where to store encoded value.
 
    Default value is "line".
 
-   Example 1.3. Set uparam_name parameter
+   Example 1.4. Set uparam_name parameter
 ...
 modparam("topoh", "uparam_name", "myparam")
 ...
 
-3.4. uparam_prefix (str)
+3.5. uparam_prefix (str)
 
    Prefix to be added in encoded URI params.
 
    Default value is "sr-".
 
-   Example 1.4. Set uparam_prefix parameter
+   Example 1.5. Set uparam_prefix parameter
 ...
 modparam("topoh", "uparam_prefix", "xyz")
 ...
 
-3.5. vparam_name (str)
+3.6. vparam_name (str)
 
    Name of Via param where to store encoded value.
 
    Default value is "branch".
 
-   Example 1.5. Set vparam_name parameter
+   Example 1.6. Set vparam_name parameter
 ...
 modparam("topoh", "vparam_name", "myv")
 ...
 
-3.6. vparam_prefix (str)
+3.7. vparam_prefix (str)
 
    Prefix to be added in encoded Via params.
 
    Default value is "z9hG4bKsr-".
 
-   Example 1.6. Set vparam_prefix parameter
+   Example 1.7. Set vparam_prefix parameter
 ...
 modparam("topoh", "vparam_prefix", "xyz")
 ...
 
-3.7. callid_prefix (str)
+3.8. callid_prefix (str)
 
    Prefix to be added in encoded Call-ID: headers.
 
    Default value is "!!:".
 
-   Example 1.7. Set callid_prefix parameter
+   Example 1.8. Set callid_prefix parameter
 ...
 modparam("topoh", "callid_prefix", "***")
 ...

modules/topoh/doc/topoh_admin.xml

@@ -82,6 +82,27 @@
 ...
 modparam("topoh", "mask_key", "some secret here")
 ...
+</programlisting>
+		</example>
+	</section>
+	<section>
+		<title><varname>mask_ip</varname> (str)</title>
+		<para>
+		IP address to be used in masked headers to build valid
+		SIP URIs. Can be any IP address, does not affect routing
+		when used on the main SIP server.
+		</para>
+		<para>
+		<emphasis>
+			Default value is "10.1.1.10".
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>mask_ip</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("topoh", "mask_ip", "192.168.0.1")
+...
 </programlisting>
 		</example>
 	</section>