Call Us Today! 877.742.2583

Page tree

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Remove Xcode download!




The manual installation steps below involve downloading and installing the following software:
  • Apple Xcode that provides Command Line Tools and Compilers that provide the tools needed to generate everything else
  • Prerequisite packages that FreeSWITCH™ needs to function
  • FreeSWITCH™ itself

It takes about one to two hours to have the sample FreeSWITCH™ configuration running on macOS. There's extra information for technical people who want it, don't be concerned if you don't understand it.



All of the software this procedure installs can be removed easily except for a small part of Xcode's Command Line Tools that can remain. However, to restore to a point where nothing was installed a backup is required.

Terminal Application Preferences

The Terminal application is used extensively during installation. The following changes are highly recommended:

  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.


Show Invisible Files and Directories in the Finder

macOS hides many Unix directories and files from the Finder including the directories created by this procedure. These files and directories must be unhidden so they appear on the desktop, Finder windows and file dialogs. Additional information and scripts for showing invisible files are in the macOS Customization guide. View hidden files by running the lines below in Terminal:
Code Block
  defaults write AppleShowAllFiles YES
  killall Finder

Directories Overview and Security


The user name (owner) and group name of the /usr/local subdirectories created by this procedure must match the user and group FreeSWITCH™ will run under. This is typically the main user name of the Mac. Use the mkdir command to create the freeswitch and src directories and the chown command to change the owner. Copy/paste these commands in Terminal, sudo will prompt for the administrator password:

Code Block
  cd /usr/local                             # Change to the /usr/local directory
  sudo mkdir freeswitch src                 # Create the FreeSWITCH™ runtime and source directories
  sudo chown -R `id -u`:`id -g` freeswitch src  # Change the owner of the two new directories to yours


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. If there are problems with the current production version, the developers may request that you install the master version or current branch for diagnosis.

Code Block
  git clone    # Master Development
  git clone –b v1.$   # Current branch, replace $ with release number - Use only if directed


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 containing the source
  ./   # <- Only needed if Master Development was download using git! Current Production does not include it.

Add Text–To–Speech Module


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


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

Code Block
  make install

Download and Install Sounds


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™!


To update master or the current branch, 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


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


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




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

the Command Line Toole

  1. Move the /Library/Developer directory to the trash. Or delete it in Terminal (macOS prompts for the administrator password):
Code Block
  sudo rm -r /Library/Developer

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 (macOS prompts for the administrator password):
Code Block
  sudo rm -r /usr/local/*

For OS X 10.11 and 10.12: NEVER delete the /usr/local directory! It's very difficult to recreate, it must be restored from a backup. This is due to System Integrity Protection (aka rootless) security.


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