Installation Guide

From FreeSWITCH Wiki

Contents 1 FreeSWITCH RC3 packages 2 Quick and Dirty Install for the Impatient Ones 3 Binary Installation or ISO CD-ROM Installation 4 Obtaining the Source Code 5 Compiling the Source Code 5.1 Windows 5.2 Unix-like systems (Linux, BSD, OS X) 5.3 FreeBSD 6 Compile Errors? 7 Rebuilding 8 Prerequisites 8.1 Unix-like systems 8.1.1 Mac OS X 8.1.2 Trixswitch ISO 8.1.3 Debian Linux 8.1.4 CentOS 8.1.5 Gentoo Linux 8.1.6 Solaris 8.2 Windows

FreeSWITCH RC3 packages

FreeSWITCH RC3 RPM packages are located at http://files.freeswitch.org/RPMS/

This guide will discuss how you can obtain FreeSWITCH™ and if you decide, instructions to build FreeSWITCH™ from source. Once you have built FreeSWITCH™ you are encouraged to read the Getting Started Guide for information on configuration and use of the FreeSWITCH™ communications platform.

Quick and Dirty Install for the Impatient Ones

If you are impatient and know Linux at least moderately well then hop over to the quick and dirty install page!

Binary Installation or ISO CD-ROM Installation

The FreeSWITCH™ project maintains binary packages for a number of Linux distributions on the openSUSE Build Service. All external dependencies required by these FreeSWITCH™ packages are either part of the base Linux distros or available in the repository at: http://software.opensuse.org/download/network:/telephony/

Another option is the trixswitch ISO install package, a CentOS-based CD-ROM image that creates a boot CD that will automatically install CentOS, FreeSWITCH™, and the WikiPBX web GUI.

If your preferred Linux distro and version is listed there, then we recommend you use these packages. If however you wish to build the source yourself, continue reading.

Obtaining the Source Code

Ensure that you have met the dependencies listed below. Once that is completed, you have two methods to obtain the source code. Via subversion (svn) or by downloading a tarball. Subversion provides access to the latest features and bug fixes, while the tarballs are created nightly. There are subversion clients for windows as well as Unix-like systems. This document assumes that you are using a command-line subversion client. You will want to save the source somewhere convenient, execute the following from the directory you wish to save the code into, eg c:\source or /usr/src for example.

You can download the latest tagged release source in a tarball from the following link.

Or you may download other tarballs from marked releases or binary releases from the following link

If you download the tarball you will need to untar it, in Windows you may use a tool like WinZip Unix-like systems come with tar preinstalled (and most modern ones with gunzip). If you are in a Unix-like system execute the following:

If you are facing problems because of web proxy you could try something like this:

Compiling the Source Code

Windows

• Open Freeswitch.sln
• Right click the main solution node at the top of the Solution Explorer
• Right click and select Build

Unix-like systems (Linux, BSD, OS X)

All commands should be executed from within the main source repository. If you downloaded a tarball you may skip this step, jumping to ./configure

 

By default FreeSWITCH is installed in the /usr/local/freeswitch prefix, however if you don’t have root access add --prefix=~/freeswitch to the command given below. For configuring with ODBC support see here. To configure:

 

You should now create a modules.conf.

Edit modules.conf so that it will build the modules you desire. If you are unsure, leave this to the defaults. FreeSWITCH™ comes with a good set of modules as the default, until you become more familiar with FreeSWITCH™ it is advised that you not edit modules.conf. A # at the beginning will omit that module from being built. A list of the modules can be obtained from the Modules page.

Once you are done configuring the build environment you need to:

There are also higher bitrate sounds available for download and installation with:

FreeBSD

Installing FreeBSD dependencies:

SVN: Several Choices.

GNUMAKE: The GNU version of make. (will be installed automatically as a dependency to autoconf)

AUTOCONF: Version 2.50 or higher

GCC: Version 3.95 or higher

WGET: Almost any version

AUTOMAKE: Version 1.70 or higher

GLIBTOOL: Version 1.5.14 or higher

LIBNCURSES: Almost any version

Build Process Download the src with svn or with wget

Run Freeswitch

Compile Errors?

Did you get any compile errors or notice any bugs? Remember FreeSWITCH is still in development and requires contribution from everybody. If you encounter a bug please file a bug report at http://jira.freeswitch.org or email freeswitch-dev@lists.freeswitch.org (we prefer that you use Jira so that we can track all issues). Sometimes bugs are fixed by the time you notice them, if you do encounter a bug you may wish to get a more recent version of the source code and rebuild.

Rebuilding

After doing a "svn update" or changing some source files, you may want to clean out your build area. To ensure that your build is clean, you should execute:

Alternatively, you can simply execute "make current" which will handle the svn up, clean up, and rebuild in one step:

Also, the clean targets leave the "modules.conf" file. To see if there are any new modules you may want to execute

Once you are satisfied with your options, follow the build directions above. If you have enabled a module that was not previously enabled, and you want to build just that module, or rebuild one that has changed, you may execute the following:

where mod_name is the name of the module you wish to rebuild.

 

Prerequisites

In order to build FreeSWITCH™ from the source code, you will need to have several tools installed. The list varies from platform to platform, and are listed here. Some distributions come with these requirements while others require you to obtain them.

Unix-like systems

• SVN: an SVN client gives you access to the current code repository. Alternatively you may select to get a nightly tarball of the source instead of using SVN.
• GNUMAKE: The GNU version of make.
• AUTOCONF: Version 2.50 or higher
• AUTOMAKE: Version 1.70 or higher
• GLIBTOOL: Version 1.5.14 or higher
• GCC: Version 3.95 or higher
• WGET: Almost any version
• LIBNCURSES: Almost any version

Mac OS X

You will need to install the Apple XCode development software (which requires registration, but is free). This should be performed first.

One easy way to install any missing tools is by using Fink. Fink is a MacOS X tool that allows you to download convenient, pre-compiled binaries as well as source code for over 1,700 software packages.

The standard "fink install" includes the 1.5.10 version of glibtool, in order to get the 1.5.14 or later version, you must tell Fink to use the unstable branch (fink.conf man page), which then leads to an automatic download and install of the latest glibtool version.

However you install these tools, you will need to make certain they're on your PATH.

Trixswitch ISO

To work with souce, you will need to install the c++ compiler: yum install gcc-c++

Then, you must run the following files to install automake,autoconf, and libtool:

fixlibtool.sh fixautomake.sh fixautoconf.sh

You can find these scripts in freeswitch/bin/trunk/build/

If you do wind up installing gcc-c++ after an aborted build, you must start back at the beginning with ./configure

Debian Linux

Debian uses the aptitude a.k.a. “apt” package manager. This allows you to quickly and easily install the prerequisites.

For TLS to work (needed to use Dingaling with gmail.com), also GNUTLS is necessary.

The source tree includes a debian/ directory, so you can build a package using standard debian tools. First, do the svn checkout into a directory named after the version in the debian/changelog (i.e. freeswitch-1.0~beta3) or move it there immediately after the svn checkout. Then you still need to start with the ./bootstrap.sh step, and once done you SHOULD NOT move the directory, as explicit paths will have been inserted into some of the Makefiles (don't run bootstrap.sh if you are going to use the debuild tool since its not needed, it will do it for you).

One of the several ways of then building the package is:

• ensure that you have the devscripts package installed.

• Then (optionally) change the package version to something that includes the SVN version you're building. This can be done by running dch -i and setting the version to something like: 1.0~beta3-0~svn7245

• Perhaps (if you know what you're doing) edit the modules to build that are set near the start of debian/rules

• then just run debuild (which might tell you that there are some build dependencies missing, in which case, just install them and try again)

After that, you should have a several .deb files in the directory above the source directory which can be installed with dpkg -i packagename.deb

CentOS

CentOS uses yum as a package manager; the following installs the required prerequisites on a base install of CentOS 5.0 and 5.1.

Gentoo Linux

Solaris

Solaris use the jds-cbe environment or fix path to working tr (as per FSBUILD-30).

• Use SunStudio 12
• Install SFE (Spec Files Extra)
• Add SFEunixODBC to your Solaris installation

Windows

To compile FreeSWITCH on Windows, you will need Visual C++ 2005 and if you are installing the Express Edition, the platform SDK (see these instructions for more details).