Installing TermWeb on Windows

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

Installing Java

TermWeb requires 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.


Please note

OpenJDK is not officially supported, but there are currently no known issues with running TermWeb on OpenJDK.


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 recommended installation directory is C:\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.

If Tomcat is not installed as a service:

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

    set JAVA_OPTS="%JAVA_OPTS% -Xms128m -Xmx512m" 



If Tomcat is installed and running as a service:

  1. Open Start Menu > Apache Tomcat > Configure Apache Tomcat
  2. Select the Java tab
  3. Specify the following values:
  • Initial memory pool : 128
  • Maximum memory pool : 512

Your configuration should be similar to the screenshot below:


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>/webapp . The war file is extracted automatically into <tomcat>/webapps/termweb if Tomcat is running.

In the file <tomcat>/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.homebase.url and work.dir values.

Please note

Prior to TermWeb v3.15, all changes to termweb.properties requires a restart of TermWeb webapp or Tomcat to take effect.

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 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 see the TermWeb login screen. You can log in with client admin, user admin and password admin.

(tick) Congratulations! Your TermWeb installation is now completed!