Install
Please follow the steps to install and configure your own VXI* system:
- Install Asterisk from sources
- Install Asterisk from package
- Check Asterisk Setup
- Start/Stop Asterisk deamon
- Install VXI* from package
- Check VXI* Setup
- Start/Stop VXI* daemon
- Command line for VXI*
- Commercial License activation
- Configure your first VoiceXML service
- Configure Text-to-Speech
1. Install Asterisk from sources
The Asterisk source code can be obtained either through FTP/HTTP or SVN.
The VXI* VoiceXML browser was tested with a Digium standard Open Source Asterisk 1.2 and 1.4, please go to: http://www.asterisk.org/downloads
This URL contains the source code to the base files of the Asterisk Open Source PBX.
The file downloaded will need to be extracted before compiling. Use the GNU tar application to extract the source code from compressed archive.
This is a simple process that can be achieved through the use of the following commands :
# cd /root/src
# tar zxvf asterisk-*.tar.gz
Subversion is the best way to keep on the bleeding edge of source releases. If you are wanting to help develop for the Asterisk project, you will want to use SVN to get the most up-to-date source code.
Commands to check out code from our SVN repository:
# cd /root/srcCommands to get the current snapshot from the release branch of SVN:
# svn checkout http://svn.digium.com/svn/asterisk/trunk asterisk
# svn checkout http://svn.digium.com/svn/asterisk/branches/1.2 asterisk-1.2
You can check out the source at any level of the file system. This includes something like svn checkout http://svn.digium.com/svn/asterisk. However, it would be a bad idea to do so, because you will end up checking out the code for every branch and tag that exists in the asterisk repository. Make sure you are careful when checking out the code!
Asterisk is compiled with gcc through the use of GNU make program. To get started compiling Asterisk, simply run the following commands (replace version with your version of Asterisk).
# cd /root/src/asterisk-version
# make clean
# make
# make install
# make samples
Run the “make samples” command to install the default configurations files. Installing these files (instead of configuring each manually) will allow you to get your Asterisk system up and running much faster.
If your are using a system that makes use of /etc/init.d directories, you may wish to run the “make config” command as well.
This will install the startup scripts and configure the system to execute Asterisk automatically at startup.
2. Install Asterisk from package
We give you an Asterisk PBX already compiled and packaged. The package install a tiny system with some default configuration files.
It is the best way to get your Asterisk system up and ready to run.
Use root user to untar the Asterisk package by using the command:
# tar xvzf asterisk_Vx.x.x_date.tar.gz # cd asterisk_Vx.x.x_date
# ./install.sh
IMPORTANT NOTE:
If your Asterisk is already installed or your are installing from sources please check your are using:
Asterisk 1.2 => VXI* 1.4 package
Asterisk 1.4 => VXI* 1.5 or 2.X packages
3. Check Asterisk Setup
Start Asterisk on your server using the command.
# asterisk –cvvvvv
The number of v’s doesn’t really matter, the more there are the more verbose asterisk will be in its display, but don’t omit the c from the end. When you do this you will see a great deal of information scroll past quite quickly, don’t worry about this, just wait until you get a prompt like :
CLI*>
To see the installed version:
CLI*> show version
First testing call (echo test), using a SIP phone.
SIP:600@<your server IP address>
4. Start/Stop Asterisk deamon
Our packages install a startup script, /etc/init.d/asterisk.
You may also use this script to control Asterisk from the Linux command line:
# /etc/init.d/asterisk start
# /etc/init.d/asterisk restart
# /etc/init.d/asterisk stop
# /etc/init.d/asterisk status
IMPORTANT NOTE:
This startup script runs only for DEBIAN/UBUNTU Linux distributions pleas modify or install a correct file to launch correctly VXI* from other systems. We provide a script to run VXI* with the actual, AsteriskNOW linux distribution from Digium.
5. Install VXI* from package
Use root to install VXI*.
Unzip and untar the openvxi package by using the command:
# tar xvzf openvxi_V1.1_date.tar.gz
Go to the directory of the openvxi and type the following command.
# cd openvxi_V1.1_date
# ./install.sh
IMPORTANT NOTE:
VXIasterisk is now using new libraries and compiler version, before installing the VoiceXML browser please check your Operating Systems has the a GCC3 o GCC4 libraries environment :
VXI* 1.4 is build with SARGE = GCC3.3 / libstdc++5
VXI* 1.5 is build with SARGE = GCC3.3 / libstdc++5 or ETCH = GCC4 / libstdc++6
VXI* 2.0 is build with SARGE = GCC3.3 / libstdc++5 or ETCH = GCC4 / libstdc++6
VXI* 2.1 is build with SARGE = GCC3.3 / libstdc++5 or ETCH = GCC4 / libstdc++6
VXI* 2.2 is build with ETCH = GCC4 / libstdc++6
VXI* 3.0 is build with ETCH = GCC4 / libstdc++6
6. Check VXI* Setup
At the end, if everything is OK you will have one more application added – Vxml.
You can check this by starting (or restarting) the Asterisk and using the show applications command.
# asterisk –r
CLI*> help vxml
To show the license status (DEMO) use only one channel:
CLI*> vxml show license
7. Start/Stop VXI* deamon
The VoiceXML browser software is installed in /usr/sbin and /usr/lib/openvxi. The VoiceXML browser setup script on Linux is /etc/init.d/openvxi. The openvxi script calls the /usr/sbin/safe_openvxi executable that functions as a monitor and auto-loader for your VoiceXML browser system. This safe_openvxi starts VoiceXML browser and monitors it to make sure it is still running. If the VoiceXML browser process dies, the script will attempt to restart it.
# /etc/init.d/openvxi start
If your Asterisk is not running, you must launch it now:
# /etc/init.d/asterisk start
To stop the VXI* deamon:
# /etc/init.d/openvxi stop
IMPORTANT NOTE:
This startup script runs only for DEBIAN/UBUNTU Linux distributions, please modify or install a correct this script file to launch correctly VXI* from other Linux systems. We provide a script to start the actual, AsteriskNOW linux distribution from DIGIUM.
8. Command line for VXI*
Now your VXI* VoiceXML browser and Asterisk PBX are running, you can manage the VXML service using the Asterisk prompt:
CLI*> help vxml
CLI*> vxml debug
CLI*> vxml no debug
CLI*> vxml reload
CLI*> vxml show license
CLI*> vxml show summary
9. Commercial License activation
The VoiceXML browser is protected by a key license. The license is host-based: each server has a different license key. If the installation is not activated, you can execute a single VoiceXML session (audio). This is the free use mode.
To obtain a commercial valid license key for your copy of VoiceXML browser (for use more than one session), you should run asterisk and get your code by typing the following commands: CLI*> vxml show licenseThe system will give you:
Version: V1.4
Code: <your_identification_code>
Max sessions: 1
Video enabled: no
To order a Commercial License for increase the maximum number of sessions (voicexml ports) supported ,you need to send us <your_identification_code>.
10. Configure your first VoiceXML service
To configure your first VoiceXML service inside Asterisk, just edit your dialpan (extensions.conf):
# cd /etc/asteriskInstall first demo VoiceXML examples programs in your /tmp directory:
# vi extensions.conf
helloworld1.vxml ; 1st program with TTS “Hello World”” using default EN lenguage
helloworld2.vxml ; 1st program with WAV file access says “Hello World!”
helloworld3.vxml ; 1st program with TTS “Hello World”” using EN-GB language
helloworld.wav ; WAV content file for helloworld2
Add a new extension in your dialplan (/etc/asterisk/extensions.conf ) like:
exten => 888,1,Answer
exten => 888,2,Wait(3)
exten => 888,3,Vxml(http://vxml.i6net.com/index.vxml)
exten => 888,4,Hangup exten => 999,1,Answer
exten => 999,2,Wait(3)
exten => 999,3,Vxml(file:///tmp/helloworld2.vxml)
exten => 999,4,Hangup
Please ensure you have reloaded your extensions in Asterisk using the prompt command:
CLI*> extensions reload
Call the service by calling :
SIP:888@<your server IP address>
SIP:999@<your server IP address>
11. Configure Text-to-Speech
The VXI* VoiceXML browser integrate a HTTP client connector to connect to a HTTP Text-To-Speech server. This allow to generate dynamically the audio content with a Text-To-Speech engine. Most VoiceXML browsers have a MRCP connector to access to this feature. The advantage of using the HTTP connector is that the “speech” generated is cached. The same content could be highly acceded with only some TTS resources.
- Flite TTS
- Ceptral TTS
- Loquendo TTS
Others TTS engines can be connected please contact us.
IMPORTANT NOTE:
TTS usage need an HTTP/web server and PHP language installaled in same VXI* or other server. Please read the complete documentation about TTS configuration in our manual and connectors (register first to download).
############################
# TTS server configuration #
############################
#client.prompt.resource.0.uri VXIString http://localhost/tts.php
client.prompt.resource.0.method VXIString POST
client.prompt.resource.0.cacheDir VXIString /tmp
client.prompt.resource.0.format VXIString wav
client.prompt.resource.0.maxage VXIInteger -1
More information at:
[download=26]

The documentation on how to configure TTS is very limited.
It doesn’t explain how to configure vxi* to recognize flite.
It doesn’t explain if and where I have to add the *TTS server configuration* code section.
As a result, although everything else worked like a charm, I still am not able to hear synthesized responses…
Someone, please help!
Comment by cyberfreak — April 6, 2008 @ 4:54 pm