From 0f6c984feb31f316faaf89d4e83d172fc9c0fc4f Mon Sep 17 00:00:00 2001 From: Kamailio Dev Date: Fri, 30 Mar 2018 21:48:36 +0200 Subject: [PATCH] modules: readme files regenerated - acc ... [skip ci] --- src/modules/acc/README | 4 +- src/modules/app_perl/README | 4 +- src/modules/cdp/README | 4 +- src/modules/cdp_avp/README | 4 +- src/modules/db_text/README | 11 +-- src/modules/dialog/README | 4 +- src/modules/dispatcher/README | 4 +- src/modules/ims_dialog/README | 4 +- src/modules/ims_registrar_scscf/README | 4 +- src/modules/ims_usrloc_pcscf/README | 4 +- src/modules/nathelper/README | 4 +- src/modules/pua_json/README | 101 +++++++++++++++++++++++++ src/modules/registrar/README | 4 +- src/modules/rtpengine/README | 4 +- src/modules/rtpproxy/README | 4 +- src/modules/snmpstats/README | 4 +- 16 files changed, 132 insertions(+), 36 deletions(-) diff --git a/src/modules/acc/README b/src/modules/acc/README index 272b8f1f6a4..3cf1edea655 100644 --- a/src/modules/acc/README +++ b/src/modules/acc/README @@ -1507,8 +1507,8 @@ Chapter 2. Frequently Asked Questions and e-mails regarding development versions should be sent to . - If you want to keep the mail private, send it to - . + If you want to keep the e-mail private (e.g. for security issues) send + it to . 2.6. diff --git a/src/modules/app_perl/README b/src/modules/app_perl/README index 6a18764e473..e12b8c118de 100644 --- a/src/modules/app_perl/README +++ b/src/modules/app_perl/README @@ -1686,8 +1686,8 @@ Chapter 4. Frequently Asked Questions and e-mails regarding development versions should be sent to . - If you want to keep the mail private, send it to - . + If you want to keep the e-mail private (e.g. for security issues) send + it to . 4.4. diff --git a/src/modules/cdp/README b/src/modules/cdp/README index 9681c0bd3fa..5cca61b5989 100644 --- a/src/modules/cdp/README +++ b/src/modules/cdp/README @@ -945,8 +945,8 @@ Chapter 3. Frequently Asked Questions and e-mails regarding development versions should be sent to . - If you want to keep the mail private, send it to - . + If you want to keep the e-mail private (e.g. for security issues) send + it to . 3.3. diff --git a/src/modules/cdp_avp/README b/src/modules/cdp_avp/README index 425b6e5b684..03fef53101f 100644 --- a/src/modules/cdp_avp/README +++ b/src/modules/cdp_avp/README @@ -1677,8 +1677,8 @@ Chapter 3. Frequently Asked Questions and e-mails regarding development versions should be sent to . - If you want to keep the mail private, send it to - . + If you want to keep the e-mail private (e.g. for security issues) send + it to . 3.3. diff --git a/src/modules/db_text/README b/src/modules/db_text/README index 20ad584e4b2..61b524c4e25 100644 --- a/src/modules/db_text/README +++ b/src/modules/db_text/README @@ -373,14 +373,13 @@ aliases:6 Example 1.13. Configuration file ... # -# $Id$ # # simple quick-start config script with dbtext # # ----------- global configuration parameters ------------------------ -#debug=9 # debug level (cmd line: -dddddddddd) +#debug=3 # debug level (cmd line: -ddd) #fork=yes #log_stderror=no # (cmd line: -E) @@ -404,7 +403,7 @@ loadmodule "modules/maxfwd/maxfwd.so" loadmodule "modules/usrloc/usrloc.so" loadmodule "modules/registrar/registrar.so" loadmodule "modules/textops/textops.so" -loadmodule "modules/textops/mi_fifo.so" +loadmodule "modules/jonrpcs/jsonrpcs.so" # modules for digest authentication loadmodule "modules/auth/auth.so" @@ -412,15 +411,11 @@ loadmodule "modules/auth_db/auth_db.so" # ----------------- setting module-specific parameters --------------- -# -- mi_fifo params -- - -modparam("mi_fifo", "fifo_name", "/tmp/openser_fifo") - # -- usrloc params -- # use dbtext database for persistent storage modparam("usrloc", "db_mode", 2) -modparam("usrloc|auth_db", "db_url", "dbtext:///tmp/openserdb") +modparam("usrloc|auth_db", "db_url", "db_text:///tmp/kamailiodb") # -- auth params -- # diff --git a/src/modules/dialog/README b/src/modules/dialog/README index 47b76d369c1..b607591b96f 100644 --- a/src/modules/dialog/README +++ b/src/modules/dialog/README @@ -2101,8 +2101,8 @@ Chapter 3. Frequently Asked Questions and e-mails regarding development versions should be sent to . - If you want to keep the mail private, send it to - . + If you want to keep the e-mail private (e.g. for security issues) send + it to . 3.4. diff --git a/src/modules/dispatcher/README b/src/modules/dispatcher/README index b23140607a9..a58cb415177 100644 --- a/src/modules/dispatcher/README +++ b/src/modules/dispatcher/README @@ -1749,8 +1749,8 @@ Chapter 2. Frequently Asked Questions and e-mail regarding development versions or GIT snapshots should be send to . - If you want to keep the mail private, send it to - . + If you want to keep the e-mail private (e.g. for security issues) send + it to . 2.5. diff --git a/src/modules/ims_dialog/README b/src/modules/ims_dialog/README index 40f9dd9bd5b..45508a31370 100644 --- a/src/modules/ims_dialog/README +++ b/src/modules/ims_dialog/README @@ -1090,8 +1090,8 @@ Chapter 3. Frequently Asked Questions and e-mails regarding development versions should be sent to . - If you want to keep the mail private, send it to - . + If you want to keep the e-mail private (e.g. for security issues) send + it to . 3.5. diff --git a/src/modules/ims_registrar_scscf/README b/src/modules/ims_registrar_scscf/README index b55e9e6f60b..5ffd025d781 100644 --- a/src/modules/ims_registrar_scscf/README +++ b/src/modules/ims_registrar_scscf/README @@ -829,8 +829,8 @@ Chapter 2. Frequently Asked Questions and e-mails regarding development versions should be sent to . - If you want to keep the mail private, send it to - . + If you want to keep the e-mail private (e.g. for security issues) send + it to . 2.3. diff --git a/src/modules/ims_usrloc_pcscf/README b/src/modules/ims_usrloc_pcscf/README index 2ceaed80f20..35c6b1f68df 100644 --- a/src/modules/ims_usrloc_pcscf/README +++ b/src/modules/ims_usrloc_pcscf/README @@ -253,8 +253,8 @@ Chapter 2. Frequently Asked Questions and e-mails regarding development versions should be sent to . - If you want to keep the mail private, send it to - . + If you want to keep the e-mail private (e.g. for security issues) send + it to . 2.3. diff --git a/src/modules/nathelper/README b/src/modules/nathelper/README index e70d537311a..0f0d262806f 100644 --- a/src/modules/nathelper/README +++ b/src/modules/nathelper/README @@ -784,8 +784,8 @@ Chapter 2. Frequently Asked Questions and e-mails regarding development versions should be sent to . - If you want to keep the mail private, send it to - . + If you want to keep the e-mail private (e.g. for security issues) send + it to . 2.4. diff --git a/src/modules/pua_json/README b/src/modules/pua_json/README index e69de29bb2d..51f5bcc245f 100644 --- a/src/modules/pua_json/README +++ b/src/modules/pua_json/README @@ -0,0 +1,101 @@ +PUA_JSON Module + +Emmanuel Schmidbauer + + + +Edited by + +Emmanuel Schmidbauer + + + + Copyright © 2018 VoIPxSWITCH + __________________________________________________________________ + + Table of Contents + + 1. Admin Guide + + 1. Overview + 2. How it works + 3. Dependencies + + 3.1. Kamailio Modules + 3.2. External Libraries or Applications + + 4. Functions + + 4.1. pua_json_publish(json_payload) + + List of Examples + + 1.1. pua_json_publish usage + +Chapter 1. Admin Guide + + Table of Contents + + 1. Overview + 2. How it works + 3. Dependencies + + 3.1. Kamailio Modules + 3.2. External Libraries or Applications + + 4. Functions + + 4.1. pua_json_publish(json_payload) + +1. Overview + + The PUA_JSON module adds support to publish updates to the presence + module through the pua_json_publish() function. + + From a high-level perspective, the module may be used for: + * Providing a real-time presence updates. + +2. How it works + + The module parses json data objects and inserts them into the + presentity table for real-time presence updates. + +3. Dependencies + + 3.1. Kamailio Modules + 3.2. External Libraries or Applications + +3.1. Kamailio Modules + + The following modules must be loaded before this module: + * none. + +3.2. External Libraries or Applications + + The following libraries or applications must be installed + * libjson. + +4. Functions + + 4.1. pua_json_publish(json_payload) + +4.1. pua_json_publish(json_payload) + + The function build presentity state from json_payload and updates + presentity table. + + Usage: presence related. + + This function can be used from ANY ROUTE. + + Example 1.1. pua_json_publish usage +... +event_route[xhttp:request] { + $var(call-id) = $(rb{json.parse,Call-ID}); + if ($(rb{json.parse,Event-Package}) == "dialog") { + xlog("L_INFO", "$var(call-id)|log|received $(rb{json.parse,Event +-Package}) update for $(rb{json.parse,From})"); + pua_json_publish($rb); + } +} +... diff --git a/src/modules/registrar/README b/src/modules/registrar/README index 1b417a80cf6..85b859f5c2d 100644 --- a/src/modules/registrar/README +++ b/src/modules/registrar/README @@ -1232,8 +1232,8 @@ Chapter 2. Frequently Asked Questions and e-mails regarding development versions should be sent to . - If you want to keep the mail private, send it to - . + If you want to keep the e-mail private (e.g. for security issues) send + it to . 2.6. diff --git a/src/modules/rtpengine/README b/src/modules/rtpengine/README index de8b4ced084..263f2dad96f 100644 --- a/src/modules/rtpengine/README +++ b/src/modules/rtpengine/README @@ -2343,8 +2343,8 @@ nnection ICE=force RTP/SAVPF"); and e-mails regarding development versions should be sent to . - If you want to keep the mail private, send it to - . + If you want to keep the e-mail private (e.g. for security issues) send + it to . 2.4. diff --git a/src/modules/rtpproxy/README b/src/modules/rtpproxy/README index 6afefd21878..3de372544c1 100644 --- a/src/modules/rtpproxy/README +++ b/src/modules/rtpproxy/README @@ -828,8 +828,8 @@ Chapter 2. Frequently Asked Questions and e-mails regarding development versions should be sent to . - If you want to keep the mail private, send it to - . + If you want to keep the e-mail private (e.g. for security issues) send + it to . 2.4. diff --git a/src/modules/snmpstats/README b/src/modules/snmpstats/README index b6fead7914c..ab2add4b30a 100644 --- a/src/modules/snmpstats/README +++ b/src/modules/snmpstats/README @@ -788,8 +788,8 @@ Name and e-mails regarding development versions should be sent to . - If you want to keep the mail private, send it to - . + If you want to keep the e-mail private (e.g. for security issues) send + it to . 2.12.