TestLink - Installation & Configuration Manual

Andreas Morsing

Revision History
Revision 1.02005/03/12scs

Initial creation of the document

Revision 1.12005/04/12MHT

Corrected title, update structure and added new items.


Table of Contents

1. Scope
2. Installation
2.1. Requirements
2.2. Installation steps
3. Ugrading
3.1. Automatic upgrading
3.2. Manual upgrading
4. Configuration
4.1. Parameters which must be configured
4.2. Parameters which may be configured

1. Scope

This document only serves as a reference document for the installation and configuration of Testlink 1.5.0.

The first part includes the installation procedure and second part the configuration explanation.

2. Installation

If you are upgrading from a previous version of TestLink look at the Upgrading section.

2.1. Requirements

Testlink requires these programs:

  • MySQL 4.0.x

  • php 4.3.x

  • Webserver (Apache 1.3.x or 2.0.x and higher, IIS 3 and higher, etc.) See <php_root>/install.txt for more information.

Please, look at installation manual of these product at first. You can also find installations package of all these products and install it together. E.g. XAMPP, Uniform Server, EasyPHP.

There is no requirement about operating system.

2.2. Installation steps

Here are the steps needed for a successful installation:

  • Unpack the release file into directory inside your document root

    For installing the DB you can either choose the command line tools available in your MySQL installation or any MySQL Database Client.

  • Create a new empty MySQL database.

    mysql> create database testlink;

  • Install the sql into the newly created database.

    mysql -u <user> -p<password> <dbname> < <testlinkdir>/install/sql/testlink_create_tables.sql

    e.g.: "mysql -u testlink -ppass testlink < /var/www/html/testlink/install/sql/testlink_create_tables.sql"

  • Edit <testlinkdir>/config.inc.php to match your configuration. See Configuration for more.

  • On Linux or UNIX you must change the permissions of the templates_c directory to be writable by the webserver. From the TestLink root directory run

    chmod 777 gui/templates_c

  • Log into TestLink! Default credentials are:

    user: admin; pass: admin

    Changing this password is a good security practice.

  • Report any issues or feedback to TestLink page or testlink.org forums within the TestLink 1.5 section.

3. Ugrading

You can upgrade either automatically (via script) or manually. There is a few small changes in database against TL 1.0.x. E.g. password is encrypted.

3.1. Automatic upgrading

  • Create a new empty MySQL database.

  • From a browser run <testlinkwebdir>/install/dbUpgrade.php

  • After a successful upgrade you should remove the install directory for security reasons!

3.2. Manual upgrading

If you would like to upgrade manually you can do so by performing the following steps:

  • Run phpMyAdmin or another tool to export all tables including their data except the user and rights tables. Also make sure to check the option for complete inserts.

  • After exporting this to a file check to make sure all the tables have data. In particular you for sure should have data in tables such as mgttestcase, testcase, project and probably the other empty ones I mentioned too.

  • Use phpMyAdmin again create a new db and import the schema from the <testlinkwebdir>/install/sql/testlink_upgrade_create_tables.sql script.

  • Import the sql you exported using phpMyAdmin or similar tool again.

  • Run the following queries with your old database as the selected db. You can also use phpMyAdmin just make sure your old db is the one selected in the left frame. Also just replace <new_db_name> with the actual name of your newly created db.

    INSERT INTO <new_db_name>.user (password,login,id,rightsid,email,first,last)

    SELECT md5(user.password), user.login, user.id, user.rightsid, user.email, user.first, user.last FROM user;

4. Configuration

All configuration parameters are inside the file config.inc.php located in the root directory of your TestLink installation.

4.1. Parameters which must be configured

  • TL_BASE_HREF

    specify the root of testlink directory location seen through the web server. Dont forget the trailing slash e.G. http://webserver/TestLink/

  • DB_USER

    The user to use for connecting to the TestLink database

  • DB_PASS

    The password to use for connecting to the TestLink database

  • DB_HOST

    Thehost to use when connecting to the TestLink database

  • DB_NAME

    The name of the database that contains the TestLink tables

4.2. Parameters which may be configured

  • TL_LOG_PATH

    the filename and path for the logfile of TestLink

  • TL_LOG_LEVEL_DEFAULT

    Set this to the default level of logging (NONE, ERROR, INFO, DEBUG)

  • MAIN_PAGE_METRICS_ENABLED

    This parameter controls whether the metrics table is displayed on the main page. Accepts 'TRUE' or 'FALSE' values

  • TL_INTERFACE_BUGS

    This parameter sets the interface to a bugtracker system, currently only bugzilla is supported. Possible values are 'NO', 'BUGZILLA'.

    For bugzilla configuration see also the file cfg/bugzilla.cfg.php

  • TL_TREE_KIND

    This parameter also is used to configure menu type used in TestLink. Possible values are 'LAYERSMENU', 'DTREE', 'JTREE'. JTREE is default value. This component has the best performance. The two others have the ability to remember the last position in addition.