HomeInstallation GuidePrinter Friendly Version

Installation Guide

1. Test Collab Docker Image

1.1. Installation manual for Docker

Test Collab now offers Docker image to get you up and running fast.

Prerequisites:

- Test Collab trial or paid license (This is automatically emailed to you once you signup for our self-hosted trial)

Installation Steps:

1. Pull Test Collab image from Docker Hub:

docker pull testcollab/testcollab:latest

This will pull latest version of Test Collab along with all OS-level dependencies.

2. Start container:

docker run --name=my_testcollab -d -p 80:80 testcollab/testcollab:latest

This will start container in background and bind Test Collab server to your port 80. You can name it whatever you want, name will later be used to create service.

3. Access your instance in browser:

http://{your-host}.com/

This will bring up the installation wizard of Test Collab, that will ask you for license and other necessary information.

Note: It should be self-explanatory from this point on, however if you run into an issue with the wizard, check detailed manual here (you can skip the dependencies & setting up cronjob).

4. Great! Now you can start using Test Collab but you'll want to configure mail server first so that we can send email notifications.

After logging into your dashboard, go to Settings > Emails. Select SMTP setting there and specify your mailing server credentials.

Production Setup:

You'll eventually want the container to get started automatically as soon as your server boots up. Take a look at this guide here to run docker container as a service.

 

 

2. Installation on Linux

2.1. Installing TestCollab on Linux

Before you start installing TestCollab, there are a few prerequisites that need to be met to install it successfully:

  • Hosting - whether you have a dedicated server, or a shared hosting plan, you'll need some sort of web hosting that meets the following requirements:
    • PHP (version 5.4 or above)
    • MySQL (version 4 or above)
    • Apache 1.3
    • IonCube Loaders
    • Support for cron jobs
    • PHP Safe mode should be set as off
  • Some of the Linux distributions like CentOS do not have SimpleXML module installed / enabled by default, so you may have to install / enable it separately 
  • MySQL Database - you'll need access to a MySQL database, as well as the following credentials.
    • DB Name
    • Host Name
    • Username
    • Password
  • FTP Client - for transferring files to your server.
  • Latest Release of TestCollab - you can download it from the Clients' Area.
  • Your TestCollab License key- You receive license automatically via email right after the purchase. In case you have not, then log on to our customers' portal, login to your account and you will see the licenses link.

Installation

To begin the installation process, do the following

  • Move TestCollab installation package to the server. This can be done by moving the downloaded package to your server, and then unpacking it, or you can unpack the files on your local computer, then move the TestCollab unpacked installation to your server. The TestCollab app, cake folders need to be unpacked in the root of your site.
  • CHMOD 0777 for the following directories:

 

app/tmp (and all directories present under it)
app/config
app/webroot/uploads
  • Now try to access the TestCollab installation through your web browser by entering the your site's URL, (e.g. http://www.example.com)
     
  • Run the TestCollab Installer

You should see a screen similar to this:

Click on Next Step to start the installation wizard

Most of the information that the wizard seeks is straight forward and self explanatory.

System Settings

Before installing the application, wizard checks for its dependencies, which include the permissions that should be available for various directories.

 

Database Configuration

In this step, database related information is to be provided.

Network Settings

In case you are using a proxy server to connect to the internet then this setting will be required to be defined.

License Agreement

 
 
You should be having the application's main license key handy, in order to finish this step.
 

Backend Configuration

 
 
This covers the website management related settings
 

General Configuration

 
 
These are application wide settings.
 

Your Information

 

Finishing Installation

The wizard ends with your login information, and an instruction to change directory permissions for the config directory.
 
 
When the installation completes, you will be redirected to the application's login form.
 
5. Create cronjob and set it up to run every 10 minutes
   <path_to_php>  <your_file_path>/task.php

CHMOD 0755 for cake/console/cake file (please note, change permission for cake file, not cake.bat or cake.php)

3. Installation on Windows with IIS server

3.1. Preparing the Server

Expected time < 60 minutes

This document explains the steps involved before installing the TestCollab application on Windows environment using IIS server, also covers the installation and configuration of the tools and applications that are required to run TestCollab, and should be installed and configured.

Requirements

  • Operating System: Windows Server 2003 or 2008
  • Database: MySQL 5 or higher
  • Web Server: IIS with PHP-CGI
  • PHP: version 5.4.x
  • ionCube PHP Loader extension
The use of Apache/PHP/MySQL bundles like WAMP or XAMPP is not recommended due to their degraded performance.

Installing PHP and MySQL

One of the easiest ways to install PHP and MySQL is through Microsoft's Web Platform Installer.

To install these with the Web Platform Installer, select the Products tab at the top of the window and select the following packages (by pressing the Add buttons next to the package names):

  • PHP 5.4.x
  • MySQL 5

This will automatically select other dependencies. Install the selected packages and their dependencies by clicking the Install button.

 


Select php

 

Select Mysql 5.x

 

If you don't want to use Web Platform Installer, Microsoft explains how you can install PHP for IIS 6 and IIS 7 and MySQL for IIS7.

Configuring IonCube Loaders

After installing PHP and MySQL. You can download the ionCube loader for Windows from here (you might need a different version if you didn't install PHP via the Web Platform Installer)

After downloading the application, do the following:

  • Extract the files on server,
  • Copy the loader extension, ioncube_loader_win_5.x.dll, to PHP's ext directory
    (in most of the cases it is C:\Program Files (x86)\PHP\v5.4\ext)
  • Activate the extension by adding the following line to your php.ini file.
    You can find the PHP.ini file in your PHP installation directory (usually C:\Program Files (x86)\PHP\v5.4)

zend_extension="C:\\Program Files (x86)\\PHP\\v5.4\\ext\\ioncube_loader_win_5.4.dll"

Please note the following

  • You must specify the full path to the file (path will depend on your PHP installation)
  • Use two backslashes as the directory separator.

You can verify that whether or not the ionCube loader extension has been successfully installed, by running php -v from the Command Prompt. If PHP installation directory is not included in environment, then you will need to change to PHP's installation directory in order the execute this command.

PHP 5.4.24 (cli) (built: Jan 8 2014 20:26:10)
Copyright (c) 1997-2013 The PHP Group
Zend Engine v2.4.0, Copyright (c) 1998-2013 Zend Technologies
    with the ionCube PHP Loader v4.7.1, Copyright (c) 2002-2013, by ionCube Ltd.

 

You should see the ionCube PHP Loader line.

Configuring IIS for TestCollab

To install TestCollab on IIS, you need to configure it:

  • Upload TestCollab archive to the server
  • Extract it to a folder under wwwroot folder (generally, C:\inetpub\wwwroot),
    • Or, You can set up a virtual directory in IIS and keep the TestCollab files in another location.
  • Open web browser and enter http://<server-name>/<app-name>
    (Here app-name is the name of the actual or virtual directory, which contains the TestCollab files)

Setting up folder permissions

TestCollab folder should be having appropriate permissions to run the application properly.

To assign permissions, do the following:

  • Right click on the folder
  • Select Properties 
  • On the Properties window, select the Security tab
  • Select Users
  • Select the following permissions
    • Read & Execute, 
    • List Folder Contents and 
    • Read permissions. 
  • Also important is to click the Advanced button and check the "Replace permission entries on all child objects with entries shown here that apply to child objects" checkbox
  • Close all dialogs by clicking Ok.

These two folders, should have write permissions:

  • <testcollab_directory>\app\tmp
  • <testcollab_directory>\app\webroot\uploads

To make them writable by users, grant full permissions to the "Users". 

Setting up background task

TestCollab requires a background process which is used to perform the following:

  • Check milestones' expiry
  • Submit issues to Issue manager
  • Send Email notifications

On Windows you can set background process through Task Scheduler.

To create a task, do the following:

  • Open the Windows Task Scheduler 
  • Select Create Task
  • In the General Tab
    • Add the name of the Task
    • Choose "Run whether user is logged or not" 
    • Check "Do not store password" checkbox.

 

Step 1 for setting task

  • In Triggers tab, do the following:
    • Add a new trigger to specify when the task should be executed
    • Repeat Task (Interval) should be between 5-10 minutes 
    • Duration should be set to Indefinite.

Specify a trigger

  • In Actions tab
    • Add new action to specify the task to executed. 
    • In the Program/Script box, add the path to php.exe
    • In Add arguments textbox - supply the path to the script file which is
      <path_to_testcollab>\task.php

Note: Please keep the path of PHP or script within quotes if its path contains space(s) in it.

In case you want to check the script, you can run it manually through command line with the following command

"C:\Program Files\PHP\v5.4\php.exe" "C:\inetpub\wwwroot\testcollab\task.php"

 

 

3.2. Installing TestCollab

Once the server is prepared for the installation. Installation is a quite straight forward process, covered with a wizard.

Make sure the "World Wide Web Publishing Service" is running, this can be done by opening the services panel from Administrative Tools.

Open the web browser, and type your site name (generally, http://localhost) followed by a "/" and the name of the folder or virtual directory where you have kept the Test Collab package files, discussed in the previous chapter.

This should make the URL like http://<sitename>/<testcollab destination>.

For the sake of this manual, we will keep it http://localhost/testcollab.

You should see a screen similar to this:

Click on Next Step to start the installation wizard

Most of the information that the wizard seeks is straight forward and self explanatory.

System Settings

Before installing the application, wizard checks for its dependencies, which include the permissions that should be available for various directories.

Database Configuration

In this step, database related information is to be provided.

Network Settings

In case you are using a proxy server to connect to the internet then this setting will be required to be defined.

License Agreement

 
 
You should be having the application's main license key handy, in order to finish this step.
 

Backend Configuration

 
 
This covers the website management related settings
 

General Configuration

 
 
These are application wide settings.
 

Your Information

 

Finishing Installation

The wizard ends with your login information, and instruction to change directory permissions for config directory.
 
 

The Application

 
When you finish the installation, you will be redirected to the application, where the first screen you see is the dashboard with a welcome message.
 
 
You will be guided to the key features of the applications through a tour, you may opt to take the tour or start working on the application right away.

4. TestCollab on VM

4.1. TestCollab on VM

This page is dedicated to the steps of procedure that are required to be followed in order to get the TestCollab application running on Virtual Machine (VM).

Requirements

  • At least 384 MB RAM for the VM and 2 GB on host machine
  • 2-3 GB free space on hard drive
  • VirtualBox 4.x installed

Import the Virtual Machine

Make sure these steps are followed by root user (on Linux based OS) or 'Administrator' user (on Windows based OS) as only they have necessary permissions on the host OS to setup forwarding on ports 80 and 443.

Linux Users: First start a root terminal with "sudo su" and then enter "virtualbox" to start virtualbox in root mode.

Windows Users: Right click VirtualBox icon and click 'Run as Administrator'

You receive an VirtualBox appliance packed in an ova (Open Virtual Appliance) file. To import the virtual machine on the host:

Start VirtualBox, and use File->Import Appliance... option, and choose the ova to import.

 

You will get a dialog to provide the VM specific settings

Most of the settings are straight forward, you may like to change the size of RAM available for VM, or may want to change the location of the virtual disk image that will be kept on host machine.

Once settings have been defined and you click Import button, the process of importing the VM will begin and you will be shown the progress so far.

 

When import process completes successfully, you should see a new entry in the left pane of the VirtualBox main window.

New VM named "TestCollabVM" should appear.

 

Start the Virtual Machine

You can either double click the VM name in the list, or use Start button (shown with a green arrow).

Once ready to start, you will be shown an info box about the capturing of keyboard actions on VM.

Click on Ok, and you will see the VM booting.

When booting finishes, you should see the login prompt for the newly imported VM.

Note: If this window bothers you, you can also start the VM in headless mode using virtual box's API (specific instructions are not included but can be found on Virtual Box API).

You are now ready to install and use the TestCollab application.

The virtual machine is pre-configured to forward the ports required to access the application.

To run the application, just open your favorite browser, and key in the URL http://localhost, and you are now ready to install the application. Advanced users can also modify the port forwarding in case host ports are already in use or can't be freed, but we recommend all clients to use the VM configuration as is, for best results.

 

The Installation Process

You should see a screen similar to this:

Click on Next Step to start the installation wizard

Most of the information that the wizard seeks is straight forward and self explanatory.

 

System Settings

Before installing the application, wizard checks for its dependencies, which include the permissions that should be available for various directories.

 

Database Configuration

In this step, database related information is to be provided.

Note that the database username to be given should be root, and password should be tcm. You can specify any name for the database and it will be created on runtime automatically.

 

Network Settings

In case you are using a proxy server to connect to the internet then this setting will be required to be defined.

License Agreement

 
 
You should be having the application's main license key handy, in order to finish this step.
 

Backend Configuration

 
 
This covers the website management related settings
 

General Configuration

 
 
These are application wide settings.
 

Your Information

 

Finishing Installation

The wizard ends with your login information, and an instruction to change directory permissions for the config directory.
 
 
When the installation completes, you will be redirected to the application's login form.
 
 
You can login to the application using the credentials you have set during "Your Information" step of installation.
 
Please note that being an administrator, one can change the application wide and project specific settings.
 
For email setting, make sure that you select SMTP Server as the Type of Mailing System to be used, as shown in the screen shot below.
 
 

 

5. Upgrading Self Hosted Instance

5.1. Upgrading Self Hosted Instance

Please note, in this small set of steps <path_to_testcollab> refers to the actual path where the TestCollab application files exist.

  1. Before proceeding with the migration / upgrade process, please check and note the current version and revision of TestCollab, by clicking on  icon from the set  on top of the screen when the application is running
  2. Make sure you have downloaded the latest package from here http://testcollab.com/downloads
  3. Backup all the files and folders that are under <path_to_testcollab>
  4. Backup the database that is currently being used for TestCollab
  5. Extract the package
  6. Copy or move all the extracted contents into the TestCollab folder that has earlier been backed up
  7. From the backup, 
    Copy the /app/config/config.php file into the newer set of files
    Copy the folder /app/webroot/uploads into newer set of files
  8. Check the access permissions for the folders, and make sure that they are set as following
    <path_to_testcollab> => folder => 0755 => Recursively
    <path_to_testcollab>/app/config => folder => 0777
    <path_to_testcollab>/app/tmp => folder => 0777 => Recursively
    <path_to_testcollab>/app/webroot/uploads => folder => 0777 => Recursively
  9. Now, the migration process can be started by using the following command
    <path_to_php> <path_to_testcollab>/cake/console/cake.php -app <path_to_testcollab>/app migrate > <path_to_testcollab>/app/tmp/logs/migrate_<datetime>.log 
    Here replace <datetime> with the current date and time value to make the log file name look something like this migrate_280620131500.log
  10. Check the <path_to_testcollab>/app/tmp/logs/migrate_<datetime>.log to see if there is any warning or error in this., if there is an error, please report the same to the support team immediately by mailing the file to support@testcollab.com
  11. If log looks fine, run the following command to clear the application cache
    <path_to_php> <path_to_testcollab>/cake/console/cake.php -app <path_to_testcollab>/app clean cache
  12. Start using the application, check the application version and revision once again, now you should see the updated version and revision

Test Case Management
Test Collab Support
Product Tour