General

Torus2 is a Java Web Application and as such requires a compliant Java Servlet Container (with Servlet API >= 2.4) to run. Torus has been proven to work on the following servlet containers and application servers: Tomcat 5.5, Tomcat 6, Jetty 6, Jetty 7, Glassfish 2.1, Glassfish 3.

Torus does not require any other external dependencies and when using the default filesystem record storage backend it does not require a SQL database.

OS independent torus2.war package can be accessed through the Index Data's Maven repository where that latest versions (artifacts) are deployed. The torus2.war file must then be manually deployed to the servlet container.

To ease the installation on certain Index Data supported flavors of Linux we also supply OS-dependent packages for Debian/Ubuntu and RHEL/CentOS operating systems.

Installation on Debian/Ubuntu

To install Torus2 on Debian (squeeze) and Ubuntu (lucid) Index Data APT repository has to be added to the sources list. This is best done by placing the following contents in a file located at /etc/apt/sources.list.d/indexdata.list:

  deb http://ftp.indexdata.dk/debian squeeze main restricted
  deb-src http://ftp.indexdata.dk/debian squeeze main restricted

Afterwards, Torus2 (along with the Tomcat 6 support) can be installed with:

  apt-get install masterkey-torus2-tomcat6

Installation on RHEL/CentOS

Instructions for the redhat-based systems are very similar to Debian:

The following should be included under /etc/yum.repo.d/indexdata.repo:

  [indexdata-main]
  name=Index Data Main Repository
  baseurl=http://ftp.indexdata.com/pub/yum/centos/5.5/main/$basearch
  failovermethod=priority
  gpgcheck=1
  gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-indexdata
  enabled=1
  priority=12

  [indexdata-restricted]
  name=Index Data Restricted Repository
  baseurl=http://ftp.indexdata.com/pub/yum/centos/5.5/restricted/$basearch
  failovermethod=priority
  gpgcheck=1
  gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-indexdata
  enabled=1
  priority=12

Consequently, Torus2 (along with Tomcat 6 integration) can be installed using:

  yum install masterkey-torus2-tomcat6

Tomcat 5 integration packages are also available for redhat.

Maven 2 artifacts

IndexData Maven 2 repository can be accessed with the following maven configuration:

  <repository>
    <id>id-maven-repo</id>
    <url>http://maven.indexdata.com</url>
  </repository>

Torus2 contains the following artifacts:

  <dependency>
    <groupId>com.indexdata</groupId>
    <artifactId>torus2</artifactId>
    <version>VERSION</version>
    <type>war</type>
  </dependency>

At the time being Index Data is only providing snapshot releases this way.

Upgrading from Torus to Torus2

With:

  yum install masterkey-torus2-util

for RHEL/CentOS or

  apt-get install masterkey-torus2-util

for Debian, it's possible to install, besides other things, the migration utility script for converting data maintained using the first iteration of Torus software to the Torus2 compatible format.

The usage options of the script can be checked with:

  torus_migrate -h

By default, running the script without any flags will output the migrated Torus data and configuration under /tmp/torus-migration/ (the original data and configuration is not being altered). The data/configuration residing in that directory must be then properly installed in the standard Torus2 data/conf locations (by default, /var/lib/masterkey/torus2 and /etc/masterkey/torus2) before the Torus2 program can access it.

For Torus 1 systems that make heavy use of externally hosted Torus realms which cannot or have not been migrated to Torus2 it's worth to run the migration script with the -k flag. This will ensure that such external realms URLs are not being altered to fit Torus2 specification.