modules_k/registrar Updated documentation to reflect ser cfg framework integration

modules_k/registrar/README

@@ -16,7 +16,7 @@ Edited by
 
 Bogdan-Andre Iancu
 
-   Copyright © 2003 FhG FOKUS
+   Copyright © 2003 FhG FOKUS
    Revision History
    Revision $Revision$ $Date$
      __________________________________________________________________
@@ -188,8 +188,8 @@ Chapter 1. Admin Guide
      * off - stores the value of the Path headers into usrloc without
        passing it back to the UAC in the reply.
      * lazy - stores the Path header and passes it back to the UAC if
-       Path-support is indicated by the "path" param in the Supported HF.
-     * strict - rejects the registration with "420 Bad Extension" if
+       Path-support is indicated by the “path� param in the Supported HF.
+     * strict - rejects the registration with “420 Bad Extension� if
        there's a Path header but no support for it is indicated by the
        UAC. Otherwise it's stored and passed back to the UAC.
 
@@ -201,8 +201,8 @@ Chapter 1. Admin Guide
    client's NAT).
 
    The whole process is transparent to the user, so no config changes are
-   required beside setting the registrar-parameters "use_path" and
-   "path_mode".
+   required beside setting the registrar-parameters “use_path� and
+   “path_mode�.
 
 2. Dependencies
 
@@ -249,7 +249,8 @@ Chapter 1. Admin Guide
    contact parameters, this value will be used for newly created usrloc
    records. The parameter contains number of second to expire (for example
    use 3600 for one hour). If it is set to a lower value than the
-   "min_expires" parameter then it will be ignored.
+   “min_expires� parameter then it will be ignored. This parameter can be
+   modified via ser config framework.
 
    Default value is 3600.
 
@@ -262,7 +263,7 @@ modparam("registrar", "default_expires", 1800)
 
    The minimum expires value of a Contact, values lower than this minimum
    will be automatically set to the minimum. Value 0 disables the
-   checking.
+   checking. This parameter can be modified via ser config framework.
 
    Default value is 60.
 
@@ -275,7 +276,7 @@ modparam("registrar", "min_expires", 60)
 
    The maximum expires value of a Contact, values higher than this maximum
    will be automatically set to the maximum. Value 0 disables the
-   checking.
+   checking. This parameter can be modified via ser config framework.
 
    Default value is 0.
 
@@ -289,7 +290,8 @@ modparam("registrar", "max_expires", 120)
    The parameter represents default q value for new contacts. Because
    Kamailio doesn't support float parameter types, the value in the
    parameter is divided by 1000 and stored as float. For example, if you
-   want default_q to be 0.38, use value 380 here.
+   want default_q to be 0.38, use value 380 here. This parameter can be
+   modified via ser config framework.
 
    Default value is 0.
 
@@ -305,7 +307,8 @@ modparam("registrar", "default_q", 1000)
    master domain can be defined for SIP purposes (like sip.mydomain.net
    pointing to same IP address as the SRV record for mydomain.net). By
    ignoring the realm_prefix "sip.", at registration, sip.mydomain.net
-   will be equivalent to mydomain.net .
+   will be equivalent to mydomain.net.This parameter can be modified via
+   ser config framework.
 
    Default value is NULL (none).
 
@@ -322,7 +325,8 @@ modparam("registrar", "realm_prefix", "sip.")
    highest-q rated contact and the rest will be appended to sip_msg
    structure and can be later used by tm for forking. If the parameter is
    set to 0, only Request-URI will be overwritten with the highest-q rated
-   contact and the rest will be left unprocessed.
+   contact and the rest will be left unprocessed. This parameter can be
+   modified via ser config framework.
 
    Default value is 1.
 
@@ -349,7 +353,8 @@ modparam("registrar", "aor_avp", "$avp(i:3223)")
 3.8. case_sensitive (integer)
 
    If set to 1 then AOR comparison will be case sensitive, if set to 0
-   then AOR comparison will be case insensitive--This is recommended.
+   then AOR comparison will be case insensitive--This is recommended.This
+   parameter can be modified via ser config framework.
 
    Default value is 0.
 
@@ -394,7 +399,7 @@ modparam("registrar", "received_param", "rcv")
 
    The parameter can be used to limit the number of contacts per AOR
    (Address of Record) in the user location database. Value 0 disables the
-   check.
+   check. This parameter can be modified via ser config framework.
 
    Default value is 0.
 
@@ -409,7 +414,8 @@ modparam("registrar", "max_contacts", 10)
    The registrar can generate 5xx reply to REGISTER in various situations.
    It can, for example, happen when the max_contacts parameter is set and
    the processing of REGISTER request would exceed the limit. In this case
-   the registrar would generate "503 Service Unavailable" response.
+   the registrar would generate "503 Service Unavailable" response. This
+   parameter can be modified via ser config framework.
 
    If you want to add the Retry-After header field in 5xx replies, set
    this parameter to a value grater than zero (0 means do not add the
@@ -466,8 +472,8 @@ modparam("registrar", "method_filtering", 1)
 
 3.16. use_path (integer)
 
-   If set to 1, the Path header is handled according to the parameter
-   "path_mode".
+   If set to 1, the Path header is handled according to the parameter This
+   parameter can be modified via ser config framework. “path_mode�.
 
    Default value is 0 (disabled).
 
@@ -484,12 +490,12 @@ modparam("registrar", "use_path", 1)
        the reply.
      * 1 - The Path header is saved into usrloc, but is only included in
        the reply if path support is indicated in the registration request
-       by the "path" option of the "Supported" header.
+       by the “path� option of the “Supported� header.
      * 2 - The path header is only saved into usrloc, if path support is
-       indicated in the registration request by the "path" option of the
-       "Supported" header. If no path support is indicated, the request is
-       rejected with "420 - Bad Extension" and the header "Unsupported:
-       path" is included in the reply along with the received "Path"
+       indicated in the registration request by the “path� option of the
+       “Supported� header. If no path support is indicated, the request is
+       rejected with “420 - Bad Extension� and the header “Unsupported:
+       path� is included in the reply along with the received “Path�
        header. This mode is the one recommended by RFC-3327.
 
    Default value is 2.
@@ -501,10 +507,10 @@ modparam("registrar", "path_mode", 0)
 
 3.18. path_use_received (integer)
 
-   If set to 1, the "received" parameter of the first Path URI of a
+   If set to 1, the “received� parameter of the first Path URI of a
    registration is set as received-uri and the NAT branch flag is set for
    this contact. This is useful if the registrar is placed behind a SIP
-   loadbalancer, which passes the nat'ed UAC address as "received"
+   loadbalancer, which passes the nat'ed UAC address as “received�
    parameter in it's Path uri.
 
    Default value is 0 (disabled).
@@ -652,7 +658,7 @@ if (registered("location")) {
 
 4.5.  add_sock_hdr(hdr_name)
 
-   Adds to the current REGISTER request a new header with "hdr_name" which
+   Adds to the current REGISTER request a new header with “hdr_name� which
    contains the description of the received socket (proto:ip:port)
 
    This make sens only in multiple replicated servers scenarios.
@@ -761,12 +767,12 @@ reg_free_contacts("callee");
 6.1. $ulc(profile=>attr)
 
    Access the attributes of contact addresses stored in 'profile'. It must
-   be used after a call of "reg_fetch_contacts()".
+   be used after a call of “reg_fetch_contacts()�.
 
-   The "profile" has to be one of the values used with
-   "reg_fetch_contacts()".
+   The “profile� has to be one of the values used with
+   “reg_fetch_contacts()�.
 
-   The "attr" can be:
+   The “attr� can be:
      * aor - address of record
      * domain - use location domain name
      * aorhash - hash id for the record
@@ -819,9 +825,9 @@ if(reg_fetch_contacts("location", "$fu", "caller"))
 
 Chapter 2. Frequently Asked Questions
 
-   2.1. What happend with the old "nat_flag" module parameter?
-   2.2. What happend with the old "use_domain" module parameter?
-   2.3. What happend with the old "save_noreply" and "save_memory"
+   2.1. What happend with the old “nat_flag� module parameter?
+   2.2. What happend with the old “use_domain� module parameter?
+   2.3. What happend with the old “save_noreply� and “save_memory�
           functions?
 
    2.4. Where can I find more about Kamailio?
@@ -831,60 +837,60 @@ Chapter 2. Frequently Asked Questions
 
    2.1.
 
-       What happend with the old "nat_flag" module parameter?
+   What happend with the old “nat_flag� module parameter?
 
-       In was removed, as the module internally loads this value from the
-       "USRLOC" module (see the "nat_bflag" USRLOC parameter).
+   In was removed, as the module internally loads this value from the
+   “USRLOC� module (see the “nat_bflag� USRLOC parameter).
 
    2.2.
 
-       What happend with the old "use_domain" module parameter?
+   What happend with the old “use_domain� module parameter?
 
-       In was removed, as the module internally loads this option from the
-       "USRLOC" module. This was done in order to simplify the configuration.
+   In was removed, as the module internally loads this option from the
+   “USRLOC� module. This was done in order to simplify the configuration.
 
    2.3.
 
-       What happend with the old "save_noreply" and "save_memory" functions?
+   What happend with the old “save_noreply� and “save_memory� functions?
 
-       There functions were merged into the new "save(domain,flags)"
-       functions. If a reply should be sent or if the DB should be updated
-       also is controlled via the flags.
+   There functions were merged into the new “save(domain,flags)�
+   functions. If a reply should be sent or if the DB should be updated
+   also is controlled via the flags.
 
    2.4.
 
-       Where can I find more about Kamailio?
+   Where can I find more about Kamailio?
 
-       Take a look at http://www.kamailio.org/.
+   Take a look at http://www.kamailio.org/.
 
    2.5.
 
-       Where can I post a question about this module?
+   Where can I post a question about this module?
 
-       First at all check if your question was already answered on one of our
-       mailing lists:
-         * User Mailing List -
-           http://lists.kamailio.org/cgi-bin/mailman/listinfo/users
-         * Developer Mailing List -
-           http://lists.kamailio.org/cgi-bin/mailman/listinfo/devel
+   First at all check if your question was already answered on one of our
+   mailing lists:
+     * User Mailing List -
+       http://lists.kamailio.org/cgi-bin/mailman/listinfo/users
+     * Developer Mailing List -
+       http://lists.kamailio.org/cgi-bin/mailman/listinfo/devel
 
-       E-mails regarding any stable Kamailio release should be sent to
-       <[email protected]> and e-mails regarding development versions
-       should be sent to <[email protected]>.
+   E-mails regarding any stable Kamailio release should be sent to
+   <[email protected]> and e-mails regarding development versions
+   should be sent to <[email protected]>.
 
-       If you want to keep the mail private, send it to
-       <[email protected]>.
+   If you want to keep the mail private, send it to
+   <[email protected]>.
 
    2.6.
 
-       How can I report a bug?
+   How can I report a bug?
 
-       Please follow the guidelines provided at:
-       http://sourceforge.net/tracker/?group_id=139143.
+   Please follow the guidelines provided at:
+   http://sourceforge.net/tracker/?group_id=139143.
 
    2.7.
 
-       What happened to the desc_time_order parameter?
+   What happened to the desc_time_order parameter?
 
-       It was removed, as its functionality was mmigrate into usrloc module,
-       were there is a parameter with the same name.
+   It was removed, as its functionality was mmigrate into usrloc module,
+   were there is a parameter with the same name.

modules_k/registrar/doc/registrar_admin.xml

@@ -117,7 +117,7 @@
 		will be used for newly created usrloc records. The parameter contains 
 		number of second to expire (for example use 3600 for one hour). If it
 		is set to a lower value than the <quote>min_expires</quote> parameter
-		then it will be ignored.		                                                
+		then it will be ignored. This parameter can be modified via ser config framework.
 		</para>
 		<para>
 		<emphasis>
@@ -138,7 +138,7 @@ modparam("registrar", "default_expires", 1800)
 		<para>
 		The minimum expires value of a Contact, values lower than this 
 		minimum will be automatically set to the minimum. Value 0 disables 
-		the checking.
+		the checking. This parameter can be modified via ser config framework.
 		</para>
 		<para>
 		<emphasis>
@@ -159,7 +159,7 @@ modparam("registrar", "min_expires", 60)
 		<para>
 		The maximum expires value of a Contact, values higher than this 
 		maximum will be automatically set to the maximum. Value 0 disables 
-		the checking.
+		the checking. This parameter can be modified via ser config framework.
 		</para>
 		<para>
 		<emphasis>
@@ -182,7 +182,7 @@ modparam("registrar", "max_expires", 120)
 		The parameter represents default q value for new contacts. Because 
 		&kamailio; doesn't support float parameter types, the value in the parameter 
 		is divided by 1000 and stored as float. For example, if you want 
-		default_q to be 0.38, use value 380 here.
+		default_q to be 0.38, use value 380 here. This parameter can be modified via ser config framework.
 		</para>
 		<para>
 		<emphasis>
@@ -207,7 +207,8 @@ modparam("registrar", "default_q", 1000)
 		 the master domain can be defined for SIP purposes (like 
 		 sip.mydomain.net pointing to same IP address as the SRV record for 
 		 mydomain.net). By ignoring the realm_prefix "sip.", at registration,
-		 sip.mydomain.net will be equivalent to mydomain.net .
+		 sip.mydomain.net will be equivalent to mydomain.net.This parameter 
+		 can be modified via ser config framework.
 		</para>
 		<para>
 		<emphasis>
@@ -235,6 +236,7 @@ modparam("registrar", "realm_prefix", "sip.")
 		appended to sip_msg structure and can be later used by tm for forking.
 		If the parameter is set to 0, only Request-URI will be overwritten 
 		with the highest-q rated contact and the rest will be left unprocessed.
+		This parameter can be modified via ser config framework.
 		</para>
 		<para>
 		<emphasis>
@@ -281,7 +283,7 @@ modparam("registrar", "aor_avp", "$avp(i:3223)")
 		<para>
 		If set to 1 then <acronym>AOR</acronym> comparison will be case 
 		sensitive, if set to 0 then <acronym>AOR</acronym> comparison will 
-		be case insensitive--This is recommended.
+		be case insensitive--This is recommended.This parameter can be modified via ser config framework.
 		</para>
 		<para>
 		<emphasis>
@@ -354,7 +356,7 @@ modparam("registrar", "received_param", "rcv")
 		<para>
 		The parameter can be used to limit the number of contacts per 
 		AOR (Address of Record) in the user location database. Value 0 
-		disables the check.
+		disables the check. This parameter can be modified via ser config framework.
 		</para>
 		<para>
 		<emphasis>
@@ -380,6 +382,7 @@ modparam("registrar", "max_contacts", 10)
 		<varname>max_contacts</varname> parameter is set and the
 		processing of REGISTER request would exceed the limit. In this case 
 		the registrar would generate "503 Service Unavailable" response.
+		This parameter can be modified via ser config framework.
 		</para>
 		<para>
 		If you want to add the Retry-After header field in 5xx replies, set 
@@ -478,6 +481,7 @@ modparam("registrar", "method_filtering", 1)
 		<title><varname>use_path</varname> (integer)</title>
 		<para>
 		If set to 1, the Path header is handled according to the parameter 
+		This parameter can be modified via ser config framework.
 		<quote>path_mode</quote>.
 		</para>
 		<para>