Browse code

README-MODULES - merge listing of modules into one combined

Thanks to Daniel for merging the directories.

Olle E. Johansson authored on 20/01/2013 15:55:23
Showing 1 changed files
... ...
@@ -8,9 +8,9 @@ In the previous release some modules where provided in two versions, in Kamailio
8 8
 and SER flavours. These are now merged. In some cases, the functionality has 
9 9
 changed. You can still do the same operation, but how you do it may be different.
10 10
 
11
-Modules are divided in two directories
12
- - modules: 	the SIP router modules
13
- - modules_k: 	Kamailio modules
11
+Modules are in the "modules" directory.
12
+In previous releases there was a "modules_k" and "modules_s" directory, but in
13
+this release these directories are empty.
14 14
 
15 15
 What is a module?
16 16
 =================
... ...
@@ -28,38 +28,65 @@ A module providers up to five different APIs:
28 28
 
29 29
 A single module may provide a selection of this, maybe only one of them.
30 30
 
31
-Core modules
32
-app_lua			Execute embedded LUA scripts
33
-app_mono		Execute embedded MONO scripts (like C#, Java, javascript)
34
-app_python		Execute embedded Python scripts
31
+Kamailio Modules
32
+----------------
33
+acc			Accounting
34
+acc_radius		Accounting with RADIUS backend
35
+alias_db		Alias management in database modules
36
+app_lua			Lang :: Execute embedded LUA scripts
37
+app_mono		Lang :: Execute embedded MONO scripts (like C#, Java, javascript)
38
+app_perl		Lang :: Embedded perl script support
39
+app_python		Lang :: Execute embedded Python scripts
35 40
 async			Asynchronus SIP request handling functions
36 41
 auth			MD5 digest authentication support
42
+auth_db			Authentication using a database module
43
+auth_diameter		Authentication based on Diameter
37 44
 auth_identity		SIP Identity support (RFC 4474)
38 45
 auth_radius		Radius authentication
39 46
 acp			Collection of functions for handling AVP's (from SER)
40 47
 avpops			Attribute-value pair operations ("variables")
41
-carrierroute		A telephony routing module
48
+benchmark		Development benchmark module
42 49
 blst			Blacklisting API for configuration scripts
50
+call_control		Call timeouts and management (depends on Dialog module)
51
+carrierroute		A telephony routing module
43 52
 cdp			C Diameter Peer - core communication engine
44 53
 cdp_avp			C Diameter Peer - application extensions
45 54
 cfg_db			Database driver for configuration API
46 55
 cfg_rpc			Update core and module parameters from RPC
56
+cfgutils		Various configuration utilities
47 57
 corex			Core extensions
48 58
 counters		Internal counter API for configuration
59
+cpl-c			Implementation of SIP Call Processing Language (RFC 3880)
49 60
 ctl			Control connector for RPC interface (fifo, unixsock, tcp, udp)
50 61
 db_berkeley		Database :: Berkeley DB (Oracle)
51
-db_cassandra		Cassandra database server connector
62
+db_cluster		Generic database connectors clustering and failover
63
+db_cassandra		Database :: Cassandra database server connector
52 64
 db_flatstore		Database :: Flatstore
53 65
 db_mysql		Database :: Mysql
66
+db_oracle		Database :: Oracle support
67
+db_perlvdb		Database :: Use perl database functions
54 68
 db_postgres		Database :: PostgreSQL
69
+db_text			Database :: Text support
70
+db_unixodbc		Database :: Unix ODBC support
55 71
 db2_ldap		Database connector to LDAP using the DB2 API
56 72
 db2_ops			Database operations for DB API v2
57 73
 debugger		Interactive configuration processing debugger
74
+dialog			Dialog ("call") state module
58 75
 dialplan		Dialplan management
59 76
 dialog_ng		Dialog tracking module - next generation
77
+dispatcher		Load balancing and failover
78
+diversion		Call redirect support (SIP Diversion: header)
79
+dmq			Devel :: Distributed message queue system using SIP (early development)
80
+domain			Proxy :: Multiple domain support using databases
81
+domainpolicy		Proxy :: Obsolete module - This module is no longer maintained
82
+drouting		Proxy :: Dynamic routing
60 83
 enum			Enum support
84
+exec			External exec module
61 85
 geoip			GeoIP API to configuration file
86
+group			Utils :: Group membership checking
87
+h350			LDAP/ITU H.350 multimedia schema support
88
+htable			Utils :: Hash table support
89
+imc			IM :: Instant messaging conference
62 90
 ims_auth		IMS authentication module
63 91
 ims_icscf		IMS ICSCF component module
64 92
 ims_isc			IMS ISC component module
... ...
@@ -68,99 +95,40 @@ ims_registrar_pcscf	IMS PCSCF registrar module
68 68
 ims_registrar_scscf	IMS SCSCF registrar module
69 69
 ipops			IP and DNS related operations
70 70
 iptrtpproxy		NAT traversal :: Kernel based RTP proxy
71
+jabber			IM :: Jabber gateway
71 72
 json			Access to JSON document attributes
72 73
 jsonrpc-c		JSON-RPC client over netstrings protocol
74
+kex			Proxy :: Kamailio core functions (backwards compatibility)
73 75
 lcr			Least cost routing
76
+ldap			LDAP Directory access
74 77
 malloc_test		Functions for stress-testing memory manager (from SER)
75 78
 mangler			SIP message mangling functions (from SER)
76 79
 matrix			Matrix operations
77
-mediaproxy		Nat traversal :: Mediaproxy (AG projects)
78
-mi_rpc			Management Interface :: XML RPC support
79
-misc_radius		Various Radius functions
80
-msrp			Embedded MSRP relay (RFC 4975 and RFC 4976)
81
-ndb_redis		Connector to REDIS NoSQL Database engine
82
-pdb			Number portabilityusing external server
83
-peering			SIP peering between service providers
84
-pipelimit		Traffic shaping policies
85
-prefix_route		Execute config file route blocks based on prefix
86
-print			DEVEL :: Basic sample of a module
87
-print_lib		DEVEL :: Basic sample of a module with dependency on other modules
88
-ratelimit		Traffic shaping module
89
-rtpproxy		NAT :: Nat traversal module for RTPproxy control
90
-sanity			Syntax checking for incoming SIP requests
91
-sca			PRESENCE :: Shared call appearances
92
-sdpops			SDP operations
93
-sipcapture		SIP Capture Server module (used in the Homer project)
94
-sl			Proxy :: Stateless handling of SIP messages
95
-sms			SMS gateway support
96
-textopsx		Extra Text operations
97
-timer			Execute routing blocks on core timers (From SER)
98
-tls			SSL/TLS support
99
-tm			Proxy :: SIP transaction support (stateful)
100
-topoh			Topology hinding
101
-uid_auth_db		Authentication module using unique IDs (from SER)
102
-uid_avp_db		AVP Database operations using unique IDs (from SER)
103
-uid_domain		Domain management using unique IDs (from SER)
104
-uid_gflags		Global attributes and flags using Unique IDs (from SER)
105
-uid_uri_db		Database URI operations using unique IDs (from SER)
106
-utils			Various utilities (http query, xcap status)
107
-websocket		HTTP :: Websocket transport layer for proxy
108
-xhttp			HTTP :: The server
109
-xhttp_pi		HTTP :: Provisioning interface for Kamailio
110
-xhttp_rpc		HTTP :: RPC Command support
111
-xlog			Utils :: Extended logging support
112
-xmlops			XML operations using XPath
113
-xmlrpc			HTTP :: XMLrpc support
114
-xprint			Functions for printing messages with specifiers (from SER)
115
-
116
-Kamailio modules
117
-acc			Accounting
118
-acc_radius		Accounting with RADIUS backend
119
-alias_db		Alias management in database modules
120
-auth_db			Authentication using a database module
121
-auth_diameter		Authentication based on Diameter
122
-benchmark		Development benchmark module
123
-call_control		Call timeouts and management (depends on Dialog module)
124
-cfgutils		Various configuration utilities
125
-cpl-c			Implementation of SIP Call Processing Language (RFC 3880)
126
-db_cluster		Generic database connectors clustering and failover
127
-db_oracle		Database :: Oracle support
128
-db_text			Database :: Text support
129
-db_unixodbc		Database :: Unix ODBC support
130
-dialog			Dialog ("call") state module
131
-dispatcher		Load balancing and failover
132
-diversion		Call redirect support (SIP Diversion: header)
133
-dmq			Devel :: Distributed message queue system using SIP (early development)
134
-domain			Proxy :: Multiple domain support using databases
135
-domainpolicy		Proxy :: Obsolete module - This module is no longer maintained
136
-drouting		Proxy :: Dynamic routing
137
-exec			External exec module
138
-group			Utils :: Group membership checking
139
-h350			LDAP/ITU H.350 multimedia schema support
140
-htable			Utils :: Hash table support
141
-imc			IM :: Instant messaging conference
142
-jabber			IM :: Jabber gateway
143
-kex			Proxy :: Kamailio core functions (backwards compatibility)
144
-ldap			LDAP Directory access
145 80
 maxfwd			SIP loop detection prevention (max-forwards header - "ttl")
81
+mediaproxy		Nat traversal :: Mediaproxy (AG projects)
146 82
 memcached		Utils :: In-memory caching support (memcached)
147 83
 mi_datagram		Management interface :: UDP
148 84
 mi_fifo			Management Interface :: Unix FIFO
85
+mi_rpc			Management Interface :: RPC support
149 86
 mi_xmlrpc		Management Interface :: XML-rpc
150
-mqueue			Message queue system for configuration file
87
+misc_radius		Various Radius functions
151 88
 msilo			Text message storage
89
+msrp			Embedded MSRP relay (RFC 4975 and RFC 4976)
90
+mqueue			Message queue system for configuration file
152 91
 nat_traversal		NAT :: NAT traversal module
153 92
 nathelper		NAT :: NAT traversal module :: RTPproxy (SIPPY software)
93
+ndb_redis		Connector to REDIS NoSQL Database engine
154 94
 osp			Open Settlement Protocol support
155 95
 outbound		SIP Outbound Implementation
156 96
 p_usrloc		Partitioned and distributed user location services
157 97
 path			Path: header support
98
+pdb			Number portability using external server
158 99
 pdt			Proxy :: Routing based on numeric prefix
159
-perl			Perl-based module interface
160
-perlvdb			Database :: Use perl database functions
100
+peering			SIP peering between service providers
161 101
 permissions		Security :: TCP-wrapper-like ACL functions
162 102
 pike			Security :: DOS-attack prevention
103
+pipelimit		Traffic shaping policies
104
+prefix_route		Execute config file route blocks based on prefix
163 105
 presence		Presence :: Core presence module
164 106
 presence_conference	Presence :: Conference events handling
165 107
 presence_dialoginfo	Presence :: Dialog info
... ...
@@ -168,6 +136,8 @@ presence_mwi		Presence :: Message waiting indication
168 168
 presence_profile	Presence :: User profile extensions (RFC 6080)
169 169
 presence_reginfo	Presence :: Registration info (RFC 3680)
170 170
 presence_xml		Presence :: XML handler
171
+print			DEVEL :: Basic sample of a module
172
+print_lib		DEVEL :: Basic sample of a module with dependency on other modules
171 173
 pua			Presence :: Common module
172 174
 pua_bla			Presence :: BLA
173 175
 pua_dialoginfo		Presence :: Dialog Info support
... ...
@@ -178,27 +148,54 @@ pua_xmpp		Presence :: XMPP/Jabber gateway
178 178
 purple			Presence :: Libpurple support
179 179
 pv			Pseudo-variable implementation
180 180
 qos			Dialogs :: SDP management 
181
-ratelimit		Security :: Rate limit
181
+ratelimit		Traffic shaping module
182 182
 regex			Regular expression support
183 183
 registrar		Registrar/location server support
184 184
 rls			Presence :: Resource list server
185 185
 rr			Proxy :: Record routing
186 186
 rtimer			Utils :: Timer based routing script processing
187
+rtpproxy		NAT :: Nat traversal module for RTPproxy control
188
+sanity			Syntax checking for incoming SIP requests
189
+sca			PRESENCE :: Shared call appearances
190
+sdpops			SDP operations
187 191
 seas			Application server interface
192
+sipcapture		SIP Capture Server module (used in the Homer project)
188 193
 siptrace		Store SIP messages in database
189 194
 siputils		Various utilities for SIP call handling
195
+sl			Proxy :: Stateless handling of SIP messages
196
+sms			SMS gateway support
190 197
 snmpstats		SNMP support (net-snmp agentx)
191 198
 speeddial		Per-user speed-dial controller module
192 199
 sqlops			SQL operations
193 200
 sst			SIP Session Timers implementation
194 201
 statistics		Script statistics support
195 202
 textops			Text operations
203
+textopsx		Extra Text operations
204
+timer			Execute routing blocks on core timers (From SER)
205
+tls			SSL/TLS support
206
+tm			Proxy :: SIP transaction support (stateful)
196 207
 tmx			Proxy :: Kamailio transaction extensions (TM module)
208
+topoh			Topology hinding
197 209
 uac			UAC functions (From: mangling and UAC auth)
198 210
 uac_redirect		UAC redirection support
211
+uid_auth_db		Authentication module using unique IDs (from SER)
212
+uid_avp_db		AVP Database operations using unique IDs (from SER)
213
+uid_domain		Domain management using unique IDs (from SER)
214
+uid_gflags		Global attributes and flags using Unique IDs (from SER)
215
+uid_uri_db		Database URI operations using unique IDs (from SER)
199 216
 uri_db			URI operation with database support
200 217
 userblacklist		User-specific blacklists
201 218
 usrloc			Proxy :: Location server
219
+utils			Various utilities (http query, xcap status)
220
+websocket		HTTP :: Websocket transport layer for proxy
202 221
 xcap_client		Presence :: XCAP support
203 222
 xcap_server		Presence :: XCAP server implementation
223
+xhttp			HTTP :: The server
224
+xhttp_pi		HTTP :: Provisioning interface for Kamailio
225
+xhttp_rpc		HTTP :: RPC Command support
226
+xlog			Utils :: Extended logging support
227
+xmlops			XML operations using XPath
228
+xmlrpc			HTTP :: XMLrpc support
204 229
 xmpp			Presence/IM :: XMPP/jabber gateway
230
+xprint			Functions for printing messages with specifiers (from SER)
231
+