Installing Voiceglue: Two Ways

There are two ways to install Voiceglue. The easy way, and the hard way. The easy was has the advantage of being, well, easy, but has the disadvantage of supporting only a small number of configurations and a small number of platforms. The hard way is, well, harder, but has the advantage of potentially being able to support any unix-y system in arbitrary configurations.

If you're fine with running Voiceglue on the same box as Asterisk and are going to run it on Ubuntu 8.04 or 8.10 or Fedora 9 or 10, then by all means try the easy method.

The Easy Way

The easy way is mostly automatic. Voiceglue provides a script that should get everything installed and running in one shot. Before the script can run, however, you have to do some preparation work.

Prerequisites

The prerequisites must be satisfied before installing Voiceglue.

Supported Platform

You must be installing on one of the following platforms:

Ubuntu 8.04 (Hardy)
Ubuntu 8.10 (Intrepid)
Ubuntu 9.04 (Jaunty)
Fedora 9
Fedora 10

Voiceglue has been tested and runs on both 32-bit and 64-bit versions of these OSes.

Make sure you have well installed all packages of asterisk (asterisk-addons-1.4 for asterisk 1.4 for example)

We strongly recommand to follow these steps :

cd /usr/src

wget http://downloads.digium.com/pub/asterisk/asterisk-1.4-current.tar.gz

wget http://downloads.digium.com/pub/asterisk/asterisk-addons-1.4-current.tar.gz

tar xzvf asterisk-1.4-current.tar.gz

tar xzvf asterisk-addons-1.4-current.tar.gz

Compile Asterisk:

cd /usr/src/asterisk-1.4.2

make clean

./configure

make menuselect ⇒ you have to select these packages : (if you got an error message like ncurses isn't installed, but you already have installed it, do this : make distclean and ./configure)

'Core Sound Packages' : select all EN packages (if you want to have tts in english)

'Music on Hold File Packages' : select all EN packages

'Extra Sound Packages' : select all EN packages

make

make install

make samples

make config

Compile the add-on's

cd /usr/src/asterisk-addons

make clean

./configure

make

make install

make samples

Asterisk Installed

You must have Asterisk installed somehow. The Voiceglue installer doesn't check for an asterisk package, so it's fine to install it from source if you want to.

Supported versions of Asterisk are:

Asterisk 1.2
Asterisk 1.4
Asterisk 1.6

The "asterisk" user

The “asterisk” user must be present. This user is what the voiceglue process runs as because it needs to share audio files with Asterisk. It is legal, even with the easy way, to have Asterisk installed on a separate machine from Voiceglue, but the “asterisk” user must be present on the voiceglue host, and should match the uid/gid of the “asterisk” user on the Asterisk host.

Required Packages

There are several software packages that Voiceglue requires. The installer looks for them as packages in the system (debs for Ubuntu, rpms for Fedora) so they must be installed that way. For Ubuntu you use apt/synaptic, for Fedora you use yum/yumex. Here's the list of what's required on each of the supported platforms:

Package	Ubuntu 8.04	Ubuntu 8.10 - 9.04	Fedora 9 or 10
gcc/g++	gcc g++	gcc g++	gcc-c++
libc++			libstdc++-devel
xerces-c	libxerces28-dev	libxerces-c2-dev	xerces-c-devel
SpiderMonkey	libmozjs-dev	libmozjs-dev	xulrunner-devel
flite	flite	flite	flite
sox	sox	sox	sox
libsox-fmt-all	libsox-fmt-all	libsox-fmt-all
wget	wget	wget	wget
openssl	libssl-dev	libssl-dev	openssl-devel
XML::LibXML	libxml-libxml-perl	libxml-libxml-perl	perl-XML-LibXML
BSD::Resource	libbsd-resource-perl	libbsd-resource-perl	perl-BSD-Resource
Module::Build	libmodule-build-perl	libmodule-build-perl	perl-Module-Build
FFTW 3	libfftw3-dev	libfftw3-dev	fftw-devel
Test::More			perl-Test-Base
pkg-config	pkg-config	pkg-config	pkgconfig

If an entry is blank, it means I didn't have to install that package from a base system because it was already present, so you probably won't have to either.

Download and Unpack Voiceglue

After prerequisites are installed, download and upack the voiceglue distribution. It can always be found at http://voiceglue.org by clicking on the “Download” tab at the top.

I'm assuming that downloading and unpacking a tar file is not hard for a voiceglue user. After all, you installed Asterisk, didn't you? :-)

Running the install script

From within the top-level voiceglue directory (the one containing doc), run the following command as root:

doc/install-voiceglue

It first checks the prerequisites listed above, then if those are satisfied, builds and installs all of the software required for Voiceglue. Check the output for errors.

After the script runs to completion,. you should have the following services ready to run with their init scripts in /etc/init.d/:

dynlog
phoneglue
voiceglue

These scripts can be called manually (but don't until you read the user guide), however it's more common to let them run automatically on system boot. On Fedora systems, you may need to run chkconfig to activate them on at boot-time.

These services must be brought up in the order shown above, and brought down in the reverse order. Their install scripts will do this automatically on system startup and shutdown.

If you have many errors with parsing etc/asterisk.conf, you just have to copy past asterisk.conf from /etc/asterisk to /etc.

If you have error with option in asterisk.conf, you just have to empty asterisk.conf's option (even if they are commented).

Uninstalling voiceglue

If you want to get rid of everything that voiceglue installed (which can be useful for re-installs too in case you're using something like checkinstall to create packages and you want all files re-installed even if they didn't change) you can run the supplied uninstall script.

From within the top-level voiceglue directory (the one containing doc), run the following command as root:

doc/uninstall-voiceglue

The Hard Way

Prerequisites

The prerequisites are the same as for the easy way, except that you are not necessarily restricted to the platforms listed there, and the software packages don't necessarily need to be installed as the package format of choice for the distribution.

Voiceglue Contents

The Voiceglue distribution contains the following top-level directories:

Directory	Contents
Cam-Scom	perl library for IPC
doc	documentation and install script
dynlog	perl programs providing unified log collection
libvglue	voiceglue C/C++ libraries
openvxi-3.4+vglue	voiceglue-modified openvxi 3.4 C/C++ library
phoneglue	perl program providing high-level Asterisk interface
Satc	perl library for phoneglue communication
SRGSDTMF	perl library for processing SRGS DTMF grammars
Vgluefftw	perl library for FFTW access
voiceglue	perl program providing voiceglue interface
Voiceglue-Conf	perl library for voiceglue configuration
Vxglue	perl library for interfacing to openvxi

Each of these items (except doc) must be installed.

Installing Voiceglue

The order in which the software components must be installed is:

Cam-Scom
dynlog
Vgluefftw
Satc
Voiceglue-Conf
phoneglue
SRGSDTMF
libvglue-headers
openvxi-3.4+vglue
libvglue
Vxglue
voiceglue

Installing Perl Libraries

Each perl library can be installed with the following sequence of actions:

Change to that directory
Run: perl Build.PL
Run: ./Build install

Installing Programs

Each program can be installed with the following sequence of actions:

Change to that directory
Determine which Makefile is appropriate for your situation
Run: make -f Makefile install

Installing libvglue-headers

The libvglue software is installed in two steps. The first step installs just the headers:

Change to that directory
Run: make install-headers

Installing libvglue

When it's time to install libvglue binaries, do:

Change to that directory
Run: make install

Installing openvxi-3.4+vglue

This is the most challenging install step, as it consists of a large number of C/C++ modules that have dependencies on several system libraries.

First, look at the exports file at the top level. It contains the following definitions:

SWISBSDK - The top-level directory of OpenVXI
XERCESDIR - The directory containing the Xerces-C distribution
SPIDERMONKEYDIR - The directory containing the Mozilla SpiderMonkey distribution
JSCFLAGS - The CFLAGS used for compiling against SpiderMonkey
JSLIBFLAGS - The library flags for linking against SpiderMonkey

These definitions have to all be correct and loaded into environment variables for the following steps to work.

Next, look at the build-openvxi script in the same top-level directory. It encodes the steps to build OpenVXI. Hopefully, with proper settings in exports, it will run successfully.

Finally, the install-openvxi script in the same top-level directory installs the compiled OpenVXI library files and runtime support files to their system destinations.