Merge commit 'kam/trunk'
[sip-router] / README-MODULES
1 # $Id$
2
3 =========================================
4 NOTE!!! THIS FILE IS NO LONGER IN USE.
5 PLEASE REFER TO:
6 http://www.iptel.org/views/moduledocs
7 FOR AN UPDATED LIST OF OFFICIAL MODULES.
8 =========================================
9
10 'Owner' field contains a developers CVS username, see file
11 AUTHORS for more details.
12
13 'Use' tells how deployable a module is. Regular indicates
14 we deploy and use this feature in our infrastructure.
15 Experimental tells we are still gaining operation experience.
16 Temporary labels modules which momentarily fix some
17 bugs/lacks and will disappear later. Example modules
18 are primarily useful as educational source code for
19 ser programmers.
20
21 'Maturity' is label as stable if a module has been deployed
22 for longer time, alpha if it is still being developed and
23 beta if it is under test.
24
25 'Depends on' field tells which modules the module needs. 
26
27 Modules underway include firewall control, and more. 
28 If you are interested in any of these or other modules, 
29 write us to info@iptel.org.
30
31 List of currently available ser modules:
32
33 Name:       acc
34 Owner:      jiri
35 Use:        regular
36 Maturity:   stable
37 Depends on: tm
38 Purpose:    Transaction accounting/example (the module server also as an
39             example of how to bind to transaction management)
40
41 Name:       auth
42 Owner:      janakj
43 Use:        regular
44 Maturity:   stable
45 Depends on: sl
46 Purpose:    Common functions for digest authentication
47
48 Name:       auth_db
49 Owner:      janakj
50 Use:        regular
51 Maturity:   stable
52 Depends on: mysql auth
53 Purpose:    Database support for digest authentication
54
55 Name:       auth_radius
56 Owner:      janakj
57 Use:        experimental
58 Maturity:   beta
59 Depends on: auth
60 Purpose:    Radius support for digest authentication
61
62 Name:       avp
63 Owner:      jiri
64 Use:        regular
65 Maturity:   beta
66 Depends on: -
67 Purpose:    Loads and checks avps per caller or callee
68
69 Name:       avp_db
70 Owner:      janakj
71 Use:        regular
72 Maturity:   beta
73 Depends on: mysql avp
74 Purpose:    Database support for avps
75
76 Name:       avp_db
77 Owner:      janakj
78 Use:        regular
79 Maturity:   beta
80 Depends on: avp
81 Purpose:    Radius support for avps
82
83 Name:       avpops
84 Owner:      ramona
85 Use:        regular
86 Maturity:   beta
87 Depends on: 
88 Purpose:    avp operations, pseudo-variable support
89
90 Name:       cpl-c
91 Owner:      bogdan
92 Use:        regular
93 Maturity:   beta
94 Depends on: -
95 Purpose:    Call Processing Language
96
97 Name:       dbtext
98 Owner:      dcm
99 Use:        experimental
100 Maturity:   alpha
101 Depends on: -
102 Purpose:    Database emulation in plaintext files
103
104 Name:       dispatcher
105 Owner:      dcm
106 Use:        experimental
107 Maturity:   alpha
108 Depends on: -
109 Purpose:    Implements a dispatcher for incoming requests using hashes
110
111 Name:       diversion
112 Owner:      janakj
113 Use:        experimental
114 Maturity:   alpha
115 Depends on: -
116 Purpose:    Support for the Diversion extensions (draft-levy-sip-diversion-08)
117
118 Name:       exec
119 Owner:      jiri
120 Use:        experimental
121 Maturity:   beta
122 Depends on: -
123 Purpose:    Execution of external URI processing logic
124
125 Name:       ext
126 Owner:      bogdan
127 Use:        experimental
128 Maturity:   alpha
129 Depends on: -
130 Purpose:    Execution of external URI processing logic
131
132 Name:       extcmd
133 Owner:      bogdan
134 Use:        experimental
135 Maturity:   alpha
136 Depends on: -
137 Purpose:    Execution of external commands
138
139 Name:       flatstore
140 Owner:      janakj
141 Use:        experimental
142 Maturity:   beta
143 Depends on: -
144 Purpose:    Very fast accounting in flat text files
145
146 Name:       gflags
147 Owner:      jiri
148 Use:        experimental
149 Maturity:   beta
150 Depends on: -
151 Purpose:    global flags that can be changed by fifo commands
152
153 Name:       group
154 Owner:      janakj
155 Use:        regular
156 Maturity:   stable
157 Depends on: database
158 Purpose:    Group membership checking using database
159
160 Name:       group_radius
161 Owner:      janakj
162 Use:        experimental
163 Maturity:   beta
164 Depends on: -
165 Purpose:    Group membership checking using Radius
166
167 Name:       jabber
168 Owner:      dcm
169 Use:        experimental
170 Maturity:   beta
171 Depends on: database tm
172 Purpose:    SIMPLE 2 Jabber gateway
173
174 Name:       maxfwd
175 Owner:      bogdan
176 Use:        regular
177 Maturity:   stable
178 Depends on: -
179 Purpose:    Max-Forwards check
180
181 Name:       msilo
182 Owner:      dcm
183 Use:        experimental
184 Maturity:   beta
185 Depends on: database tm
186 Purpose:    Message store
187
188 Name:       mysql
189 Owner:      janakj
190 Use:        regular
191 Maturity:   stable
192 Depends on: -
193 Purpose:    MySQL database support
194
195 Name:       options
196 Owner:      calrissian
197 Use:        experimental
198 Maturity:   beta
199 Depends on: -
200 Purpose:    Answers server options requests
201
202 Name:       pa
203 Owner:      janakj
204 Use:        experimental
205 Maturity:   alpha
206 Depends on: tm (usrloc jabber)
207 Purpose:    Presence agent
208
209 Name:       pike
210 Owner:      bogdan
211 Use:        experimental
212 Maturity:   alpha
213 Depends on: -
214 Purpose:    Excessive load detection
215
216 Name:       print
217 Owner:      andrei
218 Use:        example
219 Maturity:   stable
220 Depends on: -
221 Purpose:    Printing messages to stdout
222
223 Name:       registrar
224 Owner:      janakj
225 Use:        regular
226 Maturity:   stable
227 Depends on: usrloc sl
228 Purpose:    Registrar
229
230 Name:       rr
231 Owner:      janakj
232 Use:        regular
233 Maturity:   stable
234 Depends on: -
235 Purpose:    Routing and Record-Routing
236
237 Name:       sl
238 Owner:      bogdan
239 Use:        regular
240 Maturity:   stable
241 Depends on: -
242 Purpose:    Stateless replies
243
244 Name:       sms
245 Owner:      bogdan
246 Use:        regular
247 Maturity:   stable
248 Depends on: tm
249 Purpose:    SMS gateway
250
251 Name:       snmp
252 Owner:      ric
253 Use:        removed
254 Maturity:   removed
255 Depends on: -
256 Purpose:    SNMP Management
257
258 Name:       speeddial
259 Owner:      ramona
260 Use:        regular
261 Maturity:   beta
262 Depends on: -
263 Purpose:    On-server speed dial facilities
264
265 Name:       textops
266 Owner:      andrei
267 Use:        regular
268 Maturity:   stable
269 Depends on: -
270 Purpose:    Message Textual Operations
271
272 Name:       tm
273 Owner:      jiri
274 Use:        regular
275 Maturity:   beta
276 Depends on: -
277 Purpose:    Transaction Management
278
279 Name:       uri
280 Owner:      janakj
281 Use:        regular
282 Maturity:   stable
283 Depends on: database
284 Purpose:    Various URI checks
285
286 Name:       uri_db
287 Owner:      janakj
288 Use:        experimental
289 Maturity:   beta
290 Depends on: mysql uri
291 Purpose:    URI checking using DB
292
293 Name:       uri_radius
294 Owner:      janakj
295 Use:        experimental
296 Maturity:   beta
297 Depends on: -
298 Purpose:    URI checking using Radius
299
300 Name:       usrloc
301 Owner:      janakj
302 Use:        regular
303 Maturity:   stable
304 Depends on: database
305 Purpose:    User location support
306
307 Name:       vm
308 Owner:      rco
309 Use:        removed (functionality moved in tm)
310 Maturity:   removed
311 Depends on: tm
312 Purpose:    Voicemail interface
313
314 Name:       xlog
315 Owner:      ramona
316 Use:        regular
317 Maturity:   stable
318 Depends on: 
319 Purpose:    formatted logging (printf style)
320
321 Contributions
322 -------------
323 Name:       domain
324 Owner:      jih
325 Use:        experimental
326 Maturity:   beta
327 Depends on: mysql
328 Purpose:    Local domain lists and related functions
329
330 Name:       enum
331 Owner:      jih
332 Use:        experimental
333 Maturity:   beta
334 Depends on: -
335 Purpose:    Enum support
336
337 Name:       domain
338 Owner:      jih
339 Use:        experimental
340 Maturity:   beta
341 Depends on: -
342 Purpose:    support for maintenance of multiple domains
343
344 Name:       mediaproxy
345 Owner:      danp, agprojects
346 Use:        regular
347 Maturity:   stable
348 Depends on: mediaproxy media relay
349 Purpose:    nat traversal
350
351 Name:       nathelper
352 Owner:      sobomax
353 Use:        regular
354 Maturity:   stable
355 Depends on: rtpproxy
356 Purpose:    nat traversal
357
358 Name:           permissions
359 Owner:          tirpi
360 Use:            experimental
361 Maturity:       beta
362 Depends on:     -
363 Purpose:        hosts.allow-like ACLs
364
365 Name:       postgress
366 Owner:      lgfausak
367 Use:        experimental
368 Maturity:   beta
369 Depends on: -
370 Purpose:    Postgress DB support