Documentation

From FreeSWITCH Wiki

Please read the Documentation Guidelines before creating any content. This will help ensure that the documentation will benefit all users.

Please visit the last section to find files we know need help if you want to help add documentation.

Contents 1 Documentation for Users 2 Documentation for Developers 3 Other References 4 Help maintain documentation 4.1 Known Missing Files 4.2 Known Empty Pages 5 See Also 6 Other Documentation Initiatives

Documentation for Users

The User Documentation can be found here. This section is for administrators and users of FreeSWITCH™ Here you can find configuration Examples Command reference FreeSWITCH™ init scripts Troubleshooting and debugging FreeSWITCH™ FreeSWITCH™ Channel Variables Modules FreeSWITCH™ Modules mod_dptools Dialplan Tools Networking Networking and NAT Top Links: Basic XML | Languages for Call Control | Examples

Documentation for Developers

The Developer Documentation can be found here. This section is for developers of FreeSWITCH™ Here you can find information on the structure and techniques to add to the project. Top Links: API Documentation | Authoring FreeSWITCH™ Modules | Developer Tips | Using developer interfaces

Other References

Various documents that can be useful to both users and administrators are placed here. They are generally just reference documents regarding a standard that FreeSWITCH™ as implemented, but that may not always be the case. So sit back and read something from our library. SIP Cookbook - http://mit.edu/sip/sip.edu/ SIP/IMS Reference for specific use cases at - http://www.tech-invite.com Sofia-SIP Library at - http://sofia-sip.sourceforge.net SIP tutorial at - http://www.iptel.org/sip/ VoIP, SIP, SDP, and RTP for beginners - http://www.siptutorial.net/voip/index.html SIP Forum - http://www.sipforum.org/ IMS Forum - http://www.imsforum.org/ RTP payload list Signalling standards

Help maintain documentation

Known Missing Files

If you know something about these subjects, please add it, but first make sure the document doesn't exist under a different name, we don't want multiple versions of the same information.

• Enterprise deployment MediaProxy
• Enterprise deployment SS7
• Freeswitch IVR Originate
• mod_event_test
• mod_g726
• mod_ivrtest
• mod_ldap
• mod_lpc10
• mod_sndfile
• ODBC.numRows
• ODBC Configuration

Known Empty Pages

These pages exist but have no content, please help out and fill in the missing content!

• Misc._Dialplan_Tools_displace
• Misc._Dialplan_Tools_strepoch

See Also

• Common Acronyms

Other Documentation Initiatives

The documentation is not yet complete but is being worked on. Currently, the documentation is distributed among:

• This wiki
• The project web site at: http://www.freeswitch.org
• Some documentation under source control such as: http://fisheye.freeswitch.org/browse/freeswitch-git/INSTALL
• A new effort is being made to create a real set of docs: http://svn.freeswitch.org/svn/freeswitch-docs/trunk