Installing TermWeb on Linux

This guide describes how to install a new TermWeb installation on Linux. 

Installing Java

TermWeb requires a Java Developers Kit (JDK) or Java Runtime Environment (JRE) platform to be installed on your server's operating system. Currently Java 1.6, 1.7 and 1.8 is supported by TermWeb.

Oracle's JDK/JRE can be downloaded from Oracle's website.

You can test whether you have the correct Java platform by running java -version:

~$ java -version
java version "1.7.0_25"
Java(TM) SE Runtime Environment (build 1.7.0_25-b15)
Java HotSpot(TM) 64-Bit Server VM (build 23.25-b01, mixed mode)

Installing Tomcat

TermWeb is a web application that requires an application server. Apache Tomcat is the recommended application server and can be downloaded here. Recommended version is 7.0 or later, but TermWeb also supports Tomcat 6.0.

The installation directory for Tomcat depends on the Linux distribution, one common location is /usr/share/tomcat.  Tomcat's installation directory is referred to as <tomcat-install> in this documentation.

Configuring Tomcat

TermWeb need more heap space than the 64MB that is allocated to the Java virtual machine by default. The recommended value is 512MB or higher, but it should not exceed the amount of physical RAM available.

The exact procedure for configuration is depending on Linux distribution.

CentOS / RedHat 

1. Edit /etc/tomcat/tomcat.conf .

2. Add or modify the line containing JAVA_OPTS and set the value for -Xms and -Xmx.

   JAVA_OPTS="-Xms=128m -Xmx512m"

Generic Tomcat installation

1. In <tomcat-install>/bin, open the setenv.sh file, or create a new file if it doesn't exist.

2. Add the line

   export JAVA_OPTS="$JAVA_OPTS -Xms128m -Xmx512m"

Restart Tomcat after the file is edited and saved. You can confirm that Tomcat has picked up the correct settings by running

ps aux | grep java

and see that the settings for -Xms and -Xmx are as desired.

Database connection

When Tomcat is installed, please refer to Connecting TermWeb to a Database for setting up and configuring the database.

Web application installation

Copy the termweb.war file to <tomcat-install>/webapp . The war file is extracted automatically into <tomcat-install>/webapps/termweb if Tomcat is running.

In the file <tomcat-install>/webapps/termweb/WEB-INF/termweb.properties.sample you will find settings that may have to be adjusted according to your environment. Rename this file to termweb.properties and edit the values for termweb.home, base.url and work.dir values.

Logging

Configuration for logging is configured in <tomcat>/webapps/termweb/WEB-INF/log4j.properties. You may need to change the path to the log file (log4j.appender.logfile.file) to make TermWeb write its log file in desired location.

See http://logging.apache.org/log4j for more information about logging configuration options.

Set Environment Variable

Set the TERMWEB_HOME environment variable according to the instructions in Setting TermWeb Home Directory and copy termweb.properties and log4j.properties to the directory specified by the variable.

Installation complete

Start up Tomcat and check the log files for any errors.

Open your browser and enter http://localhost:8080/termweb. TermWeb now asks for a license. Enter the license that you have received from Interverbum Technology.

You should now see the TermWeb login screen. You can log in with client admin, user admin and password admin.

 Congratulations! Your TermWeb installation is now completed!