Browse code

modules: readme files regenerated - acc ...

Kamailio Dev authored on 02/01/2017 16:31:15
Showing 3 changed files
... ...
@@ -319,7 +319,10 @@ Chapter 1. Admin Guide
319 319
    1.1. General Example
320 320
 
321 321
    ACC module is used to account transactions information to different
322
-   backends like syslog, SQL, RADIUS and DIAMETER (beta version).
322
+   backends like syslog and SQL. With the separate module, radius support
323
+   is enabled. There is some very early support of the Diameter protocol
324
+   in the code which is no longer included by default. This support is not
325
+   up to date with the current Diameter protocols and is disabled.
323 326
 
324 327
    To account a transaction and to choose which set of backends to be
325 328
    used, the script writer just has to set some flags (see the module
... ...
@@ -364,25 +367,9 @@ Chapter 1. Admin Guide
364 367
        see cdr_expired_dlg_enable parameter - Section 6.40,
365 368
        “cdr_expired_dlg_enable (integer)”.
366 369
 
367
-   The SQL backend support is compiled in the module. For RADIUS and
368
-   DIAMETER you need to enable it by recompiling the module with properly
369
-   set defines: uncomment the RAD_ACC or DDIAM_ACC lines in
370
-   modules/acc/Makefile. To compile RADIUS support, you need to have
371
-   radiusclient-ng (only versions higher or equal to 0.5.0) installed on
372
-   your system which is available from
373
-   http://developer.berlios.de/projects/radiusclient-ng/. The radius
374
-   client needs to be configured properly. To do so, use the template at
375
-   etc/radiusclient.conf and make sure that module's radius_config
376
-   parameter points to its location. In particular, accounting secret must
377
-   match that one configured in server and proper dictionary is used (one
378
-   is available at etc/sip_dictionary). Also note that Debian
379
-   radiusclient-ng uses /var/run/radius.seq as seqfile but Kamailio Debian
380
-   init script expects /var/run/kamailio/kamailio_radius.seq, so is needed
381
-   to change it in radiusclient-ng configuration or in Kamailio Debian
382
-   init script (if not, Kamailio can't create the seq file when not
383
-   running as root). Uses along with FreeRadius (
384
-   http://www.freeradius.org/) and Radiator (
385
-   http://www.open.com.au/radiator/) servers have been reported to us.
370
+   The SQL backend support is compiled in the module. For DIAMETER you
371
+   need to enable it by recompiling the module with properly set defines:
372
+   uncomment the DDIAM_ACC lines in modules/acc/Makefile.
386 373
 
387 374
    NOTE: diameter support was developed for DISC (DIameter Server Client
388 375
    project at http://developer.berlios.de/projects/disc/). This project
... ...
@@ -669,8 +656,7 @@ $dlg_var(callee) = $avp(callee); #callee='C'
669 656
 
670 657
    The following libraries or applications must be installed before
671 658
    running Kamailio with this module loaded:
672
-     * radiusclient-ng 0.5.0 or higher -- if compiled with RADIUS support.
673
-       See http://developer.berlios.de/projects/radiusclient-ng/.
659
+     * None
674 660
 
675 661
 6. Parameters
676 662
 
... ...
@@ -85,14 +85,15 @@ Hugh Waite
85 85
 
86 86
    2. Developer Guide
87 87
 
88
-        1. Available Functions
88
+        1.
89
+        2. Available Functions
89 90
 
90
-              1.1. http_connect(msg, connection, url, result,
91
+              2.1. int http_connect(msg, connection, url, result,
91 92
                       content_type, post)
92 93
 
93
-              1.2. int http_connection_exists(str *connection)
94
-              1.3. http_query(msg, url, dest, post)
95
-              1.4. http_get_content_type(str connection)
94
+              2.2. int http_connection_exists(str *connection)
95
+              2.3. int http_query(msg, url, dest, post)
96
+              2.4. http_get_content_type(str connection)
96 97
 
97 98
    List of Examples
98 99
 
... ...
@@ -175,7 +176,8 @@ Chapter 1. Admin Guide
175 176
    This module implements protocol functions that use the libcurl library
176 177
    to fetch data from external HTTP servers or post data to HTTP servers.
177 178
    The module is using a concept of "connections" to define properties of
178
-   HTTP sessions in a simple way.
179
+   HTTP sessions in a simple way. A connection has one or multiple servers
180
+   and a set of settings that apply to the specific connection.
179 181
 
180 182
    The http_client module has multiple settings, some of them applies to a
181 183
    defined connection. You can set timeouts, max data sizes for download
... ...
@@ -191,9 +193,10 @@ Chapter 1. Admin Guide
191 193
    Transformation Cookbook (as used in the http_client_query example
192 194
    below).
193 195
 
194
-   Function http_client_query allows Kamailio to issue an HTTP GET request
195
-   and get access to parts of the reply. This function has been ported
196
-   from the utils module and now use the same libcurl functions.
196
+   The function http_client_query allows Kamailio to issue an HTTP GET
197
+   request and get access to parts of the reply. This function has been
198
+   ported from the utils module and now use the same libcurl functions. We
199
+   recommend using the new functionality provided by this module.
197 200
 
198 201
    The http_client module use the CURL library setting up connections. The
199 202
    CURL library by default use the system configured DNS resolvers, not
... ...
@@ -760,23 +763,28 @@ Chapter 2. Developer Guide
760 763
 
761 764
    Table of Contents
762 765
 
763
-   1. Available Functions
766
+   1.
767
+   2. Available Functions
764 768
 
765
-        1.1. http_connect(msg, connection, url, result, content_type,
769
+        2.1. int http_connect(msg, connection, url, result, content_type,
766 770
                 post)
767 771
 
768
-        1.2. int http_connection_exists(str *connection)
769
-        1.3. http_query(msg, url, dest, post)
770
-        1.4. http_get_content_type(str connection)
772
+        2.2. int http_connection_exists(str *connection)
773
+        2.3. int http_query(msg, url, dest, post)
774
+        2.4. http_get_content_type(str connection)
771 775
 
772
-1. Available Functions
776
+   This module provides a set of API functions that other modules can use
777
+   in order to integrate with HTTP services.
773 778
 
774
-   1.1. http_connect(msg, connection, url, result, content_type, post)
775
-   1.2. int http_connection_exists(str *connection)
776
-   1.3. http_query(msg, url, dest, post)
777
-   1.4. http_get_content_type(str connection)
779
+2. Available Functions
778 780
 
779
-1.1.  http_connect(msg, connection, url, result, content_type, post)
781
+   2.1. int http_connect(msg, connection, url, result, content_type, post)
782
+
783
+   2.2. int http_connection_exists(str *connection)
784
+   2.3. int http_query(msg, url, dest, post)
785
+   2.4. http_get_content_type(str connection)
786
+
787
+2.1.  int http_connect(msg, connection, url, result, content_type, post)
780 788
 
781 789
    Sends HTTP GET or POST request to a given connection. If content_type
782 790
    and post are NULL GET will be used. If post is not null the data will
... ...
@@ -805,7 +813,7 @@ Chapter 2. Developer Guide
805 813
        A string containing the message body to send. Use NULL when a
806 814
        message body is not required.
807 815
 
808
-1.2.  int http_connection_exists(str *connection)
816
+2.2.  int http_connection_exists(str *connection)
809 817
 
810 818
    Check if a connection definition exists. Connections are defined as
811 819
    modparam's in the http_client modules.
... ...
@@ -813,16 +821,16 @@ Chapter 2. Developer Guide
813 821
    Returns 1 if the connection exists, 0 if a connection with the given
814 822
    name can't be found.
815 823
 
816
-1.3.  http_query(msg, url, dest, post)
824
+2.3.  int http_query(msg, url, dest, post)
817 825
 
818
-   Sends HTTP GET or POST request to a given connection. If post data is
826
+   Sends a HTTP GET or POST request to a given connection. If post data is
819 827
    defined, POST will be used, otherwise GET. The default settings defined
820 828
    as module params of the http_client module will be used for the
821 829
    connection.
822 830
 
823 831
    Meaning of the parameters is as follows:
824 832
      * struct sip_msg *msg
825
-       The current sip message structure.
833
+       The current SIP message structure.
826 834
      * const char *url
827 835
        A string that will be used as the URL specified in the connection.
828 836
      * str *dest
... ...
@@ -832,7 +840,7 @@ Chapter 2. Developer Guide
832 840
      * const char *post
833 841
        If not null, the data will be posted to the URL.
834 842
 
835
-1.4.  http_get_content_type(str connection)
843
+2.4.  http_get_content_type(str connection)
836 844
 
837 845
    Get the content-type of the last result for this connection. This will
838 846
    be something like "text/html" for html or "application/json" for JSON
... ...
@@ -124,10 +124,10 @@ Chapter 1. Admin Guide
124 124
    This module implements a WebSocket (RFC 6455) server and provides
125 125
    connection establishment (handshaking), management (including
126 126
    connection keep-alive), and framing for the SIP and MSRP WebSocket
127
-   sub-protocols (draft-ietf-sipcore-sip-websocket and
128
-   draft-pd-msrp-websocket).
127
+   sub-protocols (RFC 7118 and RFC 7977).
129 128
 
130 129
    The module supports WebSockets (ws) and secure WebSockets (wss)
130
+   transports
131 131
 
132 132
 2. How it works
133 133
 
... ...
@@ -218,11 +218,11 @@ event_route[xhttp:request] {
218 218
    WebSocket connection is made. This means that the routing headers
219 219
    cannot be used for request or response routing in the normal manner.
220 220
 
221
-   draft-ietf-sipcore-sip-websocket states that SIP WebSocket Clients and
222
-   the SIP registrar should implement Outbound (RFC 5626) and Path (RFC
223
-   3327) to enable requests and responses to be correctly routed. However,
224
-   Kamailio does not currently support Outbound and it may not be possible
225
-   to guarantee all SIP WebSocket clients will support Outbound and Path.
221
+   RFC 7118 - The WebSocket Protocol as a Transport for the Session
222
+   Initiation Protocol - states that SIP WebSocket Clients and the SIP
223
+   registrar should implement SIP Outbound (RFC 5626) and Path header
224
+   support (RFC 3327) to enable requests and responses to be correctly
225
+   routed. Kamailio has a module called "Outbound" for this functionality.
226 226
 
227 227
    The nathelper module functions (nat_uac_test(), fix_nated_register(),
228 228
    add_contact_alias(), and handle_ruri_alias()) and the Kamailio core
... ...
@@ -386,7 +386,7 @@ modparam("websocket", "keepalive_processes", 2)
386 386
 
387 387
 4.4. keepalive_interval (integer)
388 388
 
389
-   The number of seconds between each keep-alice process run
389
+   The number of seconds between each keep-alive process run
390 390
 
391 391
    Default value is 1.
392 392
 
... ...
@@ -410,9 +410,8 @@ modparam("websocket", "ping_application_data", "WebSockets rock")
410 410
 
411 411
    A bitmap that allows you to control the sub-protocols supported by the
412 412
    WebSocket server.
413
-     * 1 - sip (draft-ietf-sipcore-sip-websocket)
414
-     * 2 - msrp (draft-pd-msrp-websocket) - msrp.so must be loaded before
415
-       websocket.so
413
+     * 1 - sip (RFC 7118)
414
+     * 2 - msrp (RFC 7977) - msrp.so must be loaded before websocket.so
416 415
 
417 416
    Default value is 1 when msrp.so is not loaded 3 when msrp.so is loaded.
418 417