Installation¶

Installation - Linux¶

The Knomi VoiceMatcher SDK for Linux are available in the tarball format and rpm package. The tarball can be extracted to the location of choice and installed on any Linux distribution. And rpm package is suitable for installation on Red Hat, CentOS and other RPM-based systems.

tarball installer¶

Extract the package at the desired location. Example command:

tar -zxvf aware-knomivoicematcher-*-linux-x86-64.tar.gz

Here are example instructions for starting up Knomi VoiceMatcher server. You may use your own scripts and tools to start the services, but these steps are provided for those looking for a starting point.

Start the Nexa|Voice server:

screen -S aw_nexa_voice_rest_server
cd knomivoicematcher/aw_knomi_voice_matcher
./aw_nexa_voice_rest_server.sh
Press CTRL A D to disconnect from the screen

Now that the server is running, you can query its “version” endpoint from the command line to ensure they are running:

curl http://localhost:8071/nexavoice/version

You should see a string that starts with “Aware” for each command. If that is not true or any of the commands fail, return to that service’s screen and ensure the service is running without errors.

At this point, the services are only accessible from the server itself. To make it available to the wider Internet, you must update the “host” parameter with the hostname for your server. For the following example, it will assume the server’s hostname is “server.com”

Edit the Knomi VoiceMatcher server:

screen -r aw_nexa_voice_rest_server
CTRL-C
CTRL-C
sed -i 's/host=.*/host=server.com/g' nexa_voice_config.txt
./aw_nexa_voice_rest_server.sh
Press CTRL A D to disconnect from the screen

You can query the Knomi VoiceMatcher “version” endpoint from the command line to ensure it is running correctly:

curl http://server.com:8071/nexavoice/version

At this point, the Knomi VoiceMatcher server should be accessible from another computer. You should be able to run the above command on another Linux computer on the same network. The “/version” URL can also be typed into a web browser to check if it is working.

To access the Knomi VoiceMatcher services from the Internet, you must ensure that your network directs traffic to the computer running the services. As the steps for this are dependent on your network setup, it is outside the scope of this manual. Contact your IT department for assistance in ensuring that your server is sent connections from outside of your network.

rpm installer¶

Knomi VoiceMatcher has an RPM package available which installs the REST servers as services that can be controlled by systemctl. The RPM requires Red Hat or CentOS Linux version 7.X.

Run the following command as root in order to install and startup the Knomi VoiceMatcher servers:

sudo rpm -ivh knomivoicematcher-x.x.x-el7.src.rpm

If you already have a previous version of the RPM installed, use this command instead:

sudo rpm -Uvh knomivoicematcher-x.x.x-el7.src.rpm

Here are instructions for managing the services.

To stop the server while they are running, run the following commands:

sudo systemctl stop aw_nexa_voice_rest_server

To start the server when they are not running, run the following commands:

sudo systemctl start aw_nexa_voice_rest_server

To restart the server, run the following commands:

sudo systemctl restart aw_nexa_voice_rest_server

Once the server is running, you can query its “version” endpoint from the command line to ensure they are running:

curl http://localhost:8071/nexavoice/version

You should see a string that starts with “Aware” for each command. If that is not true or any of the commands fail, go to /opt/apl/aware/ directory to check the logs from server folder to see if any errors reported. The log file name ends with _info.txt.

To make the server available to the wider Internet, you must update the “host” parameter with the hostname for your server. For the following example, it will assume the server’s hostname is “server.com”

Edit the Knomi VoiceMatcher server:

sed -i 's/host=.*/host=server.com/g' /opt/apl/aware/knomivoicematcher/aw_knomi_voice_matcher/nexa_voice_config.txt
sudo systemctl restart aw_nexa_voice_rest_server

You can query the “/version” endpoint from the command line to ensure it is running correctly:

curl http://server.com:8071/nexavoice/version

Installation - Windows¶

The Knomi VoiceMatcher SDK for Windows is distributed as a windows installer. Open up the installer and follow the instruction to complete installation.

If you have unique installation needs, the installer can be run from the command line with the following options:

Installation Options:

/extract "<Directory>"
    Extracts all installation packages to the specified directory
/msicl "[PROPERTY=PropertyValue] ..."
    Properties to set for the installation
/lang <LCID>
    locate ID of transform to apply to installation
/quiet
    Quiet mode, no user interaction
/passive
    Unattended mode, no user interaction
/norestart
    DO not restart after the installation is commplete
/promptrestart
    Prompts the user for restart if necessary
/forcerestart
    Always restart the computer after installation
/uninstall
    Uninstalls the product
/log "<Logfile>"
    Create a log

Here are example instructions for starting up the server. You may use your own scripts and tools to start the services, but these steps are provided for those looking for a starting point.

Start the Knomi VoiceMatcher server:

Double click on "aw_nexa_voice_rest_server.bat"

Now that the server is running, you can query their “version” endpoint from a web browser to ensure they are running. Type each of the following URLs into your web browser:

http://localhost:8071/nexavoice/version

You should see text that starts with “Aware” for each URL. If that is not true or you get an error message, return to that service’s command window and ensure the service is running without errors.

At this point, the services are only accessible from the server itself. To make it available to the wider Internet, you must update the “host” parameter with the hostname for your server. For the following example, it will assume the server’s hostname is “server.com”.

Edit the Knomi VoiceMatcher server:

Open "nexa_voice_config.txt" in Notepad
Change the line "host=localhost" to "host=server.com"
Save the file
Close the window currently running "aw_nexa_voice_rest_server.bat"
Double click on "aw_nexa_voice_rest_server.bat"

You can query the Knomi VoiceMatcher “version” endpoint from a web browser to ensure it is running. Type the following URL into your web browser:

http://server.com:8071/nexavoice/version

At this point, the Knomi VoiceMatcher service should be accessible from another computer. You should be able to check the above URL on another computer on the same network.

To access the Knomi VoiceMatcher service from the Internet, you must ensure that your network directs traffic to the computer running the services. As the steps for this are dependent on your network setup, it is outside the scope of this manual. Contact your IT department for assistance in ensuring that your server is sent connections from outside of your network.

Server Status Checklist¶

If you are having trouble accessing the Knomi VoiceMatcher services, go through these steps one by one to diagnose what is not working.

Type http://server.com:8071/nexavoice/version into a web browser that is on the same computer that is running the services.

If this does not work, it means that the services are not running or they are not using the correct hostname “server.com”. Check all of your configuration files from the installation, ensure the “host=” is set correctly, and then try restarting the services.

Note: On Linux, you can use the curl commands provided previously instead of using a web browser.

Type http://server.com:8071/nexavoice/version into a web browser that is on a different computer, but within the same network.

If this does not work, it means that the server is preventing connections. Contact your IT department to configure the server’s firewall so that other computers can communicate with the server.

Type http://server.com:8071/nexavoice/version into a web browser from outside of the network, such as from a phone.

If this does not work, it means that your network is not relaying connections from outside of your network to the server. Contact your IT department for assistance in configuring your network so that the server can properly handle these requests.