Browse code

registrar: docs updated to reflect sock_mode parameter

Daniel-Constantin Mierla authored on 14/10/2020 09:34:03
Showing 1 changed files
... ...
@@ -535,26 +535,27 @@ modparam("registrar", "sock_hdr_name", "Sock-Info")
535 535
 		</example>
536 536
 	</section>
537 537
 
538
-	<section id="registrar.p.use_advertised_address">
539
-		<title><varname>use_advertised_address</varname> (integer)</title>
538
+	<section id="registrar.p.sock_mode">
539
+		<title><varname>sock_mode</varname> (integer)</title>
540 540
 		<para>
541
-		This parameter can be used to override value written into socket field when contact is saved.
542
-		If set to 1, advertised address will be written instead local listen socket.
541
+		If set to 1, the server stores the advertised address in socket field,
542
+		instead of bind address.
543 543
 		</para>
544 544
 		<para>
545
-		This could be useful when kamailio is installed behind NAT and it is necessary to store its public IP 
546
-		instead socket on which the register request was received.
545
+		This could be useful when kamailio is installed behind NAT and it is
546
+		necessary to store its public IP instead socket on which the register
547
+		request was received.
547 548
 		</para>
548 549
 		<para>
549 550
 		<emphasis>
550
-			Default value is 0 (disabled).
551
+			Default value is 0 (store bind address).
551 552
 		</emphasis>
552 553
 		</para>
553 554
 		<example>
554
-		<title>Set <varname>use_advertised_address</varname> parameter</title>
555
+		<title>Set <varname>sock_mode</varname> parameter</title>
555 556
 		<programlisting format="linespecific">
556 557
 ...
557
-modparam("registrar", "use_advertised_address", 1)
558
+modparam("registrar", "sock_mode", 1)
558 559
 ...
559 560
 		</programlisting>
560 561
 		</example>