[sr-dev] git:3.1: auth_db(k): note about empty realm parameter

[Daniel-Constantin Mierla]

Module: sip-router
Branch: 3.1
Commit: 0e691792a3c27150de7686aa04ddb9fea9129756
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=0e691792a3c27150de7686aa04ddb9fea9129756

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Sun Oct 24 23:03:59 2010 +0200

auth_db(k): note about empty realm parameter

- empty realm is no longer allowed, use $td of $fd if you have
  multi-domain
(cherry picked from commit bacb5704a05dafb345221095ff194a9181394b98)

---

 modules_k/auth_db/README                |   11 ++++++-----
 modules_k/auth_db/doc/auth_db_admin.xml |   15 ++++++++++-----
 2 files changed, 16 insertions(+), 10 deletions(-)

diff --git a/modules_k/auth_db/README b/modules_k/auth_db/README
index dc1cccf..cb6177c 100644
--- a/modules_k/auth_db/README
+++ b/modules_k/auth_db/README
@@ -305,11 +305,10 @@ modparam("auth_db", "load_credentials", "$avp(i:123)=rpid;email_address")
      * realm - Realm is a opaque string that the user agent should present
        to the user so he can decide what username and password to use.
        Usually this is domain of the host the server is running on.
-       If an empty string “” is used then the server will generate it from
-       the request. In case of REGISTER requests To header field domain
-       will be used (because this header field represents a user being
-       registered), for all other messages From header field domain will
-       be used.
+       It must not be empty string “”. In case of REGISTER requests To
+       header field domain (e.g., variable $td) can be used (because this
+       header field represents the user being registered), for all other
+       messages From header field domain can be used (e.g., variable $fd).
        The string may contain pseudo variables.
      * table - Table to be used to lookup usernames and passwords (usually
        subscribers table).
@@ -346,6 +345,8 @@ if (www_authorize("kamailio.org", "subscriber")) {
      * realm - Realm is a opaque string that the user agent should present
        to the user so he can decide what username and password to use.
        Usually this is domain of the host the server is running on.
+       It must not be empty string “”. Apart of a static strinh, typical
+       value is From header field domain (e.g., variable $fd).
        If an empty string “” is used then the server will generate it from
        the request. From header field domain will be used as realm.
        The string may contain pseudo variables.
diff --git a/modules_k/auth_db/doc/auth_db_admin.xml b/modules_k/auth_db/doc/auth_db_admin.xml
index b6e1d14..f00e5ca 100644
--- a/modules_k/auth_db/doc/auth_db_admin.xml
+++ b/modules_k/auth_db/doc/auth_db_admin.xml
@@ -324,11 +324,11 @@ modparam("auth_db", "load_credentials", "$avp(i:123)=rpid;email_address")
 			the server is running on.
 			</para>
 			<para>
-			If an empty string <quote></quote> is used then the server will 
-			generate it from the request. In case of REGISTER requests To 
-			header field domain will be used (because this header field 
-			represents a user being registered), for all other messages From 
-			header field domain will be used.
+			It must not be empty string <quote></quote>. In case of REGISTER
+			requests To header field domain (e.g., variable $td) can be used
+			(because this header field represents the user being registered),
+			for all other messages From header field domain can be used
+			(e.g., variable $fd).
 			</para>
 			<para>
 			The string may contain pseudo variables.
@@ -395,6 +395,11 @@ if (www_authorize("kamailio.org", "subscriber")) {
 			the server is running on.
 			</para>
 			<para>
+			It must not be empty string <quote></quote>. Apart of a static
+			strinh, typical value is From header field domain
+			(e.g., variable $fd).
+			</para>
+			<para>
 			If an empty string <quote></quote> is used then the server will 
 			generate it from the request. From header field domain will be 
 			used as realm.