- mac os x support ported from stable
[sip-router] / README-MODULES
1 # $Id$
2
3 'Owner' field contains a developers CVS username, see file
4 AUTHORS for more details.
5
6 'Use' tells how deployable a module is. Regular indicates
7 we deploy and use this feature in our infrastructure.
8 Experimental tells we are still gaining operation experience.
9 Temporary labels modules which momentarily fix some
10 bugs/lacks and will disappear later. Example modules
11 are primarily useful as educational source code for
12 ser programmers.
13
14 'Maturity' is label as stable if a module has been deployed
15 for longer time, alpha if it is still being developed and
16 beta if it is under test.
17
18 'Depends on' field tells which modules the module needs. 
19
20 Modules underway include firewall control, and more. 
21 If you are interested in any of these or other modules, 
22 write us to info@iptel.org.
23
24 List of currently available ser modules:
25
26 Name:       acc
27 Owner:      jiri
28 Use:        regular
29 Maturity:   stable
30 Depends on: tm
31 Purpose:    Transaction accounting/example (the module server also as an
32             example of how to bind to transaction management)
33
34 Name:       auth
35 Owner:      janakj
36 Use:        regular
37 Maturity:   stable
38 Depends on: sl
39 Purpose:    Common functions for digest authentication
40
41 Name:       auth_db
42 Owner:      janakj
43 Use:        regular
44 Maturity:   stable
45 Depends on: mysql auth
46 Purpose:    Database support for digest authentication
47
48 Name:       auth_radius
49 Owner:      janakj
50 Use:        experimental
51 Maturity:   beta
52 Depends on: auth
53 Purpose:    Radius support for digest authentication
54
55 Name:       cpl-c
56 Owner:      bogdan
57 Use:        experimental
58 Maturity:   alpha
59 Depends on: -
60 Purpose:    Call Processing Language
61
62 Name:       dbtext
63 Owner:      dcm
64 Use:        experimental
65 Maturity:   alpha
66 Depends on: -
67 Purpose:    Database emulation in plaintext files
68
69
70 Name:       exec
71 Owner:      jiri
72 Use:        experimental
73 Maturity:   beta
74 Depends on: -
75 Purpose:    Execution of external URI processing logic
76
77 Name:       ext
78 Owner:      bogdan
79 Use:        experimental
80 Maturity:   alpha
81 Depends on: -
82 Purpose:    Execution of external URI processing logic
83
84 Name:       extcmd
85 Owner:      bogdan
86 Use:        experimental
87 Maturity:   alpha
88 Depends on: -
89 Purpose:    Execution of external commands
90
91 Name:       group
92 Owner:      janakj
93 Use:        regular
94 Maturity:   stable
95 Depends on: database
96 Purpose:    Group membership checking using database
97
98 Name:       group_radius
99 Owner:      janakj
100 Use:        experimental
101 Maturity:   beta
102 Depends on: -
103 Purpose:    Group membership checking using Radius
104
105 Name:       jabber
106 Owner:      dcm
107 Use:        experimental
108 Maturity:   beta
109 Depends on: database tm
110 Purpose:    SIMPLE 2 Jabber gateway
111
112 Name:       maxfwd
113 Owner:      bogdan
114 Use:        regular
115 Maturity:   stable
116 Depends on: -
117 Purpose:    Max-Forwards check
118
119 Name:       msilo
120 Owner:      dcm
121 Use:        experimental
122 Maturity:   beta
123 Depends on: database tm
124 Purpose:    Message store
125
126 Name:       mysql
127 Owner:      janakj
128 Use:        regular
129 Maturity:   stable
130 Depends on: -
131 Purpose:    MySQL database support
132
133 Name:       pa
134 Owner:      janakj
135 Use:        experimental
136 Maturity:   alpha
137 Depends on: tm (usrloc jabber)
138 Purpose:    Presence agent
139
140 Name:       pike
141 Owner:      bogdan
142 Use:        experimental
143 Maturity:   alpha
144 Depends on: -
145 Purpose:    Excessive load detection
146
147 Name:       print
148 Owner:      andrei
149 Use:        example
150 Maturity:   stable
151 Depends on: -
152 Purpose:    Printing messages to stdout
153
154 Name:       registrar
155 Owner:      janakj
156 Use:        regular
157 Maturity:   stable
158 Depends on: usrloc sl
159 Purpose:    Registrar
160
161 Name:       rr
162 Owner:      janakj
163 Use:        regular
164 Maturity:   stable
165 Depends on: -
166 Purpose:    Routing and Record-Routing
167
168 Name:       sl
169 Owner:      bogdan
170 Use:        regular
171 Maturity:   stable
172 Depends on: -
173 Purpose:    Stateless replies
174
175 Name:       sms
176 Owner:      bogdan
177 Use:        regular
178 Maturity:   stable
179 Depends on: tm
180 Purpose:    SMS gateway
181
182 Name:       snmp
183 Owner:      ric
184 Use:        experimental
185 Maturity:   alpha
186 Depends on: -
187 Purpose:    SNMP Management
188
189 Name:       textops
190 Owner:      andrei
191 Use:        regular
192 Maturity:   stable
193 Depends on: -
194 Purpose:    Message Textual Operations
195
196 Name:       tm
197 Owner:      jiri
198 Use:        regular
199 Maturity:   beta
200 Depends on: -
201 Purpose:    Transaction Management
202
203 Name:       uri
204 Owner:      janakj
205 Use:        regular
206 Maturity:   stable
207 Depends on: database
208 Purpose:    Various URI checks
209
210 Name:       uri_radius
211 Owner:      janakj
212 Use:        experimental
213 Maturity:   beta
214 Depends on: -
215 Purpose:    URI checking using Radius
216
217 Name:       usrloc
218 Owner:      janakj
219 Use:        regular
220 Maturity:   stable
221 Depends on: database
222 Purpose:    User location support
223
224 Name:       vm
225 Owner:      rco
226 Use:        experimental
227 Maturity:   alpha
228 Depends on: tm
229 Purpose:    Voicemail interface
230
231 Name:       xlog
232 Owner:      ramona
233 Use:        regular
234 Maturity:   stable
235 Depends on: 
236 Purpose:    formatted logging (printf style)
237
238 Contributions
239 -------------
240 Name:       domain
241 Owner:      jih
242 Use:        experimental
243 Maturity:   beta
244 Depends on: mysql
245 Purpose:    Local domain lists and related functions
246
247 Name:       enum
248 Owner:      jih
249 Use:        experimental
250 Maturity:   beta
251 Depends on: -
252 Purpose:    Enum support
253
254 Name:       domain
255 Owner:      jih
256 Use:        experimental
257 Maturity:   beta
258 Depends on: -
259 Purpose:    support for maintenance of multiple domains
260
261 Name:       mediaproxy
262 Owner:      danp, agprojects
263 Use:        regular
264 Maturity:   stable
265 Depends on: mediaproxy media relay
266 Purpose:    nat traversal
267
268 Name:       nathelper
269 Owner:      sobomax
270 Use:        regular
271 Maturity:   stable
272 Depends on: rtpproxy
273 Purpose:    nat traversal
274
275 Name:           permissions
276 Owner:          tirpi
277 Use:            experimental
278 Maturity:       beta
279 Depends on:     -
280 Purpose:        hosts.allow-like ACLs
281