Browse code

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

Kamailio Dev authored on 28/09/2022 11:01:21
Showing 1 changed files
... ...
@@ -33,6 +33,9 @@ Mojtaba Esfandiari.S
33 33
                     4.3.7. hash_table_size (integer)
34 34
                     4.3.8. custom_sdp_ip_avp (string)
35 35
                     4.3.9. gt (integer)
36
+                    4.3.10. behind_nat (integer)
37
+                    4.3.11. start_port (integer)
38
+                    4.3.12. end_port (integer)
36 39
 
37 40
               4.4. Functions
38 41
 
... ...
@@ -50,8 +53,11 @@ Mojtaba Esfandiari.S
50 53
    1.7. Set hash_table_size parameter
51 54
    1.8. Set custom_sdp_ip_avp parameter
52 55
    1.9. Set gt parameter
53
-   1.10. set_lrkproxy_set usage
54
-   1.11. lrkproxy_manage usage
56
+   1.10. Set behind_nat parameter
57
+   1.11. Set start_port parameter
58
+   1.12. Set start_port parameter
59
+   1.13. set_lrkproxy_set usage
60
+   1.14. lrkproxy_manage usage
55 61
 
56 62
 Chapter 1. Admin Guide
57 63
 
... ...
@@ -79,6 +85,9 @@ Chapter 1. Admin Guide
79 85
               4.3.7. hash_table_size (integer)
80 86
               4.3.8. custom_sdp_ip_avp (string)
81 87
               4.3.9. gt (integer)
88
+              4.3.10. behind_nat (integer)
89
+              4.3.11. start_port (integer)
90
+              4.3.12. end_port (integer)
82 91
 
83 92
         4.4. Functions
84 93
 
... ...
@@ -88,7 +97,7 @@ Chapter 1. Admin Guide
88 97
 1. Overview
89 98
 
90 99
    This is a module that enables media streams to be relayed via
91
-   pylrkproxy engine. This engine can be found at:
100
+   pylrkproxy engine that exist in:
92 101
    https://github.com/mojtabaesfandiari/pylrkproxy It does relaying audio
93 102
    streams between peers in PREROUTING netfilter-hooking section in
94 103
    kernel-space linux. The LRKProxy architecture is composed of two
... ...
@@ -133,7 +142,7 @@ Chapter 1. Admin Guide
133 142
 
134 143
    IMPORTANT: This module does not support balancing inside a set like as
135 144
    is done RTPProxy module based on the weight of each rtpproxy from the
136
-   set. The balancing would be run on different machine.
145
+   set. The balancing would be run on different machine
137 146
 
138 147
 4. Dependencies
139 148
 
... ...
@@ -150,6 +159,9 @@ Chapter 1. Admin Guide
150 159
         4.3.7. hash_table_size (integer)
151 160
         4.3.8. custom_sdp_ip_avp (string)
152 161
         4.3.9. gt (integer)
162
+        4.3.10. behind_nat (integer)
163
+        4.3.11. start_port (integer)
164
+        4.3.12. end_port (integer)
153 165
 
154 166
    4.4. Functions
155 167
 
... ...
@@ -310,6 +322,47 @@ _ip_avp", "$avp(RR_CUSTOM_SDP_IP_AVP)")
310 322
                                                 modparam("lrkproxy", "gt", "1")
311 323
                                                 ...
312 324
 
325
+4.3.10. behind_nat (integer)
326
+
327
+   The behind_nat is used when the LRKProxy is behind NAT firewall and the
328
+   external IP should be as Advertised IP. It could be set 0:disable or
329
+   1:enable. If you use AWS for LRKProxy, you might should set behind_nat
330
+   option.
331
+
332
+   Default value is “0”.
333
+
334
+   Example 1.10. Set behind_nat parameter
335
+                                                ...
336
+                                                modparam("lrkproxy", "behind_nat
337
+", "1")
338
+                                                ...
339
+
340
+4.3.11. start_port (integer)
341
+
342
+   This option use for local rang port for working with LRKProxy engine.
343
+   Default value is based on LRKProxy engine option. For example if the
344
+   range of ports in LRKProxy is set from 20000 to 30000, You could use
345
+   this option to set a subset of the LRKProxy range.
346
+
347
+   Example 1.11. Set start_port parameter
348
+                                                ...
349
+                                                modparam("lrkproxy", "start_port
350
+", "25000")
351
+                                                ...
352
+
353
+4.3.12. end_port (integer)
354
+
355
+   This option use for local rang port for working with LRKProxy engine.
356
+   Default value is based on LRKProxy engine option. For example if the
357
+   range of ports in LRKProxy is set from 20000 to 30000, You could use
358
+   this option to set a subset of the LRKProxy range.
359
+
360
+   Example 1.12. Set start_port parameter
361
+                                                ...
362
+                                                modparam("lrkproxy", "end_port",
363
+ "28000")
364
+                                                ...
365
+
313 366
 4.4. Functions
314 367
 
315 368
 4.4.1.  set_lrkproxy_set(setid)
... ...
@@ -321,7 +374,7 @@ _ip_avp", "$avp(RR_CUSTOM_SDP_IP_AVP)")
321 374
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
322 375
    BRANCH_ROUTE.
323 376
 
324
-   Example 1.10. set_lrkproxy_set usage
377
+   Example 1.13. set_lrkproxy_set usage
325 378
                                                 ...
326 379
                                                 set_lrkproxy_set("0");
327 380
                                                 lrkproxy_manage();
... ...
@@ -351,7 +404,7 @@ _ip_avp", "$avp(RR_CUSTOM_SDP_IP_AVP)")
351 404
 
352 405
    This function can be used from ANY_ROUTE.
353 406
 
354
-   Example 1.11. lrkproxy_manage usage
407
+   Example 1.14. lrkproxy_manage usage
355 408
                                                 ...
356 409
                                                 lrkproxy_manage();
357 410
                                                 //or