Download & Installation Guide

From FreeSWITCH Wiki

Contents 1 Download Source Tarball 2 FreeSWITCH 1.0.1 "Phoenix" Release 3 Quick and Dirty Install for the Impatient Ones 4 Binary Installation or ISO CD-ROM Installation 5 Obtaining the Source Code 6 Compiling the Source Code 6.1 Windows 6.2 Unix-like systems (Linux, BSD, OS X) 6.3 FreeBSD 6.4 Cross Compiling for ARM on Linux 7 Compile Errors? 8 Rebuilding 9 Prerequisites 9.1 Unix-like systems 9.1.1 Mac OS X 9.1.2 Trixswitch ISO 9.1.3 Debian Linux 9.1.3.1 Experience compiling FreeSwitch 1.0.1 9.1.4 CentOS 9.1.5 Gentoo Linux 9.1.6 Solaris 9.1.7 OpenSolaris Nevada 9.2 Windows 9.2.1 Precompiled Binaries 9.2.2 Windows quick start 9.2.3 Voicemail via email 9.2.4 Building from source

Download Source Tarball

• Unix Source freeswitch-1.0.1.tar.gz [MD5]

FreeSWITCH 1.0.1 "Phoenix" Release

Here is the much awaited Freeswitch 1.0.1 "Phoenix" tarball located at http://files.freeswitch.org/

Follow the instructions below to be a proud user:

wget http://files.freeswitch.org/freeswitch-1.0.1.tar.gz
tar xvfz freeswitch-1.0.1.tar.gz
cd <freeswitch dir>

./configure
make all install

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/

There are unofficial Ubuntu Hardy packages available at;

deb http://ppa.launchpad.net/hads/ubuntu hardy main

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

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 appropriate for your operating system eg c:\source, /usr/local/src or /usr/src .

You can download Freeswitch 1.0.1 release source in a tarball from the following links.

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

Note that building for Windows within a tree that has previously been built for a different platform will result in numerous errors and build failures. To resolve, delete the following generated files:

• libs/apr/include/apr.h
• libs/js/config.h
• libs/js/src/jsautocfg.h
• libs/js/nsprpub/pr/include/prcpucfg.h
• libs/iksemel/include/config.h
• libs/xmlrpc/xmlrpc_config.h
• libs/libsndfile/src/sfconfig.h; also rename libs/win32/libsndfile/config.h to libs/win32/libsndfile/sfconfig.h
• libs/sofia-sip/libsofia-sip-ua/su/sofia-sip/su_configure.h

then Rebuild the solution.

Building under VS 2008 may require that you disable "Enable Minimal Rebuild" in the properties pane for FreeSwitchCoreLib project if VS reports an internal compilation error in SimpleGlob.h.

You may also need to "Enable default libraries" in the properties pane for XML Interfaces\mod_xml_rpc if VS complains of numerous unresolved external symbols, e.g., _memset, _strcmp.

After following the instructions above to build for Windows, you will need to delete "libs/js/nsprpub/pr/include/prcpucfg.h" and rerun "./bootstrap.sh" before building for another platform.

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. To configure:

If you don’t have root access add --prefix=~/freeswitch to the command. For configuring with ODBC support see here.

 

On ubuntu hardy, configure will complain about missng curses library. libcurses5 is installed by default, so just make a symbolic link:

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 run the following commands:

Suse 10.3 Note: Compiling on Suse 10.3 if you get this error:

libtool: link: `src/jsapi.lo' is not a valid libtool object
make[6]: *** [libjs.la] Error 1
make[5]: *** [/usr/src/freeswitch.trunk/libs/js/libjs.la] Error 2
make[4]: *** [all] Error 1
make[3]: *** [mod_spidermonkey-all] Error 1
make[2]: *** [all-recursive] Error 1

Try the following procedure:

I don't know why it won't build correctly on Suse 10.3 the first time around, but bkw suggested that as a workaround mid July 2008 and it seems to work for both the x86 and x86_64 platforms.

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. Note that version 2.62 does not seem to work (at the time writing at least), ./configure will fail in libsndfile if you are using that version. Version 2.61 seems to work just fine.

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

SVN: Subversion

Get source with wget:

Note: ./bootstrap.sh has already been run for Full and Release Candidate versions.

Or get source with SVN

Build Process After downloading the source with svn or with wget

Make sure you are using gmake and not make, it does not build properly with make at the moment on FreeBSD.

Run Freeswitch

Cross Compiling for ARM on Linux

These instructions were tested on Linux 2.6.18 (Centos 5) Cross compiling Linux 2.6.21 for ARM using gcc 3.4.6

All commands should be executed from within the main source repository.

Create a modules.conf. (this can be done after configure but it is convenient to do it now)

Decide if you want to include cpp code, if you are running on a small embedded system and don't want to install the 2+MBytes libstdc++.so edit Makefile.am in the root of the source repository and remove all references to switch_cpp.cpp and switch_cpp.h, there is one of each. This will also disable all of FreeSWITCH's language modules, edit modules.conf and comment out all the language modules, that is all the lines starting with "language". You can still write C applications with the cpp disabled.

I was not able to get javascript working so you should comment out languages/mod_spidermonkey* from modules.conf and comment out the line "AC_CONFIG_SUBDIRS(libs/js)" in the file configure.in. If you figure out a way to get it working update this page, I wasn't motivated as I did not intend to use it.

If you want to reduce the build time you can comment out other support libraries from configure.in, I only used and tested the following, it saves a lot of build time and I don't know if the other libraries will build: libs/srtp libs/sqlite libs/libresample libs/libedit libs/pcre libs/apr libs/apr-util libs/codec/ilbc libs/sofia-sip libs/libsndfile libs/voipcodecs I already had a version of curl cross compiled so I did not use the version that comes with FreeSWITCH.

Run this command next, it will create all the configure scripts

 

Several of the packages cannot detect capabilities of the Cross Compile environment correctly so configure needs to be called with many options to get it to work correctly. Check that the options I have match your Cross Compile environment. Prior to running this the following environment variables must be set: TARGET_CC - the cross compiler HOSTCC - the host compiler CFLAGS - CFLAGS for the cross compiler CPPFLAGS - CPPFLAGS for the cross compiler LDFLAGS - LDFLAGS for the cross compiler These environment variables also need to be set to point to the appropriate tool in the cross compiler's toolchain CC, CXX, AR, LD, GCC, AS, NM, RANLIB, STRIP, SIZE, OBJCOPY & OBJDUMP. Not sure if they are all used, but this is what worked for me.

You will need to adjust some setting to fit your environment, set the "path" in ac_cv_path__libcurl_config and --with-curl, or remove them if you use the version that comes with FreeSWITCH. Set --with-modinstdir to point to where the FreeSWITCH modules will be on the target filesystem.

If you have not done so 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 run the following command. (Your PATH must point to the cross compiler toolchain)

I found little use for make install as I didn't want the Cross Compiled version installed on the build system. You will need to copy the freeswitch binary, library and modules directly out of the build tree into where ever you need them.

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 Python integration, the following will work. Ensure you update /usr/bin/python to point at /usr/bin/python2.5 afterwards and configure will find a working Python library.

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 -i -us -uc -b (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

Experience compiling FreeSwitch 1.0.1

Another way is to first install the "build-essential" package:

Then run "dpkg-buildpackage" to build all the required .deb files:

(Start dpkg-buildpackage in the freeswitch source directory.) dpkg-buildpackage will complain about missing dependencies, use the list of missing packages as indicated above; for example:

and restart "dpkg-buildpackage" to finish building the Debian packages.

Recommend packages are freeswitch_1.0.1-1_i386.deb and freeswitch-lang-de_1.0.1-1_i386.deb, the packages freeswitch-spidermonkey, freeswitch-lua, freeswitch-perl, freeswitch-sounds-music-8000 and monit are suggested by the base freeswitch package. The package monit have to be installed from the standard repository.

Installing monit with aptitude:

Monit is used to monitor the fs process and restart it if it dies, but it won't start unless it is configured. First you have to activate it in "/etc/default/monit" with setting the value startup to 1. The second step is to uncomment "set daemon 120" in /etc/monit/monitrc and add "include /etc/monit/freeswitch.monitrc" in the end of the file. After all you should be able to start monit with the provided init-script.

Note: Once you install the packages (using "dpkg -i freeswitch_1.0.1-1_i386.deb", etc.), the installation is non-standard since freeswitch will end up in /opt/freeswitch. The configuration files will be in /opt/freeswitch/conf.

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

OpenSolaris Nevada

This is the distribution from the opensolaris.org guys, do not mix that up with os200805 which is the new OpenSolaris based distro from SUN.

• Select your development user. I will assume for the time being that the user is called freeswitch.
• Create the target directory for freeswitch

• Give your build and development user software installation rights

• log out and log back in as the freeswitch user (so that the new permissions become active)

• download and unpack the new jds-cbe beta package:

Install JDS-CBE

• leave everything as default. Select the SunStudio compiler as your default compiler.

• Download the spec-files-extra repository into a subdirectory called SFE

• Load the jds-cbe environment

• Compile and install SFEunixodbc

• Download freeswitch trunk

• Prepare the freeswitch sources

• and edit the modules.conf file to select which modules you would like to have installed

• Configure freeswitch sources for 64bit

• or for 32bit

• Drink a cup of coffee

• run make :)

• Install freeswitch into its target directory

You are done :)

Windows

Precompiled Binaries

For those that do not want to compile, I've put together an MSI install file for Windows (currently SVN 9304). Direct link: http://files.freeswitch.org/freeswitch.msi

This build includes the standard modules and libraries. In addition:

mod_cepstral (if you plan to enable this module you'll need the Windows release of Cepstral installed).
mod_flite
mod_pocketsphinx
mod_shout
8khz sound files

Before starting up FreeSwitch, make sure you have the Microsoft VC++ 2008 redistributable library installed:

http://www.microsoft.com/downloads/details.aspx?familyid=9B2DA534-3E03-4391-8A4D-074B9F2BC1BF&displaylang=en   (free download)

If you let the MSI install under the default path, it'll place everything in "C:\Program Files\FreeSWITCH". The main executable is under this folder, the MSI will setup a program group with a shortcut to this exe.

Also, this build has the mod_cepstral module compiled so if you have the Windows version of Cepstral installed you'll want to make sure you enable this module (enable it from modules.conf.xml in c:\program files\freeswitch\conf\autoload_configs). If you're coming from the Asterisk world think of the conf folder as /etc/asterisk. Since most of the config files are built from *nix machines, you'll probably need Microsoft Word to edit them.

You'll note there's a large repository of scripts under the scripts folder. All of these are examples from the src. You might be interested in checking out the wiki page I wrote up on mod_rss. It makes great use of mod_cepstral for TTS tranlations of RSS news feeds. You can replace all the references to /opt/freeswitch on that page to "C:\Program Files\FreeSWITCH".

Windows quick start

It would probably help to know some basic console commands! Once you launch the FreeSWITCH exe you will be placed in the console. From here:

"help" displays all available console commands.

"sofia status" will display all sip profiles, gateways and their status.

You can drill down and say "sofia status profile internal" to list the internal profile and all registered internal endpoints.

"show channels" will display all active sessions.

"status" gives you uptime information.

"version" will display version information.

"shutdown" will bring down the switch. You cannot exit from the initial console that starts the switch without shutting it down. There is a socket based perl script in scripts/socket folder (fsconsole.pl) which will allow you to remotely connect to the console.

"load <module>" and "unload <module" work similar to the Asterisk equivalent.

"reloadxml" is useful when editing your dialplan and can't afford to restart the server. Just be aware of some restrictions: http://wiki.freeswitch.org/wiki/FreeSwitch_FAQ#Q:_Does_reloadxml_reload_all_xml_files.3F

All of the console commands are covered on this wiki page: http://wiki.freeswitch.org/wiki/Mod_commands#Core_Commands

Finally, the Getting Started wiki page has some useful extensions to try out http://wiki.freeswitch.org/wiki/Getting_Started_Guide#Some_stuff_to_try_out.21 The default configuration includes 20 endpoint definitions in prefix\conf\directory\default (1000-1019).xml. More information on endpoints: http://wiki.freeswitch.org/wiki/Getting_Started_Guide#User_Configuration

See here to configure a trunk (gateway) - http://wiki.freeswitch.org/wiki/Getting_Started_Guide#Sample_Gateway_Configuration

And to dial out via your newly created gateway - http://wiki.freeswitch.org/wiki/Getting_Started_Guide#Dialing_out_via_Gateway

Finally, receiving inbound calls from your gateway - http://wiki.freeswitch.org/wiki/Getting_Started_Guide#Receiving_an_inbound_call_from_a_Gateway

Voicemail via email

A recent svn release of FreeSWITCH includes sending voicemail via SMTP from Windows (this was not possible before). See this page for more information: http://wiki.freeswitch.org/wiki/Windows_email

Building from source

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). [1]