diff --git a/src/modules/avpops/README b/src/modules/avpops/README index 27ea1cb2858..c5db16a7fb8 100644 --- a/src/modules/avpops/README +++ b/src/modules/avpops/README @@ -599,7 +599,7 @@ avp_copy("$avp(old)","$avp(new)/gd"); Prints the formatted string 'format' in the AVP 'dest'. The 'format' parameter can include any pseudo-variable defined in Kamailio. The list with all pseudo-variables in Kamailio can be found at: - http://kamailio.org/dokuwiki/. + https://www.kamailio.org/wiki/ Meaning of the parameters is as follows: * dest - in which AVP should be stored the result. Parameter syntax diff --git a/src/modules/pv/README b/src/modules/pv/README index d30fea9c671..28550a113bb 100644 --- a/src/modules/pv/README +++ b/src/modules/pv/README @@ -74,7 +74,7 @@ Daniel-Constantin Mierla 1.15. pv_xavp_to_var() usage 1.16. pv_xavp_to_var() usage 1.17. pv.shvSet usage - 1.18. pv.shvSet usage + 1.18. pv.shvGet usage Chapter 1. Admin Guide @@ -116,8 +116,8 @@ Chapter 1. Admin Guide 1. Overview This module collects the core pseudo-variables that can be used in - configuration file. They are listed in Dokuwiki: - http://www.kamailio.org/wiki/, in Pseudo-Variables section + configuration file. They are listed in wiki: + https://www.kamailio.org/wiki/ in Pseudo-Variables section 2. Dependencies @@ -371,12 +371,14 @@ pv_xavp_print(); 4.11. pv_var_to_xavp(varname, xname) - Copy script variables values to a xavp. + Copy the script variable value into an xavp. First parameter can be '*' in order to copy all script variables. Second parameter is the name of the destination xavp. If xavp already exists it will be reset first. + Both parameters can contain variables that are evaluated at runtime. + Function can be used from ANY_ROUTE. Example 1.14. pv_var_to_xavp() usage @@ -395,7 +397,9 @@ $xavp("ok[0]=>foo") now is "foo indeed" 4.12. pv_xavp_to_var(xname) - Copy xavp values to vars. Reverse of pv_var_to_xavp(). + Copy xavp values into vars. Reverse of pv_var_to_xavp(). + + Both parameters can contain variables that are evaluated at runtime. Function can be used from ANY_ROUTE. @@ -457,7 +461,7 @@ $ kamcmd pv.shvSet debug int 3 If no name is given, all shared variables are listed. - Example 1.18. pv.shvSet usage + Example 1.18. pv.shvGet usage ... $ kamcmd pv.shvGet debug ... diff --git a/src/modules/sdpops/README b/src/modules/sdpops/README index 573e1fc68af..6e6fa7ff088 100644 --- a/src/modules/sdpops/README +++ b/src/modules/sdpops/README @@ -35,7 +35,7 @@ Daniel-Constantin Mierla 4.7. sdp_with_active_media(type) 4.8. sdp_remove_media(type) 4.9. sdp_with_transport(type) - 4.10. sdp_with_transport_like(string) + 4.10. sdp_with_transport_like(type) 4.11. sdp_transport(pv) 4.12. sdp_remove_transport(type) 4.13. sdp_with_codecs_by_id(list) @@ -90,7 +90,7 @@ Chapter 1. Admin Guide 4.7. sdp_with_active_media(type) 4.8. sdp_remove_media(type) 4.9. sdp_with_transport(type) - 4.10. sdp_with_transport_like(string) + 4.10. sdp_with_transport_like(type) 4.11. sdp_transport(pv) 4.12. sdp_remove_transport(type) 4.13. sdp_with_codecs_by_id(list) @@ -142,7 +142,7 @@ Chapter 1. Admin Guide 4.7. sdp_with_active_media(type) 4.8. sdp_remove_media(type) 4.9. sdp_with_transport(type) - 4.10. sdp_with_transport_like(string) + 4.10. sdp_with_transport_like(type) 4.11. sdp_transport(pv) 4.12. sdp_remove_transport(type) 4.13. sdp_with_codecs_by_id(list) @@ -329,26 +329,27 @@ sdp_remove_media("video"); 4.9. sdp_with_transport(type) Return true of the SDP has 'media=media port type ...' line. Useful to - check the transport of the RTP sessions, such as 'RTP/AVP', 'RTP/SAVP' - or 'RTP/SAVPF'. The parameter can be static string or variable holding - the transport type. + check the transport of the RTP sessions, such as 'RTP/AVP', 'RTP/SAVP', + 'RTP/SAVPF' or 'UDP/TLS/RTP/SAVPF'. The parameter can be static string + or variable holding the transport type. The function does an exact + match of the strings. This function can be used from ANY_ROUTE. Example 1.9. sdp_with_transport usage ... # check for RTP/SAVP stream -if(sdp_with_transport("RTP/SAVP")) +if(sdp_with_transport("UDP/TLS/RTP/SAVPF")) { - # the session has a SRTP/SAVP stream + # the session has a UDP/TLS/RTP/SAVPF stream } ... -4.10. sdp_with_transport_like(string) +4.10. sdp_with_transport_like(type) Returns true if the SDP has 'media=media port type ...' line, where - type contains string. The parameter can be static string or variable - holding a string. + type contains the string in the parameter. The parameter can be static + string or variable holding a string. This function can be used from ANY_ROUTE. diff --git a/src/modules/textops/README b/src/modules/textops/README index de571f5dabe..44aea97e1f0 100644 --- a/src/modules/textops/README +++ b/src/modules/textops/README @@ -992,7 +992,7 @@ if (starts_with("$rU", "+358")) The core will take care of the last boundary ending "--". Detecting wich one is the last and fixing the others if needed. - Note: it may be required that msg_apply_changes() from textops module + Note: it may be required that msg_apply_changes() from textopsx module has to be executed if there are other operations over the new body. Example 1.37. set_body_multipart usage diff --git a/src/modules/uac/README b/src/modules/uac/README index 3747d8c4dd8..c9a1dca942f 100644 --- a/src/modules/uac/README +++ b/src/modules/uac/README @@ -380,9 +380,8 @@ modparam("uac","credential","username:domain:password") This can be used if the realm upstream will be using is not known in advance. - If you define it, you also need to define “auth_username_avp” - (Section 3.10, “auth_username_avp (string)”) and “auth_username_avp” - (Section 3.11, “auth_password_avp (string)”). + If you define it, you also need to define “auth_username_avp” (???) and + “auth_username_avp” (???). Example 1.9. Set auth_realm_avp parameter ... @@ -394,9 +393,8 @@ modparam("uac","auth_realm_avp","$avp(i:10)") The definition of an AVP that might contain the username to be used to perform authentication. - If you define it, you also need to define “auth_realm_avp” - (Section 3.9, “auth_realm_avp (string)”) and “auth_username_avp” - (Section 3.11, “auth_password_avp (string)”). + If you define it, you also need to define “auth_realm_avp” (???) and + “auth_username_avp” (???). Example 1.10. Set auth_username_avp parameter ... @@ -408,9 +406,8 @@ modparam("uac","auth_username_avp","$avp(i:11)") The definition of an AVP that might contain the password to be used to perform authentication. - If you define it, you also need to define “auth_password_avp” - (Section 3.11, “auth_password_avp (string)”) and “auth_username_avp” - (Section 3.11, “auth_password_avp (string)”). + If you define it, you also need to define “auth_password_avp” (???) and + “auth_username_avp” (???). Example 1.11. Set auth_password_avp parameter ... @@ -419,7 +416,10 @@ modparam("uac","auth_password_avp","$avp(i:12)") 3.12. reg_db_url (string) - DB URL to fetch account profiles for registration. + DB URL to fetch account profiles for registration. This parameter must + be set in order to enable remote registrations feature. + + The default value is "" (no value). Example 1.12. Set reg_db_url parameter ... diff --git a/src/modules/xlog/README b/src/modules/xlog/README index 16361de462b..08422c3f339 100644 --- a/src/modules/xlog/README +++ b/src/modules/xlog/README @@ -129,7 +129,7 @@ Chapter 1. Admin Guide %{[$avp_alias[index]} The full list of available pseudo-variables in Kamailio is available - at: http://kamailio.org/wiki/ + at: https://www.kamailio.org/wiki/ 3. Dependencies