Differences
This shows you the differences between two versions of the page.
— |
ref_manual [2009/05/05 01:36] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== Reference Manual ====== | ||
+ | <columns 100% justify top 65% -> | ||
+ | ==== About This Guide ==== | ||
+ | <note important> | ||
+ | This guide is work in progress. The guide was originally conceived as the | ||
+ | reference manual for SER 2.0 and it is currently being transformed | ||
+ | into the reference manual for the SIP Router. | ||
+ | </ | ||
+ | SIP Express Router is a free, extensible, powerful, heavy-duty SIP server. SER | ||
+ | gets typically deployed at large-scale and complex SIP server setups where | ||
+ | other solutions fail. The server features efficient, elegant, and small core, | ||
+ | powerful and flexible configuration language capable of doing things to SIP | ||
+ | messages beyond imagination. Vast collection of extension modules provides | ||
+ | additional features that can be loaded only when needed, helping to maintain | ||
+ | the server neat, clean, and sane. SER's elegant design together with an | ||
+ | efficient, extensible, and easy to integrate data model make it an ideal | ||
+ | sofware for large or complicated SIP setups on most platforms. | ||
+ | |||
+ | This reference manual attempts to describe all subsystems, parts, extension | ||
+ | modules, functions, parameters, and features of SER and its configuration | ||
+ | language. It is terse but the reference manual attempts to be complete. For a | ||
+ | shorter and easier to read introduction to SER 2.0 read the | ||
+ | [[admin_guide|Administrator' | ||
+ | < | ||
+ | ==== Table of Contents ==== | ||
+ | - **[[.ref_manual: | ||
+ | - **[[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - **[[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - **[[.ref_manual: | ||
+ | - **[[.ref_manual: | ||
+ | - **[[.ref_manual: | ||
+ | - **[[.ref_manual: | ||
+ | - **[[.ref_manual: | ||
+ | - **[[.ref_manual: | ||
+ | - **[[.ref_manual: | ||
+ | - **[[.ref_manual: | ||
+ | - **[[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - **[[.ref_manual: | ||
+ | - **[[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - **[[.ref_manual: | ||
+ | - **[[.ref_manual: | ||
+ | - **[[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - **[[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | - [[.ref_manual: | ||
+ | |||
+ | |||
+ | /* | ||
+ | Reference manual structure proposed by Greger, to be incorporated into the | ||
+ | docs here. | ||
+ | |||
+ | Table of contents | ||
+ | |||
+ | 1. Introduction to this reference manual who? | ||
+ | 2. How SER and ser.cfg works (from SER Getting Started) Greger | ||
+ | 1. SER Architecture and ser.cfg | ||
+ | 1. Core and Modules | ||
+ | 2. ser.cfgs Seven Sections | ||
+ | 3. Transactions, | ||
+ | 4. Understanding Message Processing in ser.cfg | ||
+ | 2. Stateful vs. stateless | ||
+ | 3. Understanding SIP and RTP | ||
+ | 4. Back-end applications and B2BUA | ||
+ | 5. NAT, STUN, and RTP proxy | ||
+ | 1. Registration behind NAT | ||
+ | 2. INVITEs behind NAT | ||
+ | 3. STUN | ||
+ | 4. Other non-ser NAT traversal techniques | ||
+ | 6. URI, R-URI, and Branches | ||
+ | 3. Programming in SER | ||
+ | 1. Overview of ser.cfg language Martin? | ||
+ | 2. Basic language who? | ||
+ | 1. Seven sections of ser.cfg (from SER - Getting Started) | ||
+ | 2. if - testing | ||
+ | 3. routes - execution flow | ||
+ | 3. Accessing information in SIP messages using selects Martin | ||
+ | 4. Storing information in variables (aka attribute/ | ||
+ | 1. Scope of variables (per transactions) Martin | ||
+ | 2. Retrieving configuration information from a database Martin | ||
+ | 4. SER's Management interface who? | ||
+ | 1. About the command interface | ||
+ | 2. Various methods for accessing the command interface | ||
+ | 1. Unix socket | ||
+ | 2. TCP/IP | ||
+ | 3. XML-RPC | ||
+ | 5. The UAC (client) function of the management interface who? | ||
+ | 1. What is the UAC function? | ||
+ | 2. Using the UAC function from an external application | ||
+ | 3. How SEMS uses the UAC function | ||
+ | 6. Reference (mainly a consolidation job) Greger | ||
+ | 1. How documentation is built up (parameters, | ||
+ | ule + ref. to online search tool) | ||
+ | 2. Core functions (NOTE!! use old admin guide and create like a module doc) HELP DEARLY NEEDED | ||
+ | 3. Modules (NOTE!! Consolidate current module documentation) | ||
+ | |||
+ | */ | ||
+ | </ |