Introduction, Tutorials, Examples
Welcome to FreeSWITCH™, the future of telephony. You are now muted.
This online guide introduces system administrators who are new to the FreeSWITCH™ Community Project to the architecture, standards, and best practices to get you up and running quickly and to avoid trouble in the future.
Introduction to newcomers to .
|title||Search is your friend|
The sprint that copied remaining pages from the old mediawiki to Confluence has given us all the documentation fit to print, however they are not organized well. This means that the Table of Contents will look very different as pages are re-ordered to their final location. It is best to use the search function or click on a label (tag) to find related pages for now.
What Is FreeSWITCH? is an open source carrier-grade telephony platform implemented as a back-to-back user agent. Because of this design it can perform a great number of different tasks from a PBX to transit switch, TTS (text-to-speech) conversion, audio and video conferencing host, and even a VoIP telephone and more.
Newcomers should start with the Introduction page in the table of contents and follow the child pages for further information. The documentation is not perfect so we rely on your help to improve it with suggestions from a fresh viewpoint.
This online documentation wiki will parallel the ongoing development by the FreeSWITCH™ core development team in concert with contributions from the open source user community. This online reference will always track the latest version of code available from the git repository (with your help).
The wiki provides usage prototypes and examples for the channel variables, dialplan applications, and API commands that can be accessed via E.S.L. (the Event Socket Layer) with scripts written in Lua, and function calls Perl, and other languages. Pages tagged with the label "examples" provide reference information to configure and experiment with FreeSWITCH.Be sure to click on the labels to find pages that related to that topic.
Reference documentation of core API functions can be found on FreeSWITCH Tech Reference.
Many of these pages are contributed by the community over the years, some might be out of date and would benefit from your improvement. Ask for editor access to Confluence to join the party! Details can be found on the Contributing Documentation page.
The most rapid way to start configuring is with the FreeSWITCH 1.8 book. Advanced topics are covered in the FreeSWITCH 1.6 Cookbook. Those and others are available at the Packt Publishing web site.
The Confluence search function is pretty useful so use it to find answers quickly. Click the ? icon to learn about its advanced search expressions.
Connect with other members of the community via the mailing list, IRC channel, and Slack channel. See the Community page for that information.