Browse code

registrar: update documentation to include path_check_local parameter

Charles Chance authored on 09/01/2015 17:22:59
Showing 1 changed files
... ...
@@ -630,6 +630,32 @@ modparam("registrar", "path_use_received", 1)
630 630
 		</example>
631 631
 	</section>
632 632
 
633
+	<section id="registrar.p.path_check_local">
634
+		<title><varname>path_check_local</varname> (integer)</title>
635
+		<para>
636
+		If set to 1, when performing a lookup the Path (if present) is evaluated
637
+		and if the first hop is local (according to <quote>myself</quote> test), we
638
+		skip it	to avoid unnecessary looping.
639
+		</para>
640
+		<para>
641
+		This is useful if multiple servers are sharing a common location database,
642
+		each saving contacts with their local address as the Path.
643
+		</para>
644
+		<para>
645
+		<emphasis>
646
+		Default value is 0 (disabled).
647
+		</emphasis>
648
+		</para>
649
+		<example>
650
+		<title>Set <varname>path_check_local</varname> parameter</title>
651
+		<programlisting format="linespecific">
652
+...
653
+modparam("registrar", "path_check_local", 1)
654
+...
655
+		</programlisting>
656
+		</example>
657
+	</section>
658
+
633 659
 	<section id="registrar.p.reg_callid_avp">
634 660
 		<title><varname>reg_callid_avp</varname> (string)</title>
635 661
 		<para>