Start Here

Welcome to FreeSWITCH™, the future of telephony.

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.

Confluence Wiki

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. When a new version is released a snapshot of this online document will be copied to a static online version at the same time to provide a reference in the future to those still running older code. 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, 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.

Docs Team

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.

Newbies

Newcomers should start with the Installation and Configuration topics in the table of contents. The documentation is not perfect so we rely on your help to improve it with suggestions from a fresh viewpoint.

Books

The most rapid way to start configuring is with the FreeSWITCH Cookbook available at a discount via the freeswitch.org web site.

Search

The Confluence search function is pretty useful so use it to find answers quickly. Click the ? icon to learn about its advanced search expressions.

Community

Connect with other members of the community via the mailing list, IRC channel, and HipChat room. See the Community page for that information.

The back-end Atlassian databases have been merged to allow single sign-on. From now on please log in with your JIRA credentials to access JIRA, Confluence, Stash, Fisheye, and all other development platforms.

Because FreeSWITCH is an open source community project, if you find incorrect or outdated information you are obligated to report it to the document maintainers so that we all benefit from your keen observation. You can also help us by Contributing Documentation.