# $Id: README-MODULES,v 1.2 2006/06/30 17:01:31 bogdan_iancu Exp $

'Use' tells how deployable a module is. Regular indicates
we deploy and use this feature in our infrastructure.
Experimental tells we are still gaining operation experience.

'Maturity' is label as stable if a module has been deployed
for longer time, alpha if it is still being developed and
beta if it is under test.

'Depends on' field tells which modules the module needs. 


List of currently available openser modules:

Name:       acc
Use:        regular
Maturity:   stable
Depends on: tm, rr, mysql|postgres|unixodbc|dbtext|flatstore
Purpose:    Transaction accounting

Name:       alias_db
Use:        regular
Maturity:   stable
Depends on: mysql|postgres|unixodbc|dbtext
Purpose:    Alias with DB support (no caching).


Name:       auth
Use:        regular
Maturity:   stable
Depends on: sl
Purpose:    Common functions for digest authentication

Name:       auth_db
Use:        regular
Maturity:   stable
Depends on: mysql auth
Purpose:    Database support for digest authentication

Name:       auth_diameter
Use:        experimental
Maturity:   alpha
Depends on: auth
Purpose:    Diameter support for digest authentication

Name:       auth_radius
Use:        regular
Maturity:   beta
Depends on: auth
Purpose:    Radius support for digest authentication

Name:       avpops
Use:        regular
Maturity:   stable
Depends on:
Purpose:    avp operations, pseudo-variable support

Name:       avp_radius
Use:        regular
Maturity:   beta
Depends on: avp
Purpose:    Radius support for avps

Name:       cpl-c
Use:        regular
Maturity:   stable
Depends on: tm, sl, usrloc
Purpose:    Call Processing Language interpreter

Name:       dbtext
Use:        regular
Maturity:   stable
Depends on: -
Purpose:    Database emulation in plaintext files

Name:       dialog
Use:        experimental
Maturity:   alpha
Depends on: tm, rr
Purpose:    Dialog support, call tracking

Name:       dispatcher
Use:        experimental
Maturity:   stable
Depends on: -
Purpose:    Implements a dispatcher for incoming requests using hashes

Name:       diversion
Use:        experimental
Maturity:   alpha
Depends on: -
Purpose:    Support for the Diversion extensions (draft-levy-sip-diversion-08)

Name:       domain
Use:        regular
Maturity:   stable
Depends on: mysql
Purpose:    support for maintenance of multiple domains and related functions

Name:       enum
Use:        regular
Maturity:   stable
Depends on: -
Purpose:    Enum support

Name:       exec
Use:        regular
Maturity:   beta
Depends on: -
Purpose:    Execution of external URI processing logic

Name:       flatstore
Use:        experimental
Maturity:   beta
Depends on: -
Purpose:    Very fast accounting in flat text files

Name:       gflags
Use:        regular
Maturity:   stable
Depends on: -
Purpose:    global flags that can be changed by fifo commands

Name:       group
Use:        regular
Maturity:   stable
Depends on: database
Purpose:    Group membership checking using database

Name:       group_radius
Use:        experimental
Maturity:   beta
Depends on: -
Purpose:    Group membership checking using Radius

Name:       jabber
Use:        experimental
Maturity:   beta
Depends on: database tm
Purpose:    SIMPLE 2 Jabber gateway

Name:       lcr
Use:        experimental
Maturity:   beta
Depends on: database
Purpose:    Least Cost Routing engine

Name:       mangler
Use:        experimental
Maturity:   alpha
Depends on: -
Purpose:    Helper with SDP mangling

Name:       maxfwd
Use:        regular
Maturity:   stable
Depends on: -
Purpose:    Max-Forwards check

Name:       mediaproxy
Use:        regular
Maturity:   stable
Depends on: mediaproxy media relay
Purpose:    nat traversal

Name:       msilo
Use:        regular
Maturity:   stable
Depends on: database tm
Purpose:    Message store

Name:       mysql
Use:        regular
Maturity:   stable
Depends on: -
Purpose:    MySQL database support

Name:       nathelper
Use:        regular
Maturity:   stable
Depends on: rtpproxy
Purpose:    nat traversal

Name:       options
Use:        experimental
Maturity:   beta
Depends on: -
Purpose:    Answers server options requests

Name:       osp
Use:        experimental
Maturity:   alpha
Depends on: textops, OSP Toolkit
Purpose:    Secure, multi-lateral peering using the OSP standard

Name:       pa
Use:        experimental
Maturity:   alpha
Depends on: tm (usrloc jabber)
Purpose:    Presence agent

Name:       path
Use:        experimental
Maturity:   alpha
Depends on: rr
Purpose:    PATH support for complex routing

Name:       pdt
Use:        regular
Maturity:   stable
Depends on: database
Purpose:    Prefix to Domain translation

Name:       permissions
Use:        experimental
Maturity:   beta
Depends on: database
Purpose:    hosts.allow-like ACLs

Name:       pike
Use:        experimental
Maturity:   beta
Depends on: -
Purpose:    Excessive load detection

Name:       postgress
Use:        experimental
Maturity:   beta
Depends on: -
Purpose:    Postgress DB support

Name:       registrar
Use:        regular
Maturity:   stable
Depends on: usrloc sl
Purpose:    Registrar

Name:       rr
Use:        regular
Maturity:   stable
Depends on: -
Purpose:    Routing and Record-Routing

Name:       siptrace
Use:        experimental
Maturity:   alpha
Depends on: tm, sl
Purpose:    SIP traffic logging

Name:       sl
Use:        regular
Maturity:   stable
Depends on: -
Purpose:    Stateless replies

Name:       sms
Use:        regular
Maturity:   stable
Depends on: tm
Purpose:    SMS gateway

Name:       speeddial
Use:        regular
Maturity:   stable
Depends on: database
Purpose:    On-server speed dial facilities

Name:       statistics
Use:        experimental
Maturity:   alpha
Depends on: -
Purpose:    Routing script statistics

Name:       textops
Use:        regular
Maturity:   stable
Depends on: -
Purpose:    Message Textual Operations

Name:       tlsops
Use:        experimental
Maturity:   alpha
Depends on: -
Purpose:    Helper TLS information and control

Name:       tm
Use:        regular
Maturity:   beta
Depends on: -
Purpose:    Transaction Management

Name:       uac
Use:        experimental
Maturity:   beta
Depends on: tm, rr
Purpose:    User Agent Client functionalities

Name:       uac_redirect
Use:        experimental
Maturity:   beta
Depends on: tm, acc
Purpose:    Redirect reply processing on server

Name:       unixodbc
Use:        experimental
Maturity:   alpha
Depends on: -
Purpose:    Unixodbc DB support

Name:       uri
Use:        regular
Maturity:   stable
Depends on: database
Purpose:    Various URI checks

Name:       uri_db
Use:        regular
Maturity:   stable
Depends on: mysql
Purpose:    URI checking using DB

Name:       uri_radius
Use:        experimental
Maturity:   beta
Depends on: -
Purpose:    URI checking using Radius

Name:       usrloc
Use:        regular
Maturity:   stable
Depends on: database
Purpose:    User location support

Name:       xlog
Use:        regular
Maturity:   stable
Depends on: -
Purpose:    formatted logging (printf style)


