build-install-freeswitch-1.10-from-source.sh

build-install-freeswitch-1.10-from-source.sh

#!/bin/bash
## Script for building/installing FreeSWITCH from source.
## URL: https://gist.github.com/mariogasparoni/dc4490fcc85a527ac45f3d42e35a962c
## Freely distributed under the MIT license
##
##
set -xe
FREESWITCH_SOURCE=https://github.com/signalwire/freeswitch.git
FREESWITCH_RELEASE=master #or set this to any other version, for example: v1.10.5
PREFIX=/usr/share/freeswitch

# If you want to remove some modules from build, specify/uncomment it here
REMOVED_MODULES=(
#   mod_signalwire
#   mog_pgsql
)

#Clean old prefix and build
sudo rm -rf $PREFIX
rm -rf ~/build-$FREESWITCH_RELEASE

#install dependencies
sudo apt-get update && sudo apt-get install -y git-core build-essential python python2-dev python3-dev autoconf automake cmake libtool libncurses5 libncurses5-dev make libjpeg-dev pkg-config zlib1g-dev sqlite3 libsqlite3-dev libpcre3-dev libspeexdsp-dev libedit-dev libldns-dev liblua5.1-0-dev libcurl4-gnutls-dev libapr1-dev yasm libsndfile-dev libopus-dev libtiff-dev libavformat-dev libswscale-dev libavresample-dev libpq-dev

#clone source and prepares it
mkdir -p ~/build-$FREESWITCH_RELEASE
cd ~/build-$FREESWITCH_RELEASE

PVERSION=( ${FREESWITCH_RELEASE//./ } )
MIN_VERSION=${PVERSION[1]}
PATCH_VERSION=${PVERSION[2]}

if [[ $FREESWITCH_RELEASE = "master" ]] || [[ $MIN_VERSION -ge 10  &&  $PATCH_VERSION -ge 3 ]]
then
    echo "VERSION => 1.10.3 - need to build libsk2, signalwire-c , spandsp and sofia-sip separatedly"

    #build and install libks2 - needed for mod_verto and signalwire
    git clone https://github.com/signalwire/libks.git
    cd libks
    cmake . -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX:PATH=$PREFIX
    make
    sudo make install
    cd ..

    #build and install signalwire-c - needed for mod_signalwire
    git clone https://github.com/signalwire/signalwire-c
    cd signalwire-c
    env PKG_CONFIG_PATH=$PREFIX/lib/pkgconfig cmake . -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX:PATH=$PREFIX
    make
    sudo make install
    cd ..

    #build and install libspandev
    git clone https://github.com/freeswitch/spandsp.git
    cd spandsp
    git checkout 67d2455efe02e7ff0d897f3fd5636fed4d54549e # workaround for @signalwire/freeswitch#2158 (thx to @9to1url)
    ./bootstrap.sh
    ./configure --prefix=$PREFIX
    make
    sudo make install
    cd ..

    #build and install mod_sofia
    git clone https://github.com/freeswitch/sofia-sip.git
    cd sofia-sip
    ./bootstrap.sh
    ./configure --prefix=$PREFIX
    make
    sudo make install
    cd ..
fi

#avoid git access's denied error
touch .config && sudo chown $USER:$USER .config
if [ ! -d freeswitch ]
then
    git clone $FREESWITCH_SOURCE freeswitch
    cd freeswitch
else
    cd freeswitch
    git fetch origin
fi
git reset --hard $FREESWITCH_RELEASE && git clean -d -x -f

#remove modules from building
for module in "${REMOVED_MODULES[@]}"
do
    sed -i "s/applications\/mod_signalwire/#applications\/mod_signalwire/g" build/modules.conf.in
done
#sed -i "s/databases\/mod_pgsql/#databases\/mod_pgsql/g" build/modules.conf.in

./bootstrap.sh

#configure , build and install
env PKG_CONFIG_PATH=$PREFIX/lib/pkgconfig ./configure --prefix=$PREFIX --disable-libvpx
env C_INCLUDE_PATH=$PREFIX/include make
sudo make install config-vanilla

#package
cd ~/build-$FREESWITCH_RELEASE
tar zcvf freeswitch-$FREESWITCH_RELEASE.tar.gz $PREFIX

Thanks for your script, I can build successfully :-)

Since the things might changed a lot, here are some I updated dependencies:

sudo apt-get update && sudo apt-get install -y git-core build-essential python-is-python3 python3-dev autoconf automake libtool libncurses5 libncurses5-dev make libjpeg-dev pkg-config zlib1g-dev sqlite3 libsqlite3-dev libpcre3-dev libspeexdsp-dev libspeex-dev libedit-dev libldns-dev liblua5.1-0-dev libcurl4-gnutls-dev libapr1-dev yasm libsndfile-dev libopus-dev libtiff-dev libavformat-dev libswscale-dev libswresample-dev libpq-dev zip

spandsp current version not able to compile , need to revert to this version:
signalwire/freeswitch#2158
git reset --hard 67d2455efe02e7ff0d897f3fd5636fed4d54549e

also no libks package can install, need to build:
sudo git clone https://github.com/signalwire/libks.git /usr/local/src/libks

*** EDIT: I managed to figure it out, I will write how I solved each part for newbies/rookies/dumb people like me :-) ***

Thank you for the updates 9to1url, I am new to this and I have been pulling my hair out for the last 2 days trying to get it to work. :(

So here are my questions:

• Well, first part pretty straight forward, I replaced the dependencies in the main script with this new list.
• When it came to spandsp, I figured out run the code in the spandsp folder and it seem to show some output without errors. Is there anything else needed to be done about this part because you had mentioned the other version didn't compile? Does that line of code automatically revert to a specified version? -->*** After applying the older version, you redo line 33 to 38 ***
• Third part, yes the script stops at the error to either install libks2 or libks (which I assumed is while executing the bootstrap.sh at line 66). I ran that clone the libks line of code. But how does one proceed from here? I could not get anything from line 69 forward to run. And when you say need to build, how do you do that? -->*** After the libks clone, you get into the cloned directory and install using cmake. Instructions are on the libks github. When finished, go back to the freeswitch directory and re-run the bootstrap script. Continue from there. ***

I am trying to get a working installation of Freeswitch to start learning about it.

@sip-stewing I follow this link to compile step by step, the command line to build all the deps:

https://gist.github.com/cyrenity/96cc1ad7979b719b1c684f90aa0f526d?permalink_comment_id=3928246

The only step I made changes is the git reset to a commit that can build. @mariogasparoni 's this script working fine after the deps installed.

@9to1url Thanks for the link. I tried it and I am getting this error during Freeswitch make

making all mod_signalwire
make[4]: Entering directory '/usr/local/src/freeswitch-1.10.7.-release/src/mod/applications/mod_signalwire'
Makefile:966: *** You must install libks to build mod_signalwire. Stop.
make[4]: Leaving directory '/usr/local/src/freeswitch-1.10.7.-release/src/mod/applications/mod_signalwire'
make[3]: *** [Makefile:719: mod_signalwire-all] Error 1
make[3]: Leaving directory '/usr/local/src/freeswitch-1.10.7.-release/src/mod'
make[2]: *** [Makefile:623: all-recursive] Error 1
make[2]: Leaving directory '/usr/local/src/freeswitch-1.10.7.-release/src'
make[1]: *** [Makefile:3544: all-recursive] Error 1
make[1]: Leaving directory '/usr/local/src/freeswitch-1.10.7.-release'
make: *** [Makefile:1292: all] Error 2

And I have already installed libks severally and seen that it is installed using "ldconfig && ldconfig -p | grep libks". Did you encounter this problem?

Yes, I encoutered this issue, as you need to see @mariogasparoni 's script has this:
PREFIX=/usr/share/freeswitch

the header file path might different than what you compiled and installed, check that

Thanks. From the link you shared, which point do I apply the prefix?

Thanks for your script, I can build successfully :-)

Since the things might changed a lot, here are some I updated dependencies:

sudo apt-get update && sudo apt-get install -y git-core build-essential python-is-python3 python3-dev autoconf automake libtool libncurses5 libncurses5-dev make libjpeg-dev pkg-config zlib1g-dev sqlite3 libsqlite3-dev libpcre3-dev libspeexdsp-dev libspeex-dev libedit-dev libldns-dev liblua5.1-0-dev libcurl4-gnutls-dev libapr1-dev yasm libsndfile-dev libopus-dev libtiff-dev libavformat-dev libswscale-dev libswresample-dev libpq-dev zip

spandsp current version not able to compile , need to revert to this version: signalwire/freeswitch#2158 git reset --hard 67d2455efe02e7ff0d897f3fd5636fed4d54549e

also no libks package can install, need to build: sudo git clone https://github.com/signalwire/libks.git /usr/local/src/libks

Thanks @9to1url . I updated the script according to your notes. This should be building fine now.
Also , i included the build for libks in this script, allowing mod_verto to be built without errors.

Yes, I encoutered this issue, as you need to see @mariogasparoni 's script has this: PREFIX=/usr/share/freeswitch

the header file path might different than what you compiled and installed, check that

@sip-stewing
By default, this script generates a zip file which you can copy/extract to install FreeSWITCH to your server.

All files will be extracted at /usr/share/freeswitch and you can run FreeSWITCH with the following command:

sudo /usr/share/freeswitch/bin/freeswitch

Thanks for the script. I just i have one question. I was getting the same issue:
"Makefile:966: *** You must install libks to build mod_signalwire. Stop."
After this step:
"sed -i "s/applications/mod_signalwire/#applications/mod_signalwire/g" build/modules.conf.in"
the compilation process finished without an error. My only question will I have signalwire module after installation? Thanks beforehand.
@mariogasparoni

@Mubariz00534 , no you won't build mod_signalwire.
Iirc , mod_signalwire requires some lib(s) , but it should be quiet trivial to add it to this script.

I might add mod_signalwire, mod_pgqsql and libvpx so this build will stay as default one (i removed these in the past because they weren't needed by that time)

@Mubariz00534 , no you won't build mod_signalwire. Iirc , mod_signalwire requires some lib(s) , but it should be quiet trivial to add it to this script.

I might add mod_signalwire, mod_pgqsql and libvpx so this build will stay as default one (i removed these in the past because they weren't needed by that time)

Thanks so much for the quick reply. I installed all necessary modules, but receiving the same error. I think it might be because of signalwire token. Starting March 17, 2022, it's(token) a must to have. Just wanted to put information here, if someone has the same issue.

Starting March 17, 2022, it's(token) a must to have. Just wanted to put information here, if someone has the same issue.

@Mubariz00534
Yes, if you don't setup your connector at signalwire.com FreeSWITCH logs/console will span a message like this:
2023-11-06 15:51:43.033566 100.00% [NOTICE] mod_signalwire.c:401 Go to https://signalwire.com to set up your Connector now! Enter connection token abcde1234-fghi567...

@Mubariz00534
I changed the script so you can build mod_signalwire by default.

Added a var REMOVED_MODULES, if you want to remove any module from building process, but it builds all by default.

@mariogasparoni, Thanks so much again for your time. I'll try new script

I'm building on a fresh installation of Debian 11. If exclude mod_verto, it works perfectly. But if I try to build mod_verto, I get this error.

mod_verto.c:46:10: fatal error: ks.h: No such file or directory
46 | #include "ks.h"
| ^~~~~~

I see there was previous chatter on this in this thread, about building libks for this. And the script seems to address this by building libks. Yet I still get the error.

I did verify that libks is in ldconfig. and it does seem to be...
debian:~# ldconfig -p | grep libks
libks2.so.2 (libc6,x86-64) => /lib/libks2.so.2
libks2.so (libc6,x86-64) => /lib/libks2.so
libksba.so.8 (libc6,x86-64) => /lib/x86_64-linux-gnu/libksba.so.8

I don't understand why make isn't picking it up. Any thoughts?

@wheatforwood , It looks like libks's headers are missing.

I tried building using debian's 11 docker container and i got no problem. Did you change something before building ?

@mariogasparoni I figured this out some time ago, but I realized I never posed back to here. So here's what I found:

• If your base OS uses OpenSSL3 (Ubuntu 22.04, RHEL9, etc) you need to use FS 1.10.10+

• FS 1.10.9 and lower requires that you to use git clone -bv1.8.3 https://github.com/signalwire/libks.git /usr/local/src/libks instead of git clone https://github.com/signalwire/libks.git /usr/local/src/libks because they require libks v1 and the default branch is now v2.

• libflite1 and flite-dev are required if you want to build mod_flite

So, my specific issue was that I was building 1.10.7, but not selecting a v1 branch for libks

Hi, I'm kind of new of coding,
Is it available to build mod_h323 or mod_opal here. I added it to modules.conf.in and when make the error happen:
making all mod_h323
make[4]: Entering directory '/root/build-master/freeswitch/src/mod/endpoints/mod_h323'
CXX mod_h323_la-mod_h323.lo
In file included from mod_h323.cpp:40:
mod_h323.h:42:10: fatal error: ptlib.h: No such file or directory
42 | #include <ptlib.h>
| ^~~~~~~~~
As freeswitch document, ptlib is required for mod_h323, so what should I do now, install more or just comment that line/

Thanks in advanced