Updating README files
[sip-router] / README-MODULES
1
2
3 SIP-ROUTER modules
4 ==================
5
6 This is the first release of the combined project. In order to be able to support
7 an upgrade path for both Kamailio/OpenSER and SER current users, we have been forced to
8 provide some modules in two versions, which means that we have three set of modules:
9
10  - modules:     the SIP router modules
11  - modules_k:   Kamailio modules
12  - modules_s:   SER modules
13
14 All modules are compatible with the core, so regardless if you are a new user or 
15 an existing, you are free to make a choice between the three sets.
16 Note that if you are currently using one product, you want to select the module
17 that exists in the K/S directories first to get a smooth upgrade path.
18
19 As sip-router development progress, we will move as many modules as possible
20 into the core and only keep k/s modules for backwards compatibility when required.
21
22 What is a module?
23 =================
24 A module consists of a lot of functions that enhance the core. Some of the modules
25 depends on other modules. It's all properly documented in the README that belongs
26 to each module (available as web pages on the sip-router.org web site).
27
28 A module providers up to three different APIs:
29
30 - Enhancements to the core SIP-router routing script (functions)
31 - Commands for the management interface (MI)
32 - Development interface for other modules
33
34 A single module may provide a selection of this, maybe only one of them.
35
36 Core modules
37 ------------
38 auth_radius             Radius authentication
39 avpops                  Attribute-value pair operations ("variables")
40 carrierroute            A telephony routing module
41 db_berkeley             Database :: Berkeley DB (Oracle)
42 db_flatstore            Database :: Flatstore
43 db_mysql                Database :: Mysql
44 db_postgres             Database :: PostgreSQL
45 dialplan                Dialplan management
46 enum                    Enum support
47 lcr                     Least cost routing
48 mediaproxy              Nat traversal :: Mediaproxy (AG projects)
49 mi_rpc                  Management Interface :: XML RPC support
50 misc_radius             Various Radius functions
51 pdb                     ???
52 peering                 SIP peering between service providers
53 tls                     SSL/TLS support
54 tm                      SIP transaction support (stateful proxy)
55 utils                   Various utilities (http query, xcap status)
56
57 Kamailio modules
58 ----------------
59 acc                     Accounting
60 alias_db                Alias management in database modules
61 auth                    MD5 digest authentication support
62 auth_db                 Authentication using a database module
63 auth_diameter           Authentication based on Diameter
64 benchmark               Development benchmark module
65 call_control            Call timeouts and management (depends on Dialog module)
66 cfgutils                Various configuration utilities
67 cpl-c
68 db_oracle               Database :: Oracle support
69 db_text                 Database :: Text support
70 db_unixodbc             Database :: Unix ODBC support
71 dialog                  Dialog ("call") state module
72 dispatcher              Load balancing and failover
73 diversion               Call redirect support (SIP Diversion: header)
74 domain                  Proxy :: Multiple domain support using databases
75 domainpolicy
76 drouting                Proxy :: Dynamic routing
77 exec
78 group                   Utils :: Group membership checking
79 h350                    LDAP/ITU H.350 multimedia schema support
80 htable                  Utils :: Hash table support
81 imc                     IM :: Instant messaging conference
82 jabber                  IM :: Jabber gateway
83 kex                     Proxy :: Kamailio core functions (backwards compatibility)
84 ldap                    LDAP Directory access
85 maxfwd                  SIP loop detection prevention (max-forwards header - "ttl")
86 memcached               Utils :: In-memory caching support (memcached)
87 mi_datagram             Management interface :: UDP
88 mi_fifo                 Management Interface :: Unix FIFO
89 mi_xmlrpc               Management Interface :: XML-rpc
90 msilo                   Text message storage
91 nat_traversal           NAT :: NAT traversal module
92 nathelper               NAT :: NAT traversal module :: RTPproxy (SIPPY software)
93 osp                     Open Settlement Protocol support
94 path                    Path: header support
95 pdt                     Proxy :: Routing based on numeric prefix
96 perl                    Perl-based module interface
97 perlvdb                 Database :: Use perl database functions
98 permissions             Security :: TCP-wrapper-like ACL functions
99 pike                    Security :: DOS-attack prevention
100 presence                Presence :: Core presence module
101 presence_dialoginfo     Presence :: Dialog info
102 presence_mwi            Presence :: Message waiting indication
103 presence_xml            Presence :: XML handler
104 pua
105 pua_bla
106 pua_dialoginfo
107 pua_mi                  Presence :: Management interface
108 pua_usrloc
109 pua_xmpp                Presence :: XMPP/Jabber gateway
110 purple                  Presence :: Libpurple support
111 pv
112 qos                     Dialogs :: SDP management 
113 ratelimit               Security :: Rate limit
114 regex                   Regular expression support
115 registrar               Registrar/location server support
116 rls                     Presence :: Resource list server
117 rr                      Proxy :: Record routing
118 rtimer                  Utils :: Timer based routing script processing
119 sanity                  Syntax checking for incoming SIP requests
120 seas                    Application server interface
121 siptrace                Store SIP messages in database
122 siputils                Various utilities for SIP call handling
123 sl                      Proxy :: Stateless handling of SIP messages
124 sms                     SMS gateway support
125 snmpstats               SNMP support (net-snmp agentx)
126 speeddial
127 sqlops
128 sst
129 statistics
130 textops                 Text operations
131 tmx                     Proxy :: Kamailio transaction extensions (TM module)
132 uac
133 uac_redirect
134 uri_db
135 userblacklist
136 usrloc                  Proxy :: Location server
137 xcap_client             Presence :: XCAP support
138 xlog                    Utils :: Extended logging support
139 xmpp                    Presence/IM :: XMPP/jabber gateway
140
141 SER modules
142 -----------
143 acc_db
144 acc_radius
145 acc_syslog
146 auth
147 auth_db
148 auth_identity
149 avp
150 avp_db
151 bdb
152 blst
153 cfg_db
154 cfg_rpc
155 cpl-c
156 ctl
157 db_ops
158 dbg
159 dbtext
160 dialog
161 dispatcher
162 diversion               Proxy :: Call redirection support (Diversion: header)
163 domain                  Proxy :: Multiple domain support
164 eval
165 exec                    Proxy :: External script support (modify route set)
166 fifo            
167 gflags                  Proxy :: Global flags
168 iptrtpproxy             NAT traversal :: Kernel based RTP proxy
169 jabber                  IM :: Jabber gateway
170 ldap                    LDAP directory server support
171 mangler
172 maxfwd                  Proxy :: Loop prevention (max-forwards header)
173 msilo
174 nathelper               NAT traversal :: RTP proxy (SIPPY software)
175 options                 Proxy :: Support for SIP OPTION request
176 oracle                  Database :: Oracle
177 osp                     Open Settlement Protocol
178 pa
179 pdt
180 permissions             Security :: ACL support like TCP wrappers
181 pike
182 prefix_route
183 presence_b2b
184 print
185 print_lib
186 ratelimit
187 registrar
188 rls
189 rr
190 sanity
191 sl
192 sms
193 speeddial
194 textops
195 timer
196 tls
197 uac
198 unixsock
199 uri
200 uri_db
201 usrloc
202 xcap
203 xlog                    Extended logging support
204 xmlrpc