Introduction

This document provides detailed installation instructions for configuring and deploying VocBench version 2.1. Instructions for older versions may be accessed here

The installation package of Vocbench downloadable from its project site, which contains all or most of the components for installing VB2.0, will be referred along the guide as:

INST_PKG

When a file name for an installation component is referred in this guide without further specifying its full path, we are assuming it is in INST_PKG.

Requirements

Third Party Software

Apache Tomcat web server (version 6.0 or higher)

EXAMPLE: debian:apt-get update; apt-get install sun-java6-jdk apache2 tomcat6 libmysql-java
MySQL database server (version 5.0 or higher)

EXAMPLE:
- debian:apt-get install mysql-server
- Note Root password
- Add extra users for VocBench if required
OWLIM. (you may postpone the installation of OWLIM if you want to test VocBench with a small thesaurus; we recommed however OWLIM for better reliability and larger scalability; see "Running VocBench on OWLIM SE")

Our Software

Semantic Turkey ServerVersion; use the package found in the INST_PKG: ST-Server.zip (see installation steps)

VocBench application war file use the package found in the INST_PKG

VocBench OSGi bundle for ST; just use the package found in INST_PKG; (usually, it comes already ambedded inside the Semantic Turkey package, you may check it in the /extensions/service folder of the Semantic Turkey server)

Data

Administrator Database (administrator20.sql available in the vocbench distribution)

Installation Steps

Setting up the main Software Components

1. Semantic Turkey Server Setup

Unzip the package ST-Server.zip in a directory of your choice
Just make sure that you have no other copy of st-server in the same folder, or they will clash with each other.

In the directory ST-Server, there are batch files for Windows (.bat) and UNIX (.sh) to run the server.

A further integration step would ask for VocBench OSGi bundle {ST.VB-BUNDLE.VERSION} to be copied inside the ST-Server directory under folder ST-Server\extensions\service. However, the OSGi bundle already comes packed inside the ST-Server, so perform this only if you get a specific update of the OSGi bundle.

2. Import the Administrator Database SQL Dump File ({VB.DB.VERSION}) on MySQL Server

EXAMPLE: debian: mysql -u {your.db.user} -p < administrator20.sql

3. VOCBENCH Setup

Drop the {VB.VERSION} .war file in the Tomcat webapps folder and start Tomcat
VB allows updating your configuration file at the time of first load after installation. All properties the values of which are filled with xxxx should be mandatorily filled by the user, while the others may be kept as they are (though can be customized as well). Note that any specificity in the installation of the other tools may require changes in these properties (e.g. the DB.CONNECTIONURL may need to be changed to reflect a different port for your MySQL installation).
See also the System Administration Guide for more information on these properties.

Running the System

Running Semantic Turkey

Start Semantic Turkey by using the batch file in the ST-Server directory (server_run.bat for windows and server_run.sh for UNIX systems).

Running Vocbench

Run Tomcat.
Access VB from the browser at:

http://localhost:8080/<vocbench-deployment-name> (Change URL according to your configuration, vocbench-deployment-name is the name of the war file that you dropped on tomcat)

Example:

http://localhost:8080/vocbench-2.0

VB has been preconfigured with administrator user. Use following credentials to connect as administrator. Administrators are the super users who can create new users and approve new users.

Administrator User Credentials:

Username: administrator

Password: 111111

Running the System

Now, let's go for a first Quick Test Drive !!!

There is a list of Frequently Asked Questions (FAQs) addressing specific issues related to installation