Chapter 3. Installation

Table of Contents

3.1. Prerequisites
3.1.1. Client Prerequisites
3.1.2. Server Prerequisites
3.1.2.1. Microsoft Windows
3.1.2.2. Linux
3.2. Installation Process
3.2.1. Step 1: Welcome
3.2.2. Step 2: Information
3.2.3. Step 3: Licensing Agreements
3.2.4. Step 4: Target Path
3.2.5. Step 5: Select Installation Packages
3.2.6. Step 6: User Data
3.2.7. Step 7: Installation
3.2.8. Step 8: Perform External Processes
3.2.9. Step 9: Setup Shortcuts
3.2.10. Step 10: Installation Finished
3.3. Console based installation
3.4. Update Process
3.4.1. Database Migration
3.4.1.1. Migration of installations prior version 3.0
3.5. Running Klaros-Testmanagement
3.6. Changing the Database
3.7. Installing Klaros-Testmanagement as a service
3.7.1. Installing Klaros-Testmanagement as a Linux service
3.7.2. Installing Klaros-Testmanagement as a Windows service
3.8. Monitoring Klaros-Testmanagement
3.9. Configuring External Issue Management Systems
3.9.1. Bugzilla Configuration
3.9.1.1. Supported versions
3.9.1.2. Additional Bugzilla Configuration
3.9.2. JIRA Configuration
3.9.2.1. Supported versions
3.9.2.2. Additional JIRA Configuration
3.9.3. Mantis Configuration
3.9.3.1. Supported versions
3.9.3.2. Additional Mantis Configuration
3.9.4. Redmine Configuration
3.9.4.1. Supported versions
3.9.4.2. Additional Redmine Configuration
3.9.5. Trac Configuration
3.9.5.1. Supported versions
3.9.5.2. Additional Trac Server Configuration
3.9.6. SSL Support

Klaros-Testmanagement is equipped with an installer for Microsoft Windows- and Linux-based operating systems. Excluding a Java Runtime Environment, which is needed for the application and the installer itself, it will install all of the applications necessary to run Klaros-Testmanagement, including a file based database (Apache Derby) and the Apache Tomcat application server.

[Warning]Warning

The installer configures Klaros-Testmanagement to use the Apache Derby database for persistence. For production systems, it is strongly recommended to use a database like MySQL, PostgreSQL or Oracle which will provide significantly better performance. After running the initial installation process, the database can be changed. How this is done is described in Section 3.6, “Changing the Database”

This chapter provides all information necessary to install Klaros-Testmanagement.

3.1. Prerequisites

Since Klaros-Testmanagement is a web application, the installation prerequisites for the client and the server side are different. These are explained in detail in the next sections.

3.1.1. Client Prerequisites

To access Klaros-Testmanagement, a modern web browser which supports JavaScript is required.

Table 3.1. Supported Browsers

NameVersion
Microsoft Internet Explorer Version 7 and above
Mozilla Firefox Version 3.5 and above
Google Chrome Version 4 and above
Safari Version 4 and above

Please note that due to issues with the javascript engine Konqueror is currently not a supported browser.

Klaros-Testmanagement is best used at a resolution of 1280x1024 or greater.

3.1.2. Server Prerequisites

To run the Klaros-Testmanagement server, a Microsoft Windows or Linux operating system running Sun/Oracle Java 6 is required. The minimum required patch level is Java 6u14.

[Warning]Alternative Java-Runtime Environments

Out of the box, most Linux distributions do not come with a Sun/Oracle Java installation but some alternative Java implementation like GJC or OpenJDK. Klaros-Testmanagement is not supported in such an environment and is known to not install or work properly in some of these environments.

For optimal performance, a separate database installation is highly recommended. This database is not required to run on the same physical machine as the Klaros-Testmanagement server.

Table 3.2. Supported Databases

NameDescription
Apache DerbyVersion 10.5.0.3 and above (already configured)
MySQLVersion 5.1 and above
PostgreSQLVersion 8.4 and above
OracleVersion 10g, 11g

[Warning]Make sure that the JAVA_HOME/JRE_HOME environment variable is set!

A common caveat is that although Java is installed on your machine, the startup script will complain if neither the JAVA_HOME nor the JRE_HOME environment variable are defined. Windows users will find an option to set this in their computer control panel. The instructions to reach this vary with different versions of windows, an example is shown below. Linux users should set the variables in their startup scripts.

If you have installed a Java SDK you would set the JAVA_HOME variable, if your system only contain a Java Runtime (JRE) please use JRE_HOME accordingly.

Figure 3.1. Setting the JAVA_HOME/JRE_HOME environment variable

Setting the JAVA_HOME/JRE_HOME environment variable

3.1.2.1. Microsoft Windows

To run Klaros-Testmanagement on Microsoft Windows operating systems the following requirements have to be met:

  • Minimum requirements

    1GB RAM, 2GHz CPU

  • Recommended requirements

    2GB RAM, 2.5GHz Dual-Core CPU

  • Operating system

    Microsoft Windows XP, Microsoft Windows Server 2003, Microsoft Windows Vista, Microsoft Windows Server 2008 or Microsoft Windows 7

  • Java Runtime Environment

    Sun/Oracle Java 2 Standard Edition 6.0u14 or greater patch level

  • Disk Space

    Klaros-Testmanagement is storing binary attachments in a file based repository inside the .klaros folder in home directory of the user account that is running the Klaros-Testmanagement application server. Depending on the usage pattern a sufficient amount of disk space should be reserved for this account. If the file based derby database is active, the database files will per default also be located in the user home account.

3.1.2.2. Linux

To run Klaros-Testmanagement on Linux operating systems the following requirements have to be met:

  • Minimum requirements

    1GB RAM, 2GHz CPU

  • Recommended requirements

    2GB RAM, 2.5GHz Dual-Core CPU

  • Operating system

    Linux IA32 (Intel 32 bit architecture) or IA64 (Intel 64 bit architecture) distribution containing Version 2.2.1 or better of the GTK+ widget toolkit and associated libraries

    The GTK+ libraries are only needed for running the Klaros-Testmanagement installer in windowed mode. Running the installer in console mode will work without this requirement.

  • Java Runtime Environment

    Sun/Oracle Java 2 Standard Edition 6.0u14 or greater patch level

  • Disk Space

    Klaros-Testmanagement is storing binary attachments in a file based repository inside the .klaros folder in home directory of the user account that is running the Klaros-Testmanagement application server. Depending on the usage pattern a sufficient amount of disk space should be reserved for this account. If the file based derby database is active, the database files will per default also be located in the user home account.