Installation on OS X 10.9 Mavericks

From FreeSWITCH Wiki
Revision as of 23:57, 14 April 2014 by Mario G (Talk | contribs)

Jump to: navigation, search

Contents

Introduction

Description

This is part of the Installation and Setup on OS X guide for installing and running FreeSWITCH™. This page describes the installation of FreeSWITCH™ using the following components  Installed and tested April 11, 2014: 

  • OS X Mavericks 10.9.2 (10.9 built clean, not upgraded from a prior OS X release)
  • Xcode 5.1 and its Command Line Utilities
  • Homebrew and other prerequisites
  • FreeSWITCH™ 1.5.12b+git~20140411 development version


Some information on this page is for people who want a little more than others. If you're not too technical don't let the explanations intimidate you. Just follow the steps and FreeSWITCH™ should be installed in about an hour.

Getting Help

If you encounter problems search the web, if you can't find an answer join and post to the FreeSWITCH-users mailing list.

A Word About Security

It is not recommended to perform this procedure while logged on as root. The administrator password is required minimally, resulting in a couple of extra prompts and a safer system.


Preparation

Backup

Even though it's easy to remove FreeSWITCH™ and it's prerequisites, removing the Apple Command Line Tools is difficult at this time. 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–>Window change the Window Size to larger values such as 140x48 to reduce having to resize the window often.
  4. In Settings–>Window change Scrollback to Limit to Available Memory or a larger number. A lot of messages are produced that you may need to view.
  5. In Settings–>Shell change 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.


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 GCC, Git and other tools required to generate non-GUI applications such as FreeSWITCH™ and its prerequisites. Starting with OS X 10.9 Mavericks, the Command Line Tools are included with Xcode, or the CLT can be installed without Xcode. At this time, it is recommended to install Xcode which includes CLT and the stand-alone CLT due to the following:

  • If only stand-alone CLT are installed, Homebrew will warn that some formulae will not work. FreeSWITCH™ installation is successful.
  • If only Xcode is installed, Homebrew will request installation of the stand-alone CLT even though they are part of Xcode. (possible bug?)
  • FreeSWITCH™ installation works with the stand-alone CLT but not the Xcode only version.

This results in CLT installed in two places with no negative effects other than stand-alone CLT cannot be easily removed if at all.

Install Xcode

Install Xcode using the OS X App Store application or download it from the OS X Developer site which requires a minimum of a free membership. Xcode takes a while to download and is placed into the Applications folder (/Applications directory) with the CLT in /Applications/Xcode.app/Contents/Developer. Once installed start Xcode to accept the license agreement.

Install Stand-Alone Command Line Tools (CLT)

The stand-alone Command Line Tools should be installed after installing Xcode as follows:

  1. Open a Terminal session.
  2. Type “xcode-select --install” (without quotes), press Enter
  3. When the pop-up window displays click “Install”. The Command Line Tools will download and install in a few minutes into /Library/Developer.


Informational Tip

You can perform all editing using Textedit, however, you should become familiar with the Xcode editor. Its advantage is that it displays XML code colorized so you can find syntax errors quickly. This is ideal for editing FreeSWITCH™ XML configuration files.


 

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 viewed by opening the Terminal application and run each line below. All hidden files will appear on the desktop, Finder windows and file dialogs. Additional information and scripts for showing invisible files are in the Installation and Setup on OS X guide.

     defaults write com.apple.finder 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:

   ls -l ~/

The user name and group appear in the third and fourth columns. Create the /usr/local directory and change the owner and group of /usr/local, replace yourname and yourgroup with the ones obtained from the previous command:

   cd /usr
   sudo mkdir local
   sudo chown -R yourname:yourgroup local

Create the /usr/local/src directory FreeSWITCH™ source will be downloaded into:

   mkdir local/src
Informational Tip

You will access /usr/local quite often, it is recommended that you navigate to it in the Finder, then drag the local folder to the Finder window sidebar under "FAVORITES" so it can be accessed quickly.

If you're interested: 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.


 

Prerequisites

Prerequisite Installation Options

Additional programs are required to generate and run FreeSWITCH™. It is strongly recommended to follow the procedure on this page using the Homebrew package manager for OS X that provides a repository of products that are easy to install and remove. Homebrew uses a Git repository maintained by volunteers. Homebrew saves time since there is no need to locate packages and determine the version required for each OS X release.

Informational Tip

Alternatively, other techniques for installing prerequisites and FreeSWITCH™ can be viewed on the Installation on OS X Alternatives documentation.
This is discouraged but is made available for those who don’t want to use Homebrew.


 

Install Package Manager and Prerequisites

Using the commands below the package manager and prerequisites install in under 10 minutes.

Install Homebrew

Homebrew installation is simple, the command can be run from any directory:

  1. Go to the bottom of the Homebrew page and copy the ruby command.
  2. Open terminal if not already opened, paste and run the command
  3. Run the command "brew doctor" to verify homebrew works, this command could take a couple of minutes.

Install Required Packages

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

   brew install autoconf automake curl jpeg libtool openssl pcre pkg-config speex sqlite
Warning

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 packages.
Homebrew has never failed in all tests but if any prerequisite fails to install it must be resolved before continuing. First, check if you are using an OS X or Xcode that was upgraded, if so read the warnings at the top of the Installation on OS X Alternatives page.

 

Download FreeSWITCH™

OS X is now ready to download and install FreeSWITCH™. This takes about 20 minutes.

Selecting a Version

There are two versions of FreeSWITCH™ that can be downloaded: development and stable. The development version is used here because if there are problems the developers will request to diagnose using the development version. The development version is almost always stable and usable for normal operations. Information for the stable version is found at Which version should I use.

Download Using Git Clone

To install the most up-to-date development version, switch to the new src directory and use git to download the latest FreeSWITCH™, git will create the freeswitch directory in src and download the FreeSWITCH™ source files. Enter the following commands:

   cd /usr/local/src
   git clone git://git.freeswitch.org/freeswitch.git


Install FreeSWITCH™

Generate Installation and Configuration Files

This step creates installation files based on the operating system and installed packages. ./bootstrap.sh 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):

   cd freeswitch    <- the new freeswitch directory created by the git clone process
   ./bootstrap.sh
   ./configure

Add Text To Speech Module

Optional functions are added to FreeSWITCH™ by editing the modules.conf file. Although not required the Text To Speech functionality is recommended by adding the FLITE module. The easiest way to add the FLITE module is to paste and run the following line into Terminal:

   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.
Warning

As your FreeSWITCH™ configuration becomes more complex additional modules may be required. 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. It can run longer than 10 minutes. While still in /usr/local/src/freeswitch compile FreeSWITCH™ with the following command:

   make

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

Generate FreeSWITCH™ Runtime

This creates the final runtime binary modules which are placed into /usr/local/freeswitch.

   make install

Download and Install Sounds

There are mandatory sound prompts and optional music on hold files. All must be compiled 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:

   make cd-sounds-install cd-moh-install

Cleanup

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

   make clean

Installation is Complete!

Continue at Installation is Complete in the Installation and Setup on OS X