[sr-dev] git:master:5064ffc6: modules: readme files regenerated - secsipid ... [skip ci]

[Kamailio Dev]

Module: kamailio
Branch: master
Commit: 5064ffc6490ed9db3f92a171e6b950fd0e8056e6
URL: https://github.com/kamailio/kamailio/commit/5064ffc6490ed9db3f92a171e6b950fd0e8056e6

Author: Kamailio Dev <kamailio.dev at kamailio.org>
Committer: Kamailio Dev <kamailio.dev at kamailio.org>
Date: 2021-02-15T08:46:22+01:00

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

---

Modified: src/modules/secsipid/README

---

Diff:  https://github.com/kamailio/kamailio/commit/5064ffc6490ed9db3f92a171e6b950fd0e8056e6.diff
Patch: https://github.com/kamailio/kamailio/commit/5064ffc6490ed9db3f92a171e6b950fd0e8056e6.patch

---

diff --git a/src/modules/secsipid/README b/src/modules/secsipid/README
index c125b689d6..87ed1f9287 100644
--- a/src/modules/secsipid/README
+++ b/src/modules/secsipid/README
@@ -30,6 +30,7 @@ Daniel-Constantin Mierla
               3.2. timeout (int)
               3.3. cache_dir (str)
               3.4. cache_expire (int)
+              3.5. modproc (str)
 
         4. Functions
 
@@ -47,11 +48,12 @@ Daniel-Constantin Mierla
    1.2. Set timeout parameter
    1.3. Set cache_dir parameter
    1.4. Set cache_expire parameter
-   1.5. secsipid_check_identity usage
-   1.6. secsipid_check_identity_pubkey usage
-   1.7. secsipid_get_url usage
-   1.8. secsipid_add_identity usage
-   1.9. Libsecsipid usage
+   1.5. Set modproc parameter
+   1.6. secsipid_check_identity usage
+   1.7. secsipid_check_identity_pubkey usage
+   1.8. secsipid_get_url usage
+   1.9. secsipid_add_identity usage
+   1.10. Libsecsipid usage
 
 Chapter 1. Admin Guide
 
@@ -69,6 +71,7 @@ Chapter 1. Admin Guide
         3.2. timeout (int)
         3.3. cache_dir (str)
         3.4. cache_expire (int)
+        3.5. modproc (str)
 
    4. Functions
 
@@ -89,6 +92,11 @@ Chapter 1. Admin Guide
 
    It exports the functions to check and generate SIP Identity header.
 
+   Note that this module needs "secsipid_proc.so" module to be installed,
+   but without loading the "secsipid_proc.so" via "loadmodule". This
+   module loads "secsipid_proc.so" in child init callback in order to
+   initialize the "libsecsipid" per child process.
+
 2. Dependencies
 
    2.1. Kamailio Modules
@@ -96,14 +104,15 @@ Chapter 1. Admin Guide
 
 2.1. Kamailio Modules
 
-   The following modules must be loaded before this module:
-     * No dependencies on other Kamailio modules.
+   The following modules must be installed (but not loaded) to use this
+   module:
+     * secsipid_proc.
 
 2.2. External Libraries or Applications
 
    The following libraries or applications must be installed before
    running Kamailio with this module loaded:
-     * libsecsipid - https://github.com/asipto/secsipidx/.
+     * none.
 
 3. Parameters
 
@@ -111,6 +120,7 @@ Chapter 1. Admin Guide
    3.2. timeout (int)
    3.3. cache_dir (str)
    3.4. cache_expire (int)
+   3.5. modproc (str)
 
 3.1. expire (int)
 
@@ -160,6 +170,17 @@ modparam("secsipid", "cache_dir", "/tmp/kamailio/secsipid")
 modparam("secsipid", "cache_expire", 7200)
 ...
 
+3.5. modproc (str)
+
+   The name of or the path to the required per-process API module.
+
+   Default value is "secsipid_proc.so".
+
+   Example 1.5. Set modproc parameter
+...
+modparam("secsipid", "modproc", "secsipid_proc2.so")
+...
+
 4. Functions
 
    4.1. secsipid_check_identity(keyPath)
@@ -181,7 +202,7 @@ modparam("secsipid", "cache_expire", 7200)
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.5. secsipid_check_identity usage
+   Example 1.6. secsipid_check_identity usage
 ...
 request_route {
     ...
@@ -205,7 +226,7 @@ request_route {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.6. secsipid_check_identity_pubkey usage
+   Example 1.7. secsipid_check_identity_pubkey usage
 ...
 request_route {
   ...
@@ -226,7 +247,7 @@ request_route {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.7. secsipid_get_url usage
+   Example 1.8. secsipid_get_url usage
 ...
 request_route {
   ...
@@ -250,7 +271,7 @@ request_route {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.8. secsipid_add_identity usage
+   Example 1.9. secsipid_add_identity usage
 ...
 request_route {
     ...
@@ -274,7 +295,7 @@ request_route {
    installed and its environment configured, then run the following
    commands:
 
-   Example 1.9. Libsecsipid usage
+   Example 1.10. Libsecsipid usage
 ...
 go get https://github.com/asipto/secsipidx
 cd $GOPATH/src/github.com/asipto/secsipidx/csecsipid/