Call Us Today! 877.742.2583

Page tree

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


This is the main page describing the process of installing and performing basic testing of FreeSWITCH™ and its prerequisites on OS X.


Table of Contents


If you have not read the Mac OS X page please view it now. Installation instructions are provided for OS X 10.11, 10.10 and 10.9, instructions for older releases are no longer maintained and can be found at the Mac OS X Archive.

Testing History

For purposes of this these instructions, each OS X release was built clean, not upgraded from a prior OS X release.




                                      FreeSWITCH™ OS X Testing History

ReleaseTestedXcodeFreeSWITCH™ Version
10.12 Sierra Beta 2

July 14, 2016

July 15, 2016


1.6.9+git~20160613 Current Production Release - NOGO

1.7.0+git~20160714 Master Development - NOGO

  10.11.5 El Capitan

June 13, 2016

July 15, 2016

July 15, 2016

July 14, 2016





1.6.9+git~20160613 Current Production Release

1.7.0+git~20160714 Master Development

1.6.9+git~20160613 Current Production Release - NOGO

1.7.0+git~20160714 Master Development - NOGO

  10.10.5 YosemiteJuly 16, 2016


1.7.0+git~20160714 Master Development
  10.9.5 MavericksJuly 16, 20166.21.7.0+git~20160701 Master Development

Warnings About Upgraded Systems

Systems that were upgraded from older software may have issues due to old parts of a prior OS X or Xcode still intact. In these cases a fresh OS X and Xcode install may required.



Upgraded OS X?
Most upgraded OS X systems work depending on the level of the oldest original system. Systems upgraded from 10.7 or older may have problems due to old files left in various directories. 

Upgraded Xcode?
Most upgraded Xcode systems will work depending on the level of the oldest original Xcode. Xcode upgraded from version 4 or earlier may have problems.

Prerequisites Previously Installed Differently?
If prerequisites were previously installed using different methods than described here, there may be problems.

If there are problems installing FreeSWITCH™, check if OS X or Xcode was upgraded from a very old release. The older the original system the more likely problems will occur, you may need to build OS X from scratch.




This procedure installs a significant amount of software, all of it can be removed using the procedures at the bottom of this page. However, there may be times when parts of the Apple Command Line Tools, part of Xcode may remain. Although there is no problem leaving the CLT installed, If you want to remove them it's best to backup before starting this procedure.

Terminal Application Preferences

We'll use the Terminal application extensively during installation and to start FreeSWITCH™ initially. You should make the following changes to save time during this procedure:

  1. Copy Terminal in the Applications/Utilities folder into the Dock for quick access.
  2. Start the Terminal application by clicking it in the dock. Then open its preferences panel.
  3. In Settings–>Profiles–>Window change the Window Size to larger values such as 140x48 to reduce having to resize the window often.
  4. In Settings–>Profiles–>Window set Scrollback to "Limit to Available Memory" or a larger number. Many messages are produced that may be needed for problem analysis.
  5. In Settings–>Profiles–>Shell set Prompt before closing to "Only if there are processes other than:". This prevents the Terminal window from closing when FreeSWITCH™ is shutdown if it started automatically, which would result in the loss of all messages in the window. This is useful during debugging. If FreeSWITCH™ started manually the window does not close.


Installation of FreeSWITCH™ on OS X can be performed using the AppleScript installer, or manually. 

AppleScript Installer

The OS X FreeSWITCH™ Installer simplifies installation of FreeSWITCH™ on OS X by automating all of the manual steps, except for prompting for an administrator password. It creates command output logs which are very useful if a problem occurs. The installer can be downloaded at Installation on OS X Using AppleScript.

titleThe OS X FreeSWITCH™ Installer

Even if you use the OS X FreeSWITCH™ Installer it's a good idea to read the manual instructions so you know what the installer will add to the system.-

Manual Installation

A manual installation involves downloading and installing the following groups of software:

  • Apple Xcode that provides the tools needed to generate everything else
  • Prerequisite packages that FreeSWITCH™ needs to function
  • FreeSWITCH™ itself

Simply Follow the steps below to perform a manual installation. There is extra information for people who want it. If you're not very technical don't let the explanations intimidate you. Just follow the steps and FreeSWITCH™ should be installed in an hour or two.


OS X Developer Tools

The OS X Developer Tools are composed of two parts, the Xcode OS X Software Developer Kit used to develop and test OS X GUI applications, and the Command Line Tools that provide LLVMClangGit and other tools required to generate non-GUI applications such as FreeSWITCH™ and its prerequisites. The Command Line Tools are included and automatically installed with Xcode. The Apple Developer site offers the standalone CLT but it cannot be used because Homebrew will not install without the Xcode/CLT version.

Download and Install Xcode

Xcode takes a while to download and is placed into the Applications folder (/Applications directory) with the Command Line Tools in /Applications/

For El Capitan 10.11, download and install Xcode 7.3 using the OS X App Store application.

For Yosemite 10.10, download and install Xcode 7.2 from the OS X Developer site which requires a minimum of a free membership. After installation, follow the steps at Rename Xcode Directory (As of Xcode 7.1)

For Mavericks 10.9, download and install Xcode 6.2 from the OS X Developer site which requires a minimum of a free membership.


Once Xcode is installed make sure to complete the installation by starting Xcode and accepting the license agreement. This installs the final components.



Setup Installation Directories

OS X provides the /usr directory which contains subdirectories. This procedure adds the directory local to /usr as /usr/local where FreeSWITCH™ and its prerequisite source and runtime files are placed. These files are kept out of OS X supplied directories to allow easy removal of FreeSWITCH™ and its prerequisites.

Show Invisible Files and Directories in the Finder

OS X hides many Unix directories and files from the Finder including the directories created by this procedure. These files and directories can be unhidden so they appear on the desktop, Finder windows and file dialogs. Additional information and scripts for showing invisible files are in the Customization on OS X guide. View hidden files by running the lines below in Terminal:

Code Block
  defaults write AppleShowAllFiles YES
  killall Finder

 Create /usr Subdirectories

The user name (owner) and group name of /usr/local and it's subdirectories must match the user and group FreeSWITCH™ will run under. This is typically the main user name of the Mac. View this information (yourname and yourgroup) by running the following command in Terminal:

Code Block
  ls -l ~/

The user name and group appear in the third and fourth columns. Now create the /usr/local and /usr/local/src directories, replace yourname and yourgroup with the ones obtained from the previous command:

Code Block
  cd /usr                                   # Change to the /usr directory
  sudo mkdir local                          # Create the /usr/local directory
  sudo chown -R yourname:yourgroup local    # Modify the owner of the /usr/local directory to yours
  mkdir local/src                           # Create the /usr/local/src directory FreeSWITCH™ source will be downloaded into

You will access /usr/local often so it should be placed in the Finder "FAVORITES" sidebar for quick access. Navigate to the /usr/local folder in the Finder, then drag the local folder under "FAVORITES".

Extra info: Even though OS X did not contain the /usr/local directory, /usr/local/bin is defined at the end of the default OS X path. The path is viewed by running "echo $PATH" in Terminal. If you don't understand this, don't worry, it doesn't affect anything.



If OS X is 10.11 El Capitan or later: NEVER delete the local directory in /usr after it's created! It's very difficult to recreate, it must be restored from a backup. This is due to System Integrity Protection (aka rootless) security starting with OS X 10.11.



Prerequisite Installation Options

Additional programs are required to generate and run FreeSWITCH™. Most are installed using Homebrew, a package manager and its repository of products for OS X. Homebrew saves time since there is no need to locate packages and determine the version required for each OS X release. Homebrew's Git repository is maintained by volunteers. 

Install Package Manager and Prerequisites

The Homebrew package manager and prerequisites install in approximately 10 to 15 minutes.

Install Homebrew

Homebrew installation is simple, the install command is found at the Homebrew home page and is listed below.

  1. Open Terminal if not already opened, paste and run the ruby command from any directory.
  2. Run the command "brew doctor" to verify homebrew works, this command could take a couple of minutes.
Code Block
ruby -e "$(curl -fsSL"
brew doctor


Install Required Homebrew Packages

The basic FreeSWITCH™ prerequisite packages are installed by running the following command in Terminal from any directory:

Code Block
brew install autoconf automake curl FreeSWITCH/homebrew-freeswitch/flite jpeg ldns libsndfile libtool FreeSWITCH/homebrew-freeswitch/libvpx FreeSWITCH/homebrew-freeswitch/libyuv lua openssl opus pcre pkg-config speed sqlite yasm
Some packages produce keg-only messages which can be ignored. It means an alias (link) for the package was not placed into /usr/local/bin because brew found that OS X has another version installed. This is not a problem because the FreeSWITCH™ installation process searches Homebrew directories to find package.


Download FreeSWITCH™

OS X is now ready to download and install FreeSWITCH™.

Selecting a Version

There are two versions of FreeSWITCH™ to choose from: the current release version recommended for production systems, and master containing the latest fixes and features used during development. The current release version is recommended unless you need newer features or patches added since the current release of FreeSWITCH™. Additional Information is located at Source Options.

This documentation is tested with the master version to keep it as recent as possible and to provide feedback to the developers. If there are problems the developers may request that you install the master version for diagnosis.

Download Using Git Clone

Download FreeSWITCH™ by switching to the src directory and invoking one of the "git clone" commands below.  The git command creates the freeswitch directory in src  (/usr/local/src/freeswitch) and downloads the FreeSWITCH™ source files.

Code Block
  cd /usr/local/src
  git clone -b v1.6        # The current production release
  git clone                # The master/development release


Install FreeSWITCH™

Generate Installation and Configuration Files

This step creates installation files based on the operating system and installed packages. ./ creates many files such as modules.conf used to add optional functionality to FreeSWITCH™, while ./configure sets compilation options. Enter the following commands (each will run several minutes):

Code Block
  cd freeswitch    # <- the new freeswitch directory created by the git clone process

Add Text–To–Speech Module

Additional functionality may be required as your FreeSWITCH™ needs become more complex. Optional modules are used to add new functions to FreeSWITCH™ by editing the modules.conf file. The FLITE Text To Speech functionality is recommended for a new system since some of the sample tests require it. The easiest way to add the FLITE module is to paste and run the following line into Terminal:

Code Block
   perl -pi -e 's{#asr_tts/mod_flite}{asr_tts/mod_flite}' /usr/local/src/freeswitch/modules.conf

If you prefer to manually edit the modules.conf file use this procedure:

  1. Use the Finder to navigate to the /usr/local/src/freeswitch directory.
  2. Scroll to and double-click modules.conf in the freeswitch directory, the first time requires application selection, Textedit should be used.
  3. Search for "flite" and remove the # to uncomment.
  4. Save the file.



If this is your first FreeSWITCH™ don't add more than the FLITE module. Some modules may have prerequisites in addition to what is listed in this procedure.


Compile, Create Additional Source Directories and Check for Errors

This step compiles the programs and creates additional directories and files based on modules.conf. While still in /usr/local/src/freeswitch compile FreeSWITCH™ with the "make" command, it runs for several minutes:

Code Block

If there are no errors proceed, otherwise seek assistance from the FreeSWITCH-users mailing list

Generate FreeSWITCH™ Runtime

This creates the /usr/local/freeswitch runtime library and executable programs.

Code Block
  make install

Download and Install Sounds

There are mandatory sound prompts and optional music on hold files. All must be downloaded to run the sample IVR. There are four versions available:

  • sounds-install moh-install (8 kHz)
  • hd-sounds-install hd-moh-install (16 kHz)
  • uhd-sounds-install uhd-moh-install (32 kHz)
  • cd-sounds-install cd-moh-install (48 kHz)

The cd sounds are recommended since all the sampling rates are provided resulting in fewer problems. Invoke the following command:

Code Block
  make cd-sounds-install cd-moh-install


This optional step can be performed to save space by removing the temporary files created by make:

Code Block
  make clean

Test FreeSWITCH™!

Startup From the Command Line

The time has come to start FreeSWITCH™ in a Terminal window:

Code Block
  cd /usr/local/freeswitch/bin

There are many startup messages ending with some text boxes containing the names of the developers.

Test the FreeSWITCH™ Command Prompt

After all startup messages are displayed a command prompt appears, messages may continue as the prompt remains. Try a few FreeSWITCH™ commands:

Code Block
  sofia status

If the commands return responses FreeSWITCH™ is working and you can continue with the next step.

Test A Phone

Test using a physical SIP phone or soft phone such as Bria, or search the OS X App Store for "SIP" for a free download of Telephone. Setup the phone using the IP address of the Mac FreeSWITCH™ is running on. The port is 5060, user IDs 1000-1019 with a password of 1234 are pre-configured. Additional information is at Test CallsTest as many functions as you can to experience the potential of FreeSWITCH™.

Shutdown FreeSWITCH™

Issue the following command in the FreeSWITCH™ Terminal window:

Code Block


What Next?

Once FreeSWITCH™ has been tested it's time to customize OS X. The Customization on OS X instructions will keep you busy!


Updating FreeSWITCH™

FreeSWITCH™ may occasionally require updating due to new features, fixes, etc. To download the latest updates, compile FreeSWITCH™ and create updated runtime binaries, run the following two commands:

Code Block
  cd /usr/local/src/freeswitch
  git pull && make current

Updating Prerequisites

To update Homebrew and its formulas run "brew update" in Terminal, this should be run prior to upgrading packages. To upgrade all packages, run "brew upgrade", or to upgrade a single package run "brew upgrade package-name" command.



Removing FreeSWITCH™

Consider backing up modified or new configuration files you created! FreeSWITCH™ is completely removed by deleting the /usr/local/freeswitch and /usr/local/src/freeswitch directories using the Finder (drag to trash) or in Terminal:

Code Block
  rm -r /usr/local/freeswitch
  rm -r /usr/local/src/freeswitch

Remove Homebrew and Prerequisites

Packages installed by Homebrew are listed using the "brew list" command. They are removed using the "brew uninstall package-name" command. To remove packages and Homebrew run the following in Terminal:

Code Block
rm -rf /usr/local/Cellar /usr/local/.git && brew cleanup
sudo rm -r /Library/Caches/Homebrew   # (OS X prompts for the administrator password)


Remove Xcode

Xcode is installed as an OS X package (directory) that looks like a single application file. To remove Xcode drag the application to the trash, empty it and restart OS X.

Remove Everything Else

If the /usr/local directory existed prior to using this procedure it has to be examined to determine if the contents are deletable. If the instructions on this page were followed, and the /usr/local directory was created during this procedure, everything can be removed to roll back the system prior to using this procedure by performing these steps:

  1. Drag everything in the /usr/local directory to the trash. Or delete it in Terminal (OS X prompts for the administrator password):
Code Block
  sudo rm -r /usr/local/*

If OS X is 10.11 El Capitan or later: NEVER delete the local directory in /usr after it's created! It's very difficult to recreate, it must be restored from a backup. This is due to System Integrity Protection (aka rootless) security starting with OS X 10.11.

Hide Invisible Files and Directories in the Finder

To reverse the show hidden files step, open the Terminal application and run each line below. All hidden files will disappear from the desktop, Finder and file dialogs.

Code Block
  defaults write AppleShowAllFiles NO
  killall Finder