[sr-dev] git:master:43f6a02e: modules: readme files regenerated - auth_db ... [skip ci]

[Kamailio Dev]

Module: kamailio
Branch: master
Commit: 43f6a02e45658b734988919151af8e9990b71fb6
URL: https://github.com/kamailio/kamailio/commit/43f6a02e45658b734988919151af8e9990b71fb6

Author: Kamailio Dev <kamailio.dev at kamailio.org>
Committer: Kamailio Dev <kamailio.dev at kamailio.org>
Date: 2020-03-10T12:16:20+01:00

modules: readme files regenerated - auth_db ... [skip ci]

---

Modified: src/modules/auth_db/README

---

Diff:  https://github.com/kamailio/kamailio/commit/43f6a02e45658b734988919151af8e9990b71fb6.diff
Patch: https://github.com/kamailio/kamailio/commit/43f6a02e45658b734988919151af8e9990b71fb6.patch

---

diff --git a/src/modules/auth_db/README b/src/modules/auth_db/README
index 0896481c23..287f1517c5 100644
--- a/src/modules/auth_db/README
+++ b/src/modules/auth_db/README
@@ -50,6 +50,7 @@ Jan Janak
               3.7. use_domain (integer)
               3.8. load_credentials (string)
               3.9. version_table (integer)
+              3.10. force_generate_avps (integer)
 
         4. Functions
 
@@ -71,10 +72,11 @@ Jan Janak
    1.7. use_domain parameter usage
    1.8. load_credentials parameter usage
    1.9. version_table parameter usage
-   1.10. www_authorize usage
-   1.11. proxy_authorize usage
-   1.12. auth_check usage
-   1.13. is_subscriber usage
+   1.10. force_generate_avps parameter usage
+   1.11. www_authorize usage
+   1.12. proxy_authorize usage
+   1.13. auth_check usage
+   1.14. is_subscriber usage
 
 Chapter 1. Admin Guide
 
@@ -97,6 +99,7 @@ Chapter 1. Admin Guide
         3.7. use_domain (integer)
         3.8. load_credentials (string)
         3.9. version_table (integer)
+        3.10. force_generate_avps (integer)
 
    4. Functions
 
@@ -145,6 +148,7 @@ Chapter 1. Admin Guide
    3.7. use_domain (integer)
    3.8. load_credentials (string)
    3.9. version_table (integer)
+   3.10. force_generate_avps (integer)
 
 3.1. db_url (string)
 
@@ -297,6 +301,19 @@ modparam("auth_db", "load_credentials", "$avp(i:123)=rpid;email_address")
 modparam("auth_db", "version_table", 0)
 ...
 
+3.10. force_generate_avps (integer)
+
+   If set to different than 0, the module will fetch user DB attributes
+   even if authentication failed.
+
+   Default value is “0” (don't fetch user DB attributes if authentication
+   failed).
+
+   Example 1.10. force_generate_avps parameter usage
+...
+modparam("auth_db", "force_generate_avps", 1)
+...
+
 4. Functions
 
    4.1. www_authenticate(realm, table [, method])
@@ -348,7 +365,7 @@ modparam("auth_db", "version_table", 0)
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1.10. www_authorize usage
+   Example 1.11. www_authorize usage
 ...
 if (!www_authorize("kamailio.org", "subscriber")) {
         www_challenge("kamailio.org", "1");
@@ -388,7 +405,7 @@ if (!www_authorize("kamailio.org", "subscriber")) {
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1.11. proxy_authorize usage
+   Example 1.12. proxy_authorize usage
 ...
 if (!proxy_authorize("$fd", "subscriber)) {
         proxy_challenge("$fd", "1");  # Realm will be autogenerated
@@ -439,7 +456,7 @@ if (!proxy_authorize("$fd", "subscriber)) {
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1.12. auth_check usage
+   Example 1.13. auth_check usage
 ...
 if (!auth_check("$fd", "subscriber", "1")) {
     auth_challenge("$fd", "1");
@@ -472,7 +489,7 @@ if (!auth_check("$fd", "subscriber", "1")) {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.13. is_subscriber usage
+   Example 1.14. is_subscriber usage
 ...
 if (!is_subscriber("$ru", "subscriber", "3")) {
     # callee is not a local subscriber