This is the home page of the sections that describe installing and performing basic testing of FreeSWITCH™ and its prerequisites on OS X. page describes FreeSWITCH™ installation methods available for the macOS releases below. It is part of the FreeSWITCH™ macOS documentation.
To manually install FreeSWITCH™ on OS X, click a link below to view instructions. The pages link back here to continue.
|Table of Contents|
If you have not read the Mac OS X page please view it now.
Warnings About Upgraded Systems
Upgraded OS X Systems
All testing for these instructions was performed on a clean/non-upgraded OS X and Xcode system, without issues. Most upgraded OS X or Xcode systems will work depending on the level of the oldest software. Some upgraded systems had problems due to old files left in different directories.
If there are problems installing prerequisites check if the OS X release was upgraded, for instance from 10.7 or 10.8 to a newer system. The older the original system the more likely problems will occur.
Also check if Xcode was upgraded, for instance from Xcode 4 or 5 to a newer Xcode. The older the original Xcode the more likely problems will occur.
In some cases older upgraded systems had 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.
|If prerequisites were previously installed using different methods and there are problems, you should build OS X from scratch. In tests, using Homebrew or the script below worked every time on freshly installed OS X systems.|
If the OS X system is 10.9 or later, consider using the OS X FreeSWITCH™ Installer. It automates most of the steps in the release instructions below and saves a lot of time! Check it out at Installation on OS X using AppleScript.
Select OS X Release
FreeSWITCH™ installation on macOS is performed using one of these methods:
- Homebrew, the fastest method to get started. Apple Silicon version available.
- The macFI installer utility, identical to manual but faster and with installation logs.
- Manually, if you want to build from source and know every detail of the installation.
Build and Testing Status
This status does not apply to the Homebrew version. Testing is performed on Intel Macs with macOS and the latest Apple Command Line Tools installed into new volumes.
Installation is Complete
This section is used to allow the previous pages to return to this location. Do not remove this section.
Startup From the Command Line
The time has come to start FreeSWITCH™ in a Terminal window:
cd /usr/local/freeswitch/bin ./freeswitch
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:
version status 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 Calls. Test as many functions as you can to experience the potential of FreeSWITCH™.
Issue the following command in the FreeSWITCH™ Terminal window:
This is the easiest and fastest way to install FreeSWITCH on macOS. To perform a Homebrew installation use the macOS Homebrew Installation instructions.
- Easiest method to install FreeSWITCH™.
- Apple Silicon and Intel versions available.
- Support for the last three macOS versions.
- Utilizes the least disk space.
- Is provided as a runtime only version, so building optional modules from source is difficult but not usually required.
- Only provides the current production version.
- Is maintained independently from this wiki with very limited information. The information on this wiki is from testing the Homebrew version.
macOS FreeSWITCH™ Installer (macFI)
The macOS FreeSWITCH™ Installer performs identical functions as a manual installation with additions such as logging.
The macOS FreeSWITCH™ Installer automates all of the manual steps, providing much simpler and faster installation. The macFI information and download is located at macOS macFI Installation.
- The same as manual installation below.
- Much faster than manual installation performing identical steps.
- Auto renaming existing FreeSWITCH™ directories before installation to preserve them.
- Creation of logs for each installation step.
- The same as manual installation below.
A manual installation requires use of macOS Terminal to enter commands, setup directories, install prerequisites and FreeSWITCH™. To perform a manual installation use the macOS Manual Installation instructions.
- Provides access to current release, master (next test version), and updated current FreeSWITCH versions.
- Building from source provides adding optional modules easily.
- Testing is performed for this wiki so information is extensive.
- Longest method to install FreeSWITCH™.
- Utilizes more disk space than the Homebrew version.
- No Apple Silicon testing for now.