SIP-ROUTER modules
==================

This is the first release of the combined project. In order to be able to support
an upgrade path for both Kamailio/OpenSER and SER current users, we have been forced to
provide some modules in two versions, which means that we have three set of modules:

 - modules: 	the SIP router modules
 - modules_k: 	Kamailio modules
 - modules_s: 	SER modules

All modules are compatible with the core, so regardless if you are a new user or 
an existing, you are free to make a choice between the three sets.
Note that if you are currently using one product, you want to select the module
that exists in the K/S directories first to get a smooth upgrade path.

As sip-router development progress, we will move as many modules as possible
into the core and only keep k/s modules for backwards compatibility when required.

What is a module?
=================
A module consists of a lot of functions that enhance the core. Some of the modules
depends on other modules. It's all properly documented in the README that belongs
to each module (available as web pages on the sip-router.org web site).

A module providers up to three different APIs:

- Enhancements to the core SIP-router routing script (functions)
- Commands for the management interface (MI)
- Development interface for other modules

A single module may provide a selection of this, maybe only one of them.

Core modules
------------
auth_radius		Radius authentication
avpops			Attribute-value pair operations ("variables")
carrierroute		A telephony routing module
db_berkeley		Database :: Berkeley DB (Oracle)
db_flatstore		Database :: Flatstore
db_mysql		Database :: Mysql
db_postgres		Database :: PostgreSQL
dialplan		Dialplan management
enum			Enum support
lcr			Least cost routing
mediaproxy		Nat traversal :: Mediaproxy (AG projects)
mi_rpc			Management Interface :: XML RPC support
misc_radius		Various Radius functions
pdb			???
peering			SIP peering between service providers
tls			SSL/TLS support
tm			SIP transaction support (stateful proxy)
utils			Various utilities (http query, xcap status)

Kamailio modules
----------------
acc			Accounting
alias_db		Alias management in database modules
auth			MD5 digest authentication support
auth_db			Authentication using a database module
auth_diameter		Authentication based on Diameter
benchmark		Development benchmark module
call_control		Call timeouts and management (depends on Dialog module)
cfgutils		Various configuration utilities
cpl-c
db_oracle		Database :: Oracle support
db_text			Database :: Text support
db_unixodbc		Database :: Unix ODBC support
dialog			Dialog ("call") state module
dispatcher		Load balancing and failover
diversion		Call redirect support (SIP Diversion: header)
domain			Proxy :: Multiple domain support using databases
domainpolicy
drouting		Proxy :: Dynamic routing
exec
group			Utils :: Group membership checking
h350			LDAP/ITU H.350 multimedia schema support
htable			Utils :: Hash table support
imc			IM :: Instant messaging conference
jabber			IM :: Jabber gateway
kex			Proxy :: Kamailio core functions (backwards compatibility)
ldap			LDAP Directory access
maxfwd			SIP loop detection prevention (max-forwards header - "ttl")
memcached		Utils :: In-memory caching support (memcached)
mi_datagram		Management interface :: UDP
mi_fifo			Management Interface :: Unix FIFO
mi_xmlrpc		Management Interface :: XML-rpc
msilo			Text message storage
nat_traversal		NAT :: NAT traversal module
nathelper		NAT :: NAT traversal module :: RTPproxy (SIPPY software)
osp			Open Settlement Protocol support
path			Path: header support
pdt			Proxy :: Routing based on numeric prefix
perl			Perl-based module interface
perlvdb			Database :: Use perl database functions
permissions		Security :: TCP-wrapper-like ACL functions
pike			Security :: DOS-attack prevention
presence		Presence :: Core presence module
presence_dialoginfo	Presence :: Dialog info
presence_mwi		Presence :: Message waiting indication
presence_xml		Presence :: XML handler
pua
pua_bla
pua_dialoginfo
pua_mi			Presence :: Management interface
pua_usrloc
pua_xmpp		Presence :: XMPP/Jabber gateway
purple			Presence :: Libpurple support
pv
qos			Dialogs :: SDP management 
ratelimit		Security :: Rate limit
regex			Regular expression support
registrar		Registrar/location server support
rls			Presence :: Resource list server
rr			Proxy :: Record routing
rtimer			Utils :: Timer based routing script processing
sanity			Syntax checking for incoming SIP requests
seas			Application server interface
siptrace		Store SIP messages in database
siputils		Various utilities for SIP call handling
sl			Proxy :: Stateless handling of SIP messages
sms			SMS gateway support
snmpstats		SNMP support (net-snmp agentx)
speeddial
sqlops
sst
statistics
textops			Text operations
tmx			Proxy :: Kamailio transaction extensions (TM module)
uac
uac_redirect
uri_db
userblacklist
usrloc			Proxy :: Location server
xcap_client		Presence :: XCAP support
xlog			Utils :: Extended logging support
xmpp			Presence/IM :: XMPP/jabber gateway

SER modules
-----------
acc_db
acc_radius
acc_syslog
auth
auth_db
auth_identity
avp
avp_db
bdb
blst
cfg_db
cfg_rpc
cpl-c
ctl
db_ops
dbg
dbtext
dialog
dispatcher
diversion		Proxy :: Call redirection support (Diversion: header)
domain			Proxy :: Multiple domain support
eval
exec			Proxy :: External script support (modify route set)
fifo		
gflags			Proxy :: Global flags
iptrtpproxy		NAT traversal :: Kernel based RTP proxy
jabber			IM :: Jabber gateway
ldap			LDAP directory server support
mangler
maxfwd			Proxy :: Loop prevention (max-forwards header)
msilo
nathelper		NAT traversal :: RTP proxy (SIPPY software)
options			Proxy :: Support for SIP OPTION request
oracle			Database :: Oracle
osp			Open Settlement Protocol
pa
pdt
permissions		Security :: ACL support like TCP wrappers
pike
prefix_route
presence_b2b
print
print_lib
ratelimit
registrar
rls
rr
sanity
sl
sms
speeddial
textops
timer
tls
uac
unixsock
uri
uri_db
usrloc
xcap
xlog			Extended logging support
xmlrpc