This page describes the process of installing, updating and removing FreeSWITCH™ and its prerequisites on macOS using the Terminal application instead of the macFI. This page is part of the FreeSWITCH™ macOS documentation.
What You Should Already Know
You must know your way around the macOS Finder, Dock and Textedit. You should also be familiar with the standard macOS folders (directories) such as Applications, Utilities, Downloads, Users, etc.
New To You
A new folder (directory) named /usr/local, it's part of the Linux/UNIX standard directories. We'll also use the Linux/Unix commands: cd, mkdir, ls, cp, mv,chmod, chown, and sudo. You don't need to learn about them unless you change the steps or directories used in this document.
- Apple 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 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. However, to restore to a point where nothing was added or changed, a backup is required.
Terminal Application Preferences
The Terminal application is used extensively during installation. The following changes are highly recommended:
- Copy Terminal in the Applications/Utilities folder into the Dock for quick access.
- Start the Terminal application by clicking it in the dock. Then open its preferences panel.
- 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
Directories Overview and Security
All FreeSWITCH™ and prerequisite files are placed into the macOS provided /usr/local directory which is normally empty and intended for additional software such as FreeSWITCH™. Having a single location allows easy removal. This procedure adds the following subdirectories to /usr/local:
- FreeSWITCH™ source located in /usr/local/src
- FreeSWITCH™ runtime located in /usr/local/freeswitch
- FreeSWITCH™ prerequisite source and runtime directories in /usr/local
The /usr/local directory is protected by System Integrity Protection (aka rootless) and cannot be removed or changed. Subdirectores of /usr/local can be added or removed using administrator authority. The subdirectories can then have their security changed so that non-administrators can modify them.
Create /usr/local Subdirectories
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:
If you would like to see the ownership and permissions of directories and files use the "ls -l" command in Terminal.
Since /usr/local is accessed often, it should be placed in the Finder "FAVORITES" sidebar for quick access. Use the Finder to navigate to the /usr/local folder and drag it under "FAVORITES".
Extra info: /usr/local/bin is defined in the default macOS 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.
Additional programs are required to generate and run FreeSWITCH™. They are installed using Homebrew, a package manager and its repository of products for macOS. Homebrew saves time since there is no need to locate packages and determine the version required for each macOS release. Homebrew's Git repository is maintained by volunteers.
macOS Developer Tools
Generation of FreeSWITCH™ and its prerequisites require the macOS Developer Command Line Tools that provide LLVM, Clang, Git and other tools required to generate non-GUI applications. The Xcode Software Developer Kit used to develop macOS GUI applications already includes the CLT. This is not something you need to worry about because if:
- Xcode and CLT are not already installed Homebrew will download and install the Command Line Tools during Homebrew installation.
- You are using the latest macOS and Xcode is installed, the correct CLT is already installed.
- You are using a macOS prior to the latest release and Xcode is installed you may have the wrong CLT. That's because when Apple upgrades Xcode, only the latest release of macOS CLT are usually supplied. If macOS is not the latest release, the CLT may not match. Homebrew will determine if the correct Command Line Tools are already installed. If not, it will download and install them during Homebrew installation.
Install the Homebrew Package Manager and Prerequisites
The Homebrew package manager and prerequisites takes several minutes to install.
Homebrew installation is simple, the install command is found at the Homebrew home page and is listed below.
- Open Terminal if not already opened, paste and run the ruby command from any directory.
- Run the command "brew doctor" to verify homebrew works, this command could take a couple of minutes.
Install Required Homebrew Packages
The basic FreeSWITCH™ prerequisite packages are installed by running the following command (copy/paste the entire line) in Terminal from any directory:
Already had some prerequisites installed?
If non-Apple compilers are installed, or prerequisites were installed without homebrew, there may be problems.
macOS is now ready to download and install FreeSWITCH™. First, change to the directory the source will be downloaded into:
Selecting a Version
The primary FreeSWITCH™ releases are: Current production, recommended for production systems. Current branch, contains in-test fixes since current production, intended as the next maintenance release. Master development, containing the latest fixes and features, intended as the next major release. Additional Information is located at Source Options.
Download Current Production
Current production FreeSWITCH™ versions in zip format are downloaded from freeswitch-files, then rename and move the unzipped directory to /usr/local/src. It's much easier to copy/paste the long line below into the Terminal command line. This single line performs: 1- Determines the latest production release available. 2- Downloads the compressed source file. 3- Decompresses the file into a folder in the current directory (should be /usr/local/src/). 4- Renames the folder to freeswitch.
If there are problems with the current production version, the developers may request that you install the current branch or master development for diagnosis.
Download Current Branch
The git command creates the freeswitch directory in src (/usr/local/src/freeswitch) and downloads the FreeSWITCH™ source files, replace # with the release number.
Download Master Development
The git command creates the freeswitch directory in src (/usr/local/src/freeswitch) and downloads the FreeSWITCH™ master development source files.
Generate Installation and Configuration Files
First, change to the newly created freeswitch directory containing the source:
Perform the next line only if current branch or master development were download. It creates many additional installation files based on the operating system. For instance, modules.conf used to add optional functionality to FreeSWITCH™. The command will run several minutes:
This step determines if the correct prerequisites are installed and sets compilation options. It will run several minutes:
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:
If you prefer to manually edit the modules.conf file use this procedure:
- Use the Finder to navigate to the /usr/local/src/freeswitch directory.
- Scroll to and double-click modules.conf in the freeswitch directory, the first time requires application selection, Textedit should be used.
- Search for "flite" and remove the # to uncomment.
- 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:
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.
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:
This optional step can be performed to save space by removing the temporary files created by make:
The time has come to start and test FreeSWITCH™ using the macOS Testing and Diagnostics instructions.
FreeSWITCH™ may occasionally require updating due to new features, fixes, etc. To update current production, download and install the latest maintenance level.
To update master or the current branch, download the latest updates, compile FreeSWITCH™ and create updated runtime binaries, run the following two commands:
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.
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:
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:
Remove the Command Line Toole
- Move the /Library/Developer directory to the trash. Or delete it in Terminal (macOS prompts for the administrator password):
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:
- Drag everything in the /usr/local directory to the trash. Or delete it in Terminal (macOS prompts for the administrator password):
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.
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.