Browse code

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

Kamailio Dev authored on 22/10/2021 12:32:49
Showing 7 changed files
... ...
@@ -496,7 +496,7 @@ modparam("http_client", "keep_connections", 1)
496 496
 
497 497
    Valid values are:
498 498
      * 0 - Return the entire HTTP result body
499
-     * 1 - Return the first oine from HTTP result body
499
+     * 1 - Return the first line from HTTP result body
500 500
 
501 501
    Default value: 1 (return first line).
502 502
 
... ...
@@ -158,8 +158,8 @@ Chapter 1. Admin Guide
158 158
 
159 159
 3.1. shvset (string)
160 160
 
161
-   Set the value of a shared variable ($shv(name)). The parameter can be
162
-   set many times.
161
+   Set the initial value of a shared variable ($shv(name)). The parameter
162
+   can be set many times.
163 163
 
164 164
    The value of the parameter has the format: _name_ '=' _type_ ':'
165 165
    _value_
... ...
@@ -169,6 +169,10 @@ Chapter 1. Admin Guide
169 169
           + “s”: string value
170 170
      * _value_: value to be set
171 171
 
172
+   Note: this is special useful for usage with KEMI scripts, the $shv(...)
173
+   variables must be defined during Kamailio initialization in order to
174
+   become available in all worker processes.
175
+
172 176
    Default value is “NULL”.
173 177
 
174 178
    Example 1.1. shvset parameter usage
... ...
@@ -515,9 +515,9 @@ record_route_advertised_address("1.2.3.4:5080");
515 515
 
516 516
    Adds a parameter to the Record-Route URI (param must be in
517 517
    “;name=value” format. The function may be called also before or after
518
-   the record_route() or record_route_advertised_address() calls (see
519
-   Section 5.2, “record_route([sparams])” or Section 5.5,
520
-   “record_route_advertised_address(address)”)).
518
+   the record_route(), record_route_advertised_address(), and
519
+   record_route_preset() calls (see Section 5.2, “record_route([sparams])”
520
+   or Section 5.5, “record_route_advertised_address(address)”)).
521 521
 
522 522
    Meaning of the parameters is as follows:
523 523
      * param - String containing the URI parameter to be added. It must
... ...
@@ -223,7 +223,7 @@ if(fnmatch("$rU", "123*"))
223 223
    Meaning of the parameters is as follows:
224 224
      * hf - Header field to be appended. Format: HFNAME [ [IDX] ]. If
225 225
        index is not specified new header is inserted at the end of
226
-       message.
226
+       message. The index 1 correxponds to the first header.
227 227
      * hvalue - Value to be added, config var formatting supported.
228 228
 
229 229
    Example 1.6. append_hf_value usage
... ...
@@ -244,7 +244,7 @@ ot exists add new header
244 244
    Meaning of the parameters is as follows:
245 245
      * hf - Header field to be appended. Format: HFNAME [ [IDX] ]. If
246 246
        index is not specified new header is inserted at the top of
247
-       message.
247
+       message. The index 1 correxponds to the first header.
248 248
      * hvalue - Value to be added, config var formatting supported.
249 249
 
250 250
    Example 1.7. insert_hf_value usage
... ...
@@ -262,7 +262,7 @@ insert_hf_value("foo[1]", "gogo") # try add to the first header
262 262
    Meaning of the parameters is as follows:
263 263
      * hf_par - Header field/param to be removed. Format: HFNAME [ [IDX] ]
264 264
        [. PARAM ] If asterisk is specified as index then all values are
265
-       affected.
265
+       affected. The index 1 correxponds to the first header.
266 266
 
267 267
    Example 1.8. remove_hf_value usage
268 268
 ...
... ...
@@ -282,7 +282,7 @@ remove_hf_value("foo[*].bar") # for each foo delete bar parameters
282 282
    Meaning of the parameters is as follows:
283 283
      * hf_par - Header/param to be removed. Format: HFNAME [ [IDX] ] [.
284 284
        PARAM ] If asterisk is specified as index then all values are
285
-       affected.
285
+       affected. The index 1 correxponds to the first header.
286 286
 
287 287
    Example 1.9. remove_hf_value2 usage
288 288
 ...
... ...
@@ -301,7 +301,7 @@ remove_hf_value2("foo[*].bar") # for each foo delete bar parameters
301 301
    Meaning of the parameters is as follows:
302 302
      * hf_para - Header field value / param to be appended. Format: HFNAME
303 303
        [ [IDX] ] [. PARAM] If asterisk is specified as index then all
304
-       values are affected.
304
+       values are affected. The index 1 correxponds to the first header.
305 305
      * hvalue - Value to be assigned, config var formatting supported. If
306 306
        value is empty then no equal sign appears in param.
307 307
 
... ...
@@ -325,7 +325,7 @@ assign_hf_value("foo[*].bar", "")  # set empty value (ex. lr)
325 325
    Meaning of the parameters is as follows:
326 326
      * hf_para - Header field value / param to be appended. Format: HFNAME
327 327
        [ [IDX] ] [. PARAM] If asterisk is specified as index then all
328
-       values are affected.
328
+       values are affected. The index 1 correxponds to the first header.
329 329
      * hvalue - Value to be assigned, config var formatting supported. If
330 330
        value is empty then no equal sign appears in param.
331 331
 
... ...
@@ -539,17 +539,17 @@ Revoking a certificate and using a CRL
539 539
    require the certificate file and list of CA certificates per a regular
540 540
    TLS configuration.
541 541
 
542
-AWS CloudHSM Example
542
+Thales Luna Example
543 543
 --------------------
544 544
 
545 545
 ...
546
-# Example for AWS CloudHSM (SafeNet Luna)
546
+# Example for Thales Luna
547 547
 modparam("tls", "engine", "gem")
548
-modparam("tls", "engine_config", "/usr/local/etc/kamailio/luna.conf")
549
-modparam("tls", "engine_algorithms", "ALL)
548
+modparam("tls", "engine_config", "/usr/local/etc/kamailio/thales.cnf")
549
+modparam("tls", "engine_algorithms", "EC")
550 550
 ...
551 551
 
552
-/usr/local/etc/kamailio/luna.cnf is a OpenSSL config format file used to
552
+/usr/local/etc/kamailio/thales.cnf is a OpenSSL config format file used to
553 553
 bootstrap the engine, e.g., pass the PIN.
554 554
 
555 555
 ...
... ...
@@ -560,11 +560,12 @@ kamailio = openssl_init
560 560
 engines = engine_section
561 561
 
562 562
 [ engine_section ]
563
-# gem is the name of the SafeNet Luna OpenSSL engine
563
+# gem is the name of the Thales Luna OpenSSL engine
564 564
 gem = gem_section
565 565
 
566 566
 [ gem_section ]
567
-# from SafeNet documentation
567
+# from Thales documentation
568
+dynamic_path = /usr/lib64/engines-1.1/gem.so
568 569
 ENGINE_INIT = 0:20:21:password=1234-ABCD-5678-EFGH
569 570
 ...
570 571
 
... ...
@@ -162,6 +162,8 @@ Chapter 1. Admin Guide
162 162
 
163 163
    Example 1.1. event_route[xhttp:request]
164 164
 ...
165
+tcp_accept_no_cl=yes
166
+...
165 167
 loadmodule "sl.so"
166 168
 loadmodule "xhttp.so"
167 169
 loadmodule "msrp.so"  # Only required if using MSRP over WebSockets
... ...
@@ -220,6 +220,11 @@ event_route[xhttp:request] {
220 220
 
221 221
    The event route is executed when a new HTTP request is received.
222 222
 ...
223
+tcp_accept_no_cl=yes
224
+...
225
+loadmodule "sl.so"
226
+loadmodule "xhttp.so
227
+...
223 228
 event_route[xhttp:request] {
224 229
     xhttp_reply("200", "OK", "text/html",
225 230
         "<html><body>OK - [$si:$sp]</body></html>");