Skip to main content

FreeSWITCH Users Manual

This manual teaches a technically competent operator how to configure, set up, and use FreeSWITCH. It covers the configuration of FreeSWITCH: the XML configuration system, the user directory, SIP profiles, the dialplan, codec selection and negotiation, media handling, the bundled applications, WebRTC, and the integration interfaces exposed through configuration.

Every parameter, value, and default in this manual is verified against the FreeSWITCH source and the shipped default configuration.

FreeSWITCH Enterprise

FreeSWITCH is open source and free to use. FreeSWITCH Enterprise is the commercially supported edition, offering professional support and services from SignalWire. For details, contact sales@signalwire.com.

Table of Contents​

Part 1: Foundations​

Part 2: The Configuration System​

Part 3: Users and Endpoints​

Part 4: Call Routing and the Dialplan​

Part 5: Media and Codecs​

Part 6: Applications and Features​

Part 7: Integration and Control​

Part 8: Reference​

How to Use This Manual​

Read Part 1 and Part 2 first. They establish the model and the configuration mechanics that every later chapter relies on. After that, the parts are largely independent: go to the chapter that documents the subsystem you are configuring.

Conventions used throughout:

  • Inline code marks filenames, parameters, and values, for example sofia.conf.xml, auth-calls, and true.
  • Fenced code blocks contain configuration snippets that are valid against the default configuration.
  • Parameter reference tables list each parameter by name, purpose, accepted values, and default where one exists.
  • Configuration paths are written relative to the FreeSWITCH configuration root, the directory that contains freeswitch.xml (commonly /etc/freeswitch or /usr/local/freeswitch/conf).