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

src/modules/cdp/README

@@ -52,13 +52,14 @@ Carsten Bock
 
         6. RPC Commands
 
-              6.1. cdp.disable_peer
-              6.2. cdp.enable_peer
+              6.1. States
+              6.2. cdp.disable_peer
+              6.3. cdp.enable_peer
+              6.4. cdp.list_peers
 
         7. Configuration Examples
 
               7.1. DiameterPeer.xml example
-              7.2.
 
    2. Developer Guide
 
@@ -147,8 +148,8 @@ Carsten Bock
    1.9. Set certificate parameter
    1.10. Set ca_list parameter
    1.11. cdp_check_peer usage
-   1.12. cdp_check_peer usage
-   1.13. cdp_check_peer usage
+   1.12. cdp_has_app usage
+   1.13. cdp_has_app usage
    1.14. DiameterPeer.xml example
 
 Chapter 1. Admin Guide
@@ -182,13 +183,14 @@ Chapter 1. Admin Guide
 
    6. RPC Commands
 
-        6.1. cdp.disable_peer
-        6.2. cdp.enable_peer
+        6.1. States
+        6.2. cdp.disable_peer
+        6.3. cdp.enable_peer
+        6.4. cdp.list_peers
 
    7. Configuration Examples
 
         7.1. DiameterPeer.xml example
-        7.2.
 
 1. Overview
 
@@ -422,7 +424,7 @@ if(!cdp_check_peer("hss.mnc001.mcc001.3gppnetwork.org")) {
      * vendorid - The Vendor ID of the App
        application - The Application ID
 
-   Example 1.12. cdp_check_peer usage
+   Example 1.12. cdp_has_app usage
 ...
 if(!cdp_has_app("10415", "4")) {
         send_reply("503", "Charging Server not ready");
@@ -430,7 +432,7 @@ if(!cdp_has_app("10415", "4")) {
 }
 ...
 
-   Example 1.13. cdp_check_peer usage
+   Example 1.13. cdp_has_app usage
 ...
 if(!cdp_has_app("16777216")) {
         send_reply("503", "Cx/Dx Interface not ready");
@@ -440,23 +442,43 @@ if(!cdp_has_app("16777216")) {
 
 6. RPC Commands
 
-   6.1. cdp.disable_peer
-   6.2. cdp.enable_peer
+   6.1. States
+   6.2. cdp.disable_peer
+   6.3. cdp.enable_peer
+   6.4. cdp.list_peers
 
-   exported RPC commands.
+6.1. States
 
-6.1. cdp.disable_peer
+     * Closed (0) - Not connected
+     * Wait_Conn_Ack (1) - Connecting - waiting for Ack
+     * Wait_I_CEA (2) - Connecting - waiting for Capabilities Exchange
+       Answer
+     * Wait_Conn_Ack_Elect (3) - Connecting - Acknowledged and going for
+       Election
+     * Wait_Returns (4) - Connecting - done
+     * R_Open (5) - Connected as receiver
+     * I_Open (6) - Connected as initiator
+     * Closing (7) - Closing the connection
+
+   Exported RPC commands.
+
+6.2. cdp.disable_peer
 
    instantly disable a particular diameter peer.
 
-6.2. cdp.enable_peer
+6.3. cdp.enable_peer
 
    enable/re-enable a diameter peer
 
+6.4. cdp.list_peers
+
+   list all configured diameter peers
+
+   State details can be found in the list above (Section 6.1, “States”)
+
 7. Configuration Examples
 
    7.1. DiameterPeer.xml example
-   7.2.
 
 7.1. DiameterPeer.xml example
 

src/modules/dialog/README

@@ -2211,6 +2211,7 @@ kamcmd dlg.list_ctx
        greater comparison; 'lt' - match using integer lesser comparison.
        Integer comparison can be used only with 'start_ts' key.
      * mval - matching value.
+     * limit (optional) - limit of matched dialogs.
 
    RPC Command Format:
 ...

src/modules/jansson/README

@@ -134,7 +134,7 @@ if(!jansson_get("inner.deep.list[3]", "$var(myjson)", "$var(n)")) {
 }
 xlog("L_INFO", "foo is $var(n)");
 ...
-jansson_get("test", "{\"test\":\"abc\",\"idx\":20}", "$var(n)")
+jansson_get("test", "{\"test\":\"abc\",\"idx\":20}", "$var(n)");
 ...
 
 3.2.  jansson_pv_get(key/path, srcvar, dst)

src/modules/jwt/README

@@ -75,7 +75,8 @@ Chapter 1. Admin Guide
    Kamailio configuration file.
 
    It relies on libjwt (at least v1.12.0) library
-   (https://github.com/benmcollins/libjwt).
+   (https://github.com/benmcollins/libjwt), but it is not working with the
+   new libjwt3.
 
 2. Dependencies
 
@@ -91,7 +92,7 @@ Chapter 1. Admin Guide
 
    The following libraries or applications must be installed before
    running Kamailio with this module loaded:
-     * libjwt - minimum version 1.12.0.
+     * libjwt - minimum version 1.12.0, but less than libjwt 3.0.
 
 3. Parameters
 

src/modules/stirshaken/README

@@ -556,3 +556,13 @@ reated)\n");
                 cd /path/to/kamailio/
                 make modules modules=src/modules/stirshaken/
 ...
+
+   To ensure proper functionality, the Kamailio stirshaken module requires
+   a minimum version of libstirshaken that includes the
+   stir_shaken_verify_cert_path function for performing the x509
+   certificate path check. This functionality was added to libstirshaken
+   around 2020
+   (https://github.com/signalwire/libstirshaken/commit/58e740b897ae40e2bb0
+   2ada2231a051a7eb55137). If you're using an older version of
+   libstirshaken that predates this commit, the stirshaken module may not
+   function correctly.

src/modules/tm/README

@@ -757,8 +757,12 @@ failure_route["serial"]
 
 3.1. fr_timer (integer)
 
-   Timer which hits if no final reply for a request or ACK for a negative
-   INVITE reply arrives (in milliseconds).
+   This timer is used for all SIP requests. It hits if no reply for an
+   request INVITE request or other request has been received within (F in
+   milliseconds). If a provisional reply is received for an INVITE (any
+   1xx), then the fr_inv_timer will be used instead. And if no replies (at
+   all) for an INVITE are received before fr_timer hits, the transaction
+   is terminated with a 408 in failure route.
 
    Default value is 30000 ms (30 seconds).
 

src/modules/userblocklist/README

@@ -154,9 +154,9 @@ Chapter 1. Admin Guide
    blocklisted or not.
 
    An additional functionality that this module provides is the ability to
-   handle global blocklists. This lists are loaded on startup into memory,
-   thus providing a better performance than the userblocklist case. These
-   global blocklists are useful to allow only calls to certain
+   handle global blocklists. These lists are loaded on startup into
+   memory, thus providing a better performance than the userblocklist
+   case. These global blocklists are useful to allow only calls to certain
    international destinations, i.e. block all not allowlisted numbers.
    They could also be used to prevent the blocklisting of important
    numbers, as allowlisting is supported too. This is useful for example