Download & Installation Guide

From FreeSWITCH Wiki

(Redirected from Installation Guide)
Jump to: navigation, search
http://www.cluecon.com
About this image

Contents

Download Source Tarball

FreeSWITCH 1.0.3 "Phoenix" Release

Here is the much awaited FreeSWITCH™ 1.0.3 "Phoenix" tarball located at http://files.freeswitch.org/

Follow the instructions below to be a proud user:

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


Type This
./configure
 make
 make 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 (1.0.1) available at:

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

The 1.0.1 packages are pretty out of date now, it would be advised to use SVN trunk.

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

Warning

installing trixswitch will erase the hard drive!

 


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 .

Type This


If you already have a version installation and simply wish to update to the svn, do the following:

make current

svn up

And then compile as explained here.

You can download FreeSWITCH 1.0.3 release source in a tarball from the following links.

Type This


Type This


You can download the latest tagged release source in a tar-ball from the following link.

Type This


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

Type This


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

Type This
tar zxvf freeswitch-snapshot.tar.gz


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

Type This
svn co http://svn.freeswitch.org/svn/freeswitch/trunk freeswitch.trunk
 cd freeswitch.trunk
 svn propedit svn:externals . --editor-cmd=[your favorite editor here]
 remove the :81 from both externals urls
 save/exit
 svn update


Compiling the Source Code

Windows

  • Open Freeswitch.2008.sln (or Freeswitch.2008.express.sln if using VC++ Express Edition)
  • 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

Type This
./bootstrap.sh


Informational Tip

Some Linux distributions (Debian, for example) include both autoconf2.13 and autoconf2.50 along with a script called "autoconf" that automatically selects between the two. The numbers appended to the programs show which flavor of autoconf it provides, but autoconf2.50 can actually be autoconf version 2.61. bootstrap.sh checks for the version of autoconf, but the autoconf script returns version 2.13 by default. If bootstrap.sh fails with a complaint about needing autoconf 2.59 or above and you have installed the prerequisites listed below, try:


 

Type This
AUTOCONF=/usr/bin/autoconf ./bootstrap.sh


By default FreeSWITCH is installed in the /usr/local/freeswitch prefix. To configure:

Type This
./configure


If you don’t have root access add --prefix=~/freeswitch to the command. NOTE: This is a really bad idea on production systems, _not_ recommended

For configuring with ODBC support see here.

Type This
./configure --prefix=/usr/local/freeswitch


Informational Tip

Not all Debian releases have /usr/bin/gcc. Instead you can find something like /usr/bin/gcc-X.Y so ./configure will fail, if it is missing. To execute without problem ./configure, try:

Type This
ln -s /usr/bin/gcc-X.Y /usr/bin/gcc

On such a release. Remember to change X.Y with the correct numbers. It will work like a charm.


 


On ubuntu hardy, configure will complain about missing curses library. Even though libcurses5 is installed by default, that package is not usable for development:

Type This
apt-get install libncurses5-dev


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.

If you intend on building mod_fax you may want to do the following to avoid some potential problems (once its stabilized the build system will automagically do this for you)

Type This
cd libs/spandsp
 ./configure --prefix=/usr/local/freeswitch
 make all
 cd ../..


Edit modules.conf to suit your needs then run the following commands:

Type This
make all install sounds-install moh-install


You may optionally want to autogenerate a modules.conf.xml based on the build modules.conf file. There is a tool created specifically for this purpose.

Type This
scripts/contrib/trixter/makemodconf.pl modules.conf > /usr/local/freeswitch/conf/autoload_configs/modules.conf.xml


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:

Type This
cd libs/js/
make clean all
cd ../..
make

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:

Type This
make uhd-sounds-install uhd-moh-install hd-sounds-install hd-moh-install


Building deb for Ubuntu Hardy

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.

Type This
pkg_add -r autoconf261


GCC: Version 3.95 or higher

Type This
pkg_add -r gcc34


WGET: Almost any version

Type This
pkg_add -r wget


AUTOMAKE: Version 1.70 or higher

Type This
pkg_add -r automake19


GLIBTOOL: Version 1.5.14 or higher

Type This
pkg_add -r libtool


LIBNCURSES: Almost any version

Type This
pkg_add -r ncurses


SVN: Subversion

Type This
pkg_add -r subversion


Get source with wget:

Type This
cd /usr/src
/usr/local/bin/wget http://files.freeswitch.org/freeswitch-snapshot.tar.gz  
tar zxvf freeswitch-snapshot.tar.gz
cd freeswitch-snapshot

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


Or get source with SVN

Type This
cd /usr/src
/usr/local/bin/svn co http://svn.freeswitch.org/svn/freeswitch/trunk freeswitch.trunk
cd freeswitch.trunk


Build Process After downloading the source with svn or with wget

Type This
./bootstrap.sh


Edit modules.conf to enable or disable desired modules.

Type This
./configure
gmake install
gmake samples
gmake sounds-install
gmake moh-install

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

Run Freeswitch

Type This
cd /usr/local/freeswitch/bin
./freeswitch


Quick note on installations requiring spandsp and failing because of libtiff (On FreeBSD):

1. Install tiff from ports.

Type This
pkg_add -r tiff

2. Bash

Type This
export LDFLAGS=-L/usr/local/lib ; export CPPFLAGS=-I/usr/local/include


Or other shells.

Type This
setenv LDFLAGS -L/usr/local/lib
setenv CPPFLAGS -I/usr/local/include

3. Compile spandsp

Type This
( cd libs/spandsp ; ./configure ; gmake install )

4. Return to your normal FreeSWITCH build


PS: export will work if using bash. For other shells step 2 might differ. (like setenv LDFLAGS -L/usr/local/lib , setenv CPPFLAGS -I/usr/local/include)

Threading Library

There are some known issues with FreeBSD's libpthread implementation and APR that can affect throughput at high volume. A possible fix is to use libmap.conf to remap FreeSWITCH™ and its libraries to use libthr (the better performance threading library)

/etc/libmap.conf

[freeswitch]
libc_r.so.5 libthr.so.2
libc_r.so.6 libthr.so.2
libpthread.so.1 libthr.so.2
libpthread.so.2 libthr.so.2

I (Vagabond) haven't tested that this actually fixes the throughput issues because I don't have an environment where throughput is that high (50cps+ according to anthm). If anyone does test this, please update this page with your experiences. Some additional information on this problem can be found here and here, in addition please read the libmap.conf manpage for your system and be aware of the scheduler change as of 7.1 to ULE by default (this might make things better or worse, I can't find any numbers for the "new" ULE scheduler, only 2006-7 numbers).

Note: If you use 'fs_cli' and experience regular hangs of the client, you may wish to add an identical entry for it.

Note: In FreeBSD 7, libpthread has been removed and libthr is the default implementation.

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)

Type This
cp build/modules.conf.in modules.conf


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/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

Type This
./bootstrap.sh


Informational Tip

Some Linux distributions (Debian, for example) include both autoconf2.13 and autoconf2.50 along with a script called "autoconf" that automatically selects between the two. The numbers appended to the programs show which flavor of autoconf it provides, but autoconf2.50 can actually be autoconf version 2.61. bootstrap.sh checks for the version of autoconf, but the autoconf script returns version 2.13 by default. If bootstrap.sh fails with a complaint about needing autoconf 2.59 or above and you have installed the prerequisites listed below, try:


 

Type This
AUTOCONF=/usr/bin/autoconf ./bootstrap.sh


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.

Type This
export config_TARGET_CC="$(TARGET_CC)"; \
   export config_BUILD_CC="$(HOSTCC)"; \
   export config_TARGET_CFLAGS="$(CFLAGS)"; \
   export config_TARGET_LIBS="$(LDFLAGS)"; \
   export CC_FOR_BUILD="$(HOSTCC)"; \
   export CFLAGS_FOR_BUILD=" "; \
   export ac_cv_file__dev_zero=no; \
   export apr_cv_tcp_nodelay_with_cork=yes; \
   export ac_cv_sizeof_ssize_t=4; \
   export ac_cv_file_dbd_apr_dbd_mysql_c=yes; \
   export ac_cv_path__libcurl_config=/path/curl-config; \
   export apr_cv_mutex_recursive=yes; \
   export ac_cv_func_pthread_rwlock_init=yes; \
   export apr_cv_type_rwlock_t=yes; \
       ./configure \
       --target=$(GNU_TARGET_NAME) \
       --host=$(GNU_TARGET_NAME) \
       --build=$(GNU_HOST_NAME) \
       --with-libcurl=/path/install \
       --with-devrandom=/dev/urandom \
       --with-modinstdir=/mod \


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)

Type This
make


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:

Type This
make clean modwipe


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

Type This
make current
Warning

NOTE: make current will take a while as it completely cleans the build environment and rebuilds FreeSWITCH!

 


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

Type This
diff build/modules.conf.in modules.conf


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:

Type This
make mod_name-install


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

Informational Tip

That doing a "make install" will not overwrite any existing files in $(PREFIX)/conf if there already exists a $(PREFIX)/conf/freeswitch.xml file.


 


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
  • LIBZRTP: (Optional) *Note: For building with ZRTP encryption, see the page for building FreeSwitch with ZRTP

Mac OS X

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

pfSense package with GUI

pfSense FreeSWITCH package is available for pfSense 1.2.1. The package includes a GUI for FreeSWITCH's configuration. The naming convention for the GUI has been designed to closely match the XML tag names and file names used in the default XML configuration as closely as possible. Install pfSense 1.2.1 based on FreeBSD7, Then go to System -> Packages and click the '+' add button on the right to install FreeSWITCH from the packages list. The package is around 50mb because it includes 8khz sounds and music on hold. After the installation FreeSWITCH will automatically start. By default it will bind to the WAN IP.

To download pfSense 1.2.1 go to: http://www.pfsense.com/

Screenshots here: http://portableusbapps.com/images/FreeSWITCH/

The pfSense FreeSWITCH package is being used on several live systems on dedicated hardware. It also has been tested and used from VMware and the audio quality is great.

If you already have a firewall in place and just want to use this package as an easy FreeSWITCH install you can simply use it as a dedicated device and if desired turn off the firewall in pfSense by going to System -> Advanced -> Disable Firewall then put a check mark in 'Disable all packet filtering.'

A pfSense based FreeSWITCH appliance under development and coming soon.

Trixswitch ISO

NOTE: This is very old. If anyone wants to help with a new ISO please contact msc at freeswitch dot org

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

yum install gcc-c++

and also for trixswitch v.0.4 (at least)

yum install subversion
yum install make

After the foregoing are installed, you can use the "svn" i.e. subversion system to download the source as described in the main article, above.

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

Ubuntu Intrepid 8.10

If you receive a segmentation fault on FreeSwitch startup, you are likely affected by this issue: FreeSwitch_FAQ#Q:_Ubuntu_64bit_.28gutsy.2Fintrepid.29_segmentation_fault_on_start

Debian Linux

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

Type This
apt-get install build-essential subversion subversion-tools automake1.9 gcc-4.1 autoconf make wget libtool g++ libncurses5 libncurses5-dev
// for Perl integration I also had to add: libdb-dev


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.

Type This
apt-get install python2.5 python2.5-dev


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

Type This
apt-get install libgnutls-dev


For mod_fax/spandsp you need to install libtiff development files

Type This
apt-get install libtiff4-dev


For mod_skypiax (skype interconnect) to work you have to have X11 development files

Type This
apt-get install libx11-dev



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:

Type This
aptitude install build-essential

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

Type This
dpkg-buildpackage

(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:

Type This
aptitude install debhelper automake1.9 autoconf libtool unixodbc-dev libasound2-dev libcurl4-openssl-dev libssl-dev libogg-dev libvorbis-dev libperl-dev libgdbm-dev libdb-dev libgnutls-dev

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.

Type This
dpkg -i freeswitch_1.0.1-1_i386.deb freeswitch-lang-en_1.0.1-1_i386.deb freeswitch-spidermonkey_1.0.1-1_i386.deb freeswitch-lua_1.0.1-1_i386.deb freeswitch-perl_1.0.1-1_i386.deb freeswitch-sounds-music-8000_1.0.1-1_i386.deb

Installing monit with aptitude:

Type This
aptitude install monit


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.

For a Novice, Another Debian Way 1.0.2

I also found this guy's instructions rather very simple for a novice courtsey of http://madhawa.com/?p=10

RHEL/CentOS

Red Hat Enterprise Linux and its community driven equivalent CentOS both use yum as a package manager; the following installs the required prerequisites on a base install of RHEL/CentOS 5.0, 5.1 and 5.2

Type This
yum install subversion autoconf automake libtool gcc-c++ ncurses-devel make expat-devel zlib zlib-devel


You may also wish to install the following packages which allow you to enable additional FreeSWITCH modules:

Type This
yum install unixODBC-devel openssl-devel gnutls-devel libogg-devel libvorbis-devel curl-devel


Fedora

Fedora also uses yum as a package manager; the following installs the required prerequisites on a base install of Fedora 8 and 9.

Type This
yum install subversion autoconf automake libtool gcc-c++ ncurses-devel make


Informational Tip

Note: if you are building mod_xml_curl, be aware that the latest Fedora releases have a broken libcurl shipped with yum and you will end up with an unloadable mod_xml_curl module due to missing symbols. You will probably need to configure FreeSWITCH using the --without-libcurl switch, this will make the build process to download and compile its own libcurl version, and then link the mod_xml_curl module with that. This has been confirmed to be the case (as of 20090403) in Fedora 9 and Fedora 10.


 


Archlinux

Archlinux uses a unique package manager called pacman; it also has a ports-like build system called Arch Build System; The packages for FreeSWITCH (and the zaptel dependency for mod_openzap) are available at the AUR repository:

Zaptel
FreeSWITCH

To build these packages follow the instructions of the Makepkg build system.

Gentoo Linux

Warning

The FreeSWITCH ebuild has been removed from the Gentoo voip overlay, please use one of the supported binary-only distributions (or the manual installation method, if it really has to be Gentoo).

 

Or use a local overlay, I tested the following ebuilds and they work for me. --Cjc 04:48, 6 September 2008 (EDT)
There are some ebuilds available from axsentis.de.
See Gentoo bug #150527 and #233174 for more information.

Solaris

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

Type This
export PATH=/usr/xpg4/bin:$PATH



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
Type This
mkdir /opt/freeswitch; chown freeswitch /opt/freeswitch


  • Give your build and development user software installation rights
Type This
usermod -P "Software Installation" freeswitch


  • 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:
Type This
/usr/sfw/bin/wget http://dlc.sun.com/osol/jds/downloads/cbe/test/desktop-cbe-1.7.0-rc1-x86.tar.bz2
gtar xvfz desktop-cbe-1.7.0-rc1-x86.tar.bz2"


  • Install JDS-CBE
Type This
cd desktop-cbe-1.7.0-rc1
./cbe-install


  • Leave everything as default. Select the SunStudio compiler as your default compiler.
  • Download the spec-files-extra repository into a subdirectory called SFE
Type This


  • Load the jds-cbe environment.
Type This
. /opt/dtbld/bin/env.sh


  • Compile and install SFEunixodbc.
Type This
cd SFE
pkgtool --download build SFEunixodbc.spec


  • Download freeswitch trunk.
Type This


  • Prepare the freeswitch sources.
Type This
cd fstrunk; ./bootstrap.sh


  • And edit the modules.conf file to select which modules you would like to have installed.
Type This
vim modules.conf


  • Configure freeswitch sources for 64bit.
Type This
CFLAGS=-m64 CXXFLAGS=-m64 LDFLAGS=-m64 ./configure --prefix=/opt/freeswitch --enable-core-odbc-support \
--enable-core-libedit-support --enable-64 --with-openssl=/usr/sfw


  • Or for 32bit.
Type This
CFLAGS=-m32 CXXFLAGS=-m32 LDFLAGS=-m32 ./configure --prefix=/opt/freeswitch --enable-core-odbc-support \
--enable-core-libedit-support --with-openssl=/usr/sfw


  • Drink a cup of coffee.
  • Run make :).
Type This
gmake


  • Install freeswitch into its target directory.
Type This
gmake install


You are done :).

Windows

Precompiled Binaries

PLEASE NOTE: before you launch the FreeSWITCH executable, 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)

For those that do not want to compile, I've put together an MSI install file for Windows (currently SVN 14043 - 06/30/09). The MSI file is synced up every evening (CST). Direct link: http://files.freeswitch.org/freeswitch.msi

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

mod_skypiax
mod_fax
mod_cepstral (if you plan to enable this module you'll need the Windows release of Cepstral installed).
mod_pocketsphinx
mod_shout
8khz sound files
Support for SIP TLS and SRTP


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 WordPad 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 separate executable which will allow you to remotely connect to the switch: http://wiki.freeswitch.org/wiki/Fs_cli

"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] NOTE: The Visual C++ 2005 Express Edition is no longer supported. Please upgrade to VC++ 2008 Express Edition.
NOTE: There is now a solution file specifically for VC++ 2008 Express. If you open the wrong solution file you will need to click "OK" about 65 times to get through the "solution folders not supported" messages. Insert non-formatted text here

Personal tools
Community
Support FreeSWITCH