Browse code

README-MODULES Update module list

Olle E. Johansson authored on 10/01/2015 08:21:21
Showing 1 changed files
... ...
@@ -1,14 +1,17 @@
1 1
 
2 2
 
3
-SIP-ROUTER modules
3
+Kamailio  modules
4 4
 ==================
5 5
 
6
-This is the second major release of the merged SIP Server - Kamailio and SER. 
7
-In the previous release some modules where provided in two versions, in Kamailio
6
+This is a major release of the merged SIP Server - Kamailio and SER. 
7
+
8
+In  previous releases (v3.x) some modules where provided in two versions, in Kamailio
8 9
 and SER flavours. These are now merged. In some cases, the functionality has 
9 10
 changed. You can still do the same operation, but how you do it may be different.
10 11
 
11
-Modules are in the "modules" directory.
12
+Modules are found in the "modules" directory. After installation that can
13
+be /usr/local/lib/kamailio/modules or /usr/lib/kamailio/modules.
14
+
12 15
 In previous releases there was a "modules_k" and "modules_s" directory, but in
13 16
 this release these directories are empty.
14 17
 
... ...
@@ -16,15 +19,16 @@ What is a module?
16 19
 =================
17 20
 A module consists of a lot of functions that enhance the core. Some of the modules
18 21
 depends on other modules. It's all properly documented in the README that belongs
19
-to each module (available as web pages on the sip-router.org web site).
22
+to each module (available as web pages on the kamailio.org web site).
20 23
 
21
-A module providers up to five different APIs:
24
+A module providers up to six different APIs:
22 25
 
23
-- Enhancements to the core SIP-router routing script (functions)
24
-- Commands for the management interface (MI and RPC)
26
+- Enhancements to the core Kamailio routing script (functions)
27
+- Commands for the management interfaces (MI and RPC)
25 28
 - Development interface for other modules
26 29
 - Pseudo-variables
27 30
 - Selects and config framework variables
31
+- Event-Routes
28 32
 
29 33
 A single module may provide a selection of this, maybe only one of them.
30 34
 
... ...
@@ -33,18 +37,19 @@ Kamailio Modules
33 37
 acc			Accounting
34 38
 acc_radius		Accounting with RADIUS backend
35 39
 alias_db		Alias management in database modules
40
+app_java		Lang :: Execute embedded Java applications
36 41
 app_lua			Lang :: Execute embedded LUA scripts
37 42
 app_mono		Lang :: Execute embedded MONO scripts (like C#, Java, javascript)
38 43
 app_perl		Lang :: Embedded perl script support
39 44
 app_python		Lang :: Execute embedded Python scripts
40
-app_java		Lang :: Execute embedded Java compiled code
41 45
 async			Asynchronus SIP request handling functions
42 46
 auth			MD5 digest authentication support
43 47
 auth_db			Authentication using a database module
44 48
 auth_diameter		Authentication based on Diameter
49
+auth_ephemeral		User authentication with ephemeral credentials
45 50
 auth_identity		SIP Identity support (RFC 4474)
46 51
 auth_radius		Radius authentication
47
-acp			Collection of functions for handling AVP's (from SER)
52
+avp			Collection of functions for handling AVP's (from SER)
48 53
 avpops			Attribute-value pair operations ("variables")
49 54
 benchmark		Development benchmark module
50 55
 blst			Blacklisting API for configuration scripts
... ...
@@ -63,42 +68,51 @@ db_berkeley		Database :: Berkeley DB (Oracle)
63 68
 db_cluster		Generic database connectors clustering and failover
64 69
 db_cassandra		Database :: Cassandra database server connector
65 70
 db_flatstore		Database :: Flatstore
71
+db_mongodb		Database :: MongoDB
66 72
 db_mysql		Database :: Mysql
67 73
 db_oracle		Database :: Oracle support
68 74
 db_perlvdb		Database :: Use perl database functions
69 75
 db_postgres		Database :: PostgreSQL
70 76
 db_text			Database :: Text support
71 77
 db_unixodbc		Database :: Unix ODBC support
72
-db2_ldap		Database connector to LDAP using the DB2 API
73
-db2_ops			Database operations for DB API v2
78
+db2_ldap		DB2 :: Database connector to LDAP using the DB2 API
79
+db2_ops			DB2 :: Database operations for DB API v2
74 80
 debugger		Interactive configuration processing debugger
75 81
 dialog			Dialog ("call") state module
76 82
 dialplan		Dialplan management
77 83
 dialog_ng		Dialog tracking module - next generation
78 84
 dispatcher		Load balancing and failover
79 85
 diversion		Call redirect support (SIP Diversion: header)
80
-dmq			Devel :: Distributed message queue system using SIP (early development)
86
+dmq			Distributed message queue system using SIP
87
+dnssec			DNSsec support in the DNS resolver
81 88
 domain			Proxy :: Multiple domain support using databases
82 89
 domainpolicy		Proxy :: Obsolete module - This module is no longer maintained
83 90
 drouting		Proxy :: Dynamic routing
84 91
 enum			Enum support
85 92
 exec			External exec module
93
+evapi			Network event broadcast API
86 94
 geoip			GeoIP API to configuration file
87 95
 group			Utils :: Group membership checking
96
+gzcompress		Compress and decompress SIP message body with zlib
88 97
 h350			LDAP/ITU H.350 multimedia schema support
89 98
 htable			Utils :: Hash table support
90 99
 imc			IM :: Instant messaging conference
91 100
 ims_auth		IMS authentication module
101
+ims_charging		IMS charging component module
92 102
 ims_icscf		IMS ICSCF component module
93 103
 ims_isc			IMS ISC component module
94 104
 ims_qos			IMS Diameter Rx interface
95 105
 ims_registrar_pcscf	IMS PCSCF registrar module
96 106
 ims_registrar_scscf	IMS SCSCF registrar module
107
+ims_usrloc_pcscf	IMS PCSCF usrloc module
108
+ims_usrloc_scscf	IMS SCSCF usrloc module
97 109
 ipops			IP and DNS related operations
98 110
 iptrtpproxy		NAT traversal :: Kernel based RTP proxy
99 111
 jabber			IM :: Jabber gateway
100 112
 json			Access to JSON document attributes
101 113
 jsonrpc-c		JSON-RPC client over netstrings protocol
114
+jsonrpc-s		JSON-RPC interface to the Kamailio RPC API
115
+kazoo			Middle layer connector for Kazoo VoIP platform
102 116
 kex			Proxy :: Kamailio core functions (backwards compatibility)
103 117
 lcr			Least cost routing
104 118
 ldap			LDAP Directory access
... ...
@@ -115,11 +129,14 @@ mi_xmlrpc		Management Interface :: XML-rpc
115 129
 misc_radius		Various Radius functions
116 130
 msilo			Text message storage
117 131
 msrp			Embedded MSRP relay (RFC 4975 and RFC 4976)
132
+mohqueue		Music on hold queuing system
118 133
 mqueue			Message queue system for configuration file
119 134
 nat_traversal		NAT :: NAT traversal module
120 135
 nathelper		NAT :: NAT traversal module :: RTPproxy (SIPPY software)
121
-ndb_redis		Connector to REDIS NoSQL Database engine
122 136
 ndb_cassandra		Connector to Apache Cassandra
137
+ndb_mongodb		Connector to MongoDB
138
+ndb_redis		Connector to REDIS NoSQL Database engine
139
+nosip			Handle non-sip messages received by SIP workers via event_route
123 140
 osp			Open Settlement Protocol support
124 141
 outbound		SIP Outbound Implementation
125 142
 p_usrloc		Partitioned and distributed user location services
... ...
@@ -156,12 +173,14 @@ registrar		Registrar/location server support
156 173
 rls			Presence :: Resource list server
157 174
 rr			Proxy :: Record routing
158 175
 rtimer			Utils :: Timer based routing script processing
176
+rtpengine		NAT :: RTPEngine media relay control functions
159 177
 rtpproxy		NAT :: Nat traversal module for RTPproxy control
160 178
 sanity			Syntax checking for incoming SIP requests
161 179
 sca			PRESENCE :: Shared call appearances
162 180
 sdpops			SDP operations
163 181
 seas			Application server interface
164 182
 sipcapture		SIP Capture Server module (used in the Homer project)
183
+sipt			SIP-T and SIP-I operations
165 184
 siptrace		Store SIP messages in database
166 185
 siputils		Various utilities for SIP call handling
167 186
 sl			Proxy :: Stateless handling of SIP messages
... ...
@@ -171,6 +190,7 @@ speeddial		Per-user speed-dial controller module
171 190
 sqlops			SQL operations
172 191
 sst			SIP Session Timers implementation
173 192
 statistics		Script statistics support
193
+statsd			Connector for statsd application
174 194
 textops			Text operations
175 195
 textopsx		Extra Text operations
176 196
 timer			Execute routing blocks on core timers (From SER)
... ...
@@ -189,6 +209,7 @@ uri_db			URI operation with database support
189 209
 userblacklist		User-specific blacklists
190 210
 usrloc			Proxy :: Location server
191 211
 utils			Various utilities (http query, xcap status)
212
+uuid			Unique string value generator using libuuid
192 213
 websocket		HTTP :: Websocket transport layer for proxy
193 214
 xcap_client		Presence :: XCAP support
194 215
 xcap_server		Presence :: XCAP server implementation