インストールマニュアル

「インストールマニュアル」の編集履歴（バックアップ）一覧はこちら

インストールマニュアル - (2007/09/26 (水) 13:40:19) の１つ前との変更点

追加された行は緑色になります。

削除された行は赤色になります。

インストール & 構成 マニュアル
TestLink version 1.7








Copyright ? 2004,2005,2006 TestLink Development Community
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. The license is available in "GNU Free Documentation License" homepage.
---
翻訳: Testing Engineer's Forum (TEF) - ソフトウェアテスト技術者交流会 -
「TEF有志によるTestLink日本語化プロジェクト」部会
---

1 このドキュメントの範囲

このドキュメントは、TestLink 1.7のインストールと構成方法に関するリファレンスと知識基盤を提供します。初めの部分は、インストールの手順、次の部分は構成方法の説明になっています。
最新のドキュメントは TestLinkのホームページで参照することができます。さらに TestLink フォーラムで問題の解決方法を質問することもできます。

インストール手順の概要:

1.Install background services
2.Tranfer and uncompress files into web directory
3.Generate database tables and add data (create default or transfer from previous db)
4.Edit configuration files
5.PHP File extensions
6.Login

1.使用するサービス環境のインストール
2.Webserverへの展開
3.データベーステーブルの作成とデータの追加(新規作成、または、以前のデータベースからの移行)
4.設定ファイルの編集
5.PHPの拡張設定
6.ログイン

2 必要とするシステム資源

TestLink requires these applications as background:
Database
MySQL 4.1.x and higher (4.0.x doesn't support UTF-8) 
Postgres
MS SQL
php 5.x and higher (version 5.2 is recommended)
Webserver (Apache 1.3.x or 2.x and higher, IIS 3 and higher, etc.). See <php_root>/install.txt for more information.
There is no requirement about your operating system (tested on Linux and MS Win32).
You can use also MySQL on different server than TestLink. 

TestLinkに必要な環境は以下の通りです：
データベース
MySQL 4.1.x もしくはそれ以上のバージョン
(4.0.x はUTF-8をサポートしていないため使用できません)
PostgresSQL
MS SQL

スクリプト
PHP 5.x以上(推奨は5.2です)

Webserver
Apache 1.3.x。 2.x またはそれ以上
IIS 3 以上
その他

使用環境
OSには依存しません(LinuxとWin32環境では確認済みです)
MySQLは様々なサーバで使用できるのでお勧めです

3 インストールの準備

Do the next steps before installation:
1.Install environment: Webserver, php4 and MySQL. Refer to documentation of these products. You can also find installations package of all these products and install it together. E.g. XAMPP, EasyPHP, Uniform Server, etc.
2.Transfer the TestLink installation file to your webserver using whatever method you like best (ftp, scp, etc.). You will need to telnet/ssh into the server machine for the next steps.
3.Next, untar/gunzip it to the directory that you want. The usual command is (1 step):
# tar zxvf <filename.tar.gz>
or
# gunzip <filename.tar.gz>
# tar xvf <filename.tar>
Winzip, Stuffit, and other programs should also be able to handle decompression of the archive.
At this point you may want to rename the directory to something simpler like 'testlink'. You will use the mv command to rename a directory (Windows users substitute the "ren" command or use explorer).
# mv <directory_name> testlink
4.Continue Installation or Upgrade.

>>> begin >>>
インストールを始める前に、以下のことを行ってください。
1.  環境のインストール：Webserver, php4, MySQL
    これらの製品のドキュメントを参照してください。
    また、これらの製品全てのインストールするパッケージを
    見つけて、インストールしてください。
    例  XAMPP, EasyPHP, Uniform Server など

2.  あなたの使う webserver に TestLink のインストールファイルを
    一番やりやすい方法で転送してください。(ftp, scp, 等)
    次のステップでは telnet か ssh がサーバーマシンに入っていることが
    必要です。

3.  次に、好きなディレクトリに untar か gunzip で解凍します。
    通常は以下のようなものです。(1 step): 
    # tar zxvf <filename.tar.gz> 
    もしくは
    # gunzip <filename.tar.gz> 
    # tar xvf <filename.tar> 
    Winzip や Stuffit などの他の解凍プログラムでも同じような操作で
    アーカイブを解凍できます。

    解凍したら、mv や rendir で、ディレクトリ名を単なる testlink に
    変えてください。
    (Windows の場合はコマンドラインの ren やエクスプローラで変えます)
    # mv <directory_name> testlink 

4.  インストールやアップグレードを続行します。
>>> end >>>

4 インストール

You can use automatic scripted installation or manual steps. If you are upgrading from a previous version of TestLink look at the Upgrading section.

>>> begin >>>
自動でのインストール、手動でのインストールのどちらでもできます。
もし、前バージョンの TestLink をアップグレードするのなら
アップグレードの章を読んでください。
>>> end >>>

4.1 自働でのインストール

The following details the basic steps for installation on any system. The instructions may seem unix-centric but should work fine on Windows systems. Barring complications, it should take you about 10-30 minutes to install, configure, and be using TestLink.
This installation process has changed with release 1.6. Next we will create the necessary database tables and a basic configuration file.
1.From your web browser access http://<yoursite>/testlink/install/index.php.
2.This page will walk through the following steps:
check basic parameters for the web server, php config and DB version.
prompt for the database type and location, and a database user/password pair. For installation, an administrative user/password pair can also be provided. The operating user requires ALTER, SELECT, INSERT, and UPDATE privileges. For installation, INDEX, CREATE, DELETE, and DROP privileges are also required.
create the database and tables.
Warning:
A DEFAULT ADMINISTRATOR level account is created.
The account name and password are: admin / admin. Use this when you first login to TestLink. Immediately go to Manage and create at least one administrator level account. Immediately after that DISABLE or DELETE the admin account. You can recreate it but you should delete the account to prevent the cookie_string from being used to trick the package. It would be even better to rename the account or delete it permanently. REMEMBER: After setting up the package, REMOVE the default admin account
perform some post installation checks on the system.
3.After a successful upgrade you should remove the <testlinkwebdir>/install/ directory for security reasons.
4.The next part involves configuring the installation to work with your specific setup. See configuration section for description of configurable parameter.

>>> begin >>>
システムにインストールするための基本的な手順を以下に示します。
命令の記述は unix を主な対象としていますが、Windows でも同じように
行ってください。
コンパイルなしで使えるのなら、インストール、コンフィギュレーションを行って
TestLink を使えるようになるまでにかかる時間は、10 分から 30 分程度です。
このインストール手順は release 1.6 で変更されました。
次からは、database tables と basic configuration file を作成することが
必要になります。

1.  Web ブラウザで http://<yoursite>/testlink/install/index.php に
    アクセスします。

2.  このページは以下のステップのリハーサルをします(walk through)：
    web server 、php のコンフィギュレーション、DB バージョンの
    基本的なパラメータのチェック。
    データベースのタイプや位置、ユーザやパスワードの指定。
    インストールには、アドミニストレータ権限を持つユーザとパスワードが
    必要です。変更、選択、挿入、更新の各操作を行う権利を要求するためです。
    また、インストールには、データベースや(データ)テーブルを生成するために
    インデックス、生成、削除、中断(DROP)操作を行う権利も必要です。
    警告：
    デフォルトのアドミニストレータレベルのアカウントは生成されています。
    アカウント名とパスワードは右のものです：admin / admin
    TestLink に最初にログインするときは、これを使用してください。
    ログイン後、まず最初に、最低でも一つのアドミニストレータレベルの
    アカウントを生成してください。そして最初のアドミニストレータの
    アカウント(admin)を無効にするか、削除してください。
    あなたは、この最初のアドミニストレータのアカウントを再生成できますが
    Testlink に対するクッキー文字列を使った犯罪(trick)を避けるために
    このアカウント(admin)は削除することを強くお勧めします。
    このアカウント(admin)は永久に使用しないことがお勧めです。
    覚えておいてください：パッケージの設定後、システム上でインストール後の
    操作を行う前に、デフォルトのアドミニストレータのアカウントを削除することを。

3.  更新が成功したら、セキュリティ上の理由のため、
    下記のディレクトリ以下を削除してください。
    <testlinkwebdir>/install/

4.  次のパートでは固有のセットアップ事項に基づいた
    コンフィギュレーションを行います。
>>> end >>>


4.1.1 手動でのインストール

If you want to perform a Manual installation (not recomended) here are the steps needed for a successful installation. For installing the DB you can either choose the command line tools available in your MySQL installation or any MySQL Database Client (e.g. phpMyAdmin).
Prepare MySQL via command line tools:
Create a new empty MySQL database.
for MySQL >= 4.1 (with UTF8) do CREATE DATABASE testlink CHARACTER SET utf8 COLLATE utf8_general_ci By choosing UTF8 you should also change the value of DB_SUPPORTS_UTF8 to TRUE in your <testlinkdir>/config.inc.php See Configuration for more.
Create tables for 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
Populate initial data for the newly created database (admin account, default roles).
# mysql -u <user> -p<password> <dbname> < <testlinkdir>/install/sql/testlink_create_default_data.sql
Alternatively you can use phpMyAdmin:
Create new database from main page (recommended UTF-8 character set).
Optionally create a new user and assign him correct rights for the created database.
Select the created database in the left pane.
Navigate to SQL window.
Upload SQL request from files /install/sql/testlink_create_tables.sql and run the script.
Upload SQL request from files /install/sql/testlink_create_default_data.sql and run the script.
Create a <testlinkdir>/config_db.inc.php file with the following data (example):
<?php // Automatically Generated by TestLink Installer 
define('DB_TYPE', 'mysql'); 
define('DB_USER', 'testlinker'); 
define('DB_PASS', 'testlink_pass'); 
define('DB_HOST', 'localhost'); 
define('DB_NAME', 'tl_master'); 
?>
(Optional) Create a DB user for connection from TestLink. Don't forget to assign a correct rights (at least SELECT, INSERT, UPDATE, DELETE) for the created database. The user must be defined in config_db.inc.php. Otherwise you can use any other user available in MySQL database with correct rights.
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. TestLink notifies if you don't do it.
After a successful upgrade you should remove the <testlinkwebdir>/install/ directory for security reasons.
The next part involves configuring the installation to work with your specific setup. See configuration section for description of configurable parameter.
Report any issues or feedback to TestLink Bug tracking system page.

>>> begin >>>
もし、手動でのインストールを行うなら(非推奨)、以下の手順で行ってください。
データベースのインストールは、MySQL のインストールで使用したコマンドライン
ツールか、MySQL のデータベースクライアント (例 phpMyAdmin) が選べます。

コマンドラインツールでの MySQL の準備：
新しい空の MySQL データベースを生成します。
MySQL は 4.1 以上(UTF8 の場合) で、testlink のデータベースの生成を行います。
文字セットは utf8_general_ci に UTF8 を選択することでutf8 で照合します。
また、<testlinkdir>/config.inc.php の中のDB_SUPPORTS_UTF8 の値も 
TRUE に変えてください。
詳細については、コンフィギュレーション(Configuration)を参照してください。
以下の書式で、新しく生成したデータベース用のテーブルを生成します。
# mysql -u <user> -p<password> <dbname> < <testlinkdir>/install/sql/testlink_create_tables.sql
例 # mysql -u testlink -ppass testlink < /var/www/html/testlink/install/sql/testlink_create_tables.sql 
以下の書式で、新しく生成したデータベース用の初期データを投入します。
(デフォルトはアドミンのアカウントです)
# mysql -u <user> -p<password> <dbname> < <testlinkdir>/install/sql/testlink_create_default_data.sql 

phpMyAdmin を使用する場合：
main page から新しいデータベースを生成します(UTF-8 文字セットを推奨)。
データベースの生成では、オプションで、新しいユーザの生成と権限の
割り当てが行えます。
左側のペイン(ウィンドウ枠)で、データベースの生成を選んでください。
SQL window がナビゲイトします。

/install/sql/testlink_create_tables.sql ファイルの SQL 要求を
アップロードして、そのスクリプトを実行します。
/install/sql/testlink_create_default_data.sql ファイルの SQL 要求を
アップロードして、そのスクリプトを実行します。
<テストリンクディレクトリ>/config_db.inc.php を生成して、
以下の例を参考にデータを設定してください：
<?php // Automatically Generated by TestLink Installer 
define('DB_TYPE', 'mysql'); 
define('DB_USER', 'testlinker'); 
define('DB_PASS', 'testlink_pass'); 
define('DB_HOST', 'localhost'); 
define('DB_NAME', 'tl_master'); 
?> 

(オプション)TestLink から繋ぐことのできるDB ユーザーを生成します。
ユーザーにはデータベース生成の権限を与えることを忘れないように！
(最低限の権限は選択、挿入、更新、削除です)
ユーザーは config_db.inc.php で定義されていることが必要です。
そのほかの点では、MySQL データベースの権限を他のユーザーと同じように
使えます。
Linux / UNIX 上では、webserver によって書き込みが可能なように
templates_c ディレクトリのパーミッションを変えてください。
TestLink のルートディレクトリから以下のように実行します。
# chmod 777 gui/templates_c 

TestLink のデフォルトでのログインは以下を使用します：
user: admin; pass: admin
このパスワードは、安全のためにログインしたらすぐに変更すべきです。
もし、変更しなければ TestLink から通告されます。
アップグレード成功後は、安全のために
<testlinkwebdir>/install/ ディレクトリは削除してください。

次にやることはあなたの環境に合わせたコンフィギュレーションです。
コンフィギュレーション可能なパラメータについては
コンフィギュレーション セクションを参照してください。

問題点やフィードバックに関しては、TestLink Bug tracking system ページに
報告をお願いします。
>>> end >>>


4.2 プログラムのバージョンアップ

主要なバージョンアップ:手動と自動(スクリプト経由)のどちらでも可能です。
どちらの方法であっても、TL 1.6, 1.5, 1.0.4に対してデータベースのいくつかの変更があるため、
直接にオリジナルのデータベースを使う事はできません。
Hot-Fix(修正)バージョンへのバージョンアップは必須ではありません (例:1.7.0 -> 1.7.2)。

4.2.1 Hot-Fixリリース(修正プログラム)へのアップグレード

Maintenance (Bug fixing) release is for example 1.6.0 -> 1.6.1. Database schema doesn't changed in this case. 
Save files of the previous version.
Remove the all files from directory.
Copy a new version to the same directory.
Copy config_db file to the new structure and modify configuration parameters acording your previous settings.
Now, it should work.

>>> begin >>> 
例えば1.6.0 -> 1.6.1のように保守(バグ修正)プログラムを公開することがあります。
この場合はデータベーススキーマは変更されません。
前のバージョンのファイルを保存してください。(別のディレクトリに)
すべてのファイルをディレクトリから削除してください。
同じディレクトリに新しいバージョンをコピーしてください。
新しいファイル構造に対してconfig_dbファイルをコピーするとともに、
前のバージョンに適用していた設定に沿って構成パラメータを修正してください。
これで更新完了です。
>>> end >>> 

4.2.2 メジャーバージョンへの自動アップグレード

Follows preinstallation steps.
From a web browser run http://<testlinkwebdir>/install/index.php
Choose 'Upgrade Installation' link. Run the scripts until you see that process is finished.
After a successful upgrade you should remove the <testlinkwebdir>/install/ directory for security reasons.
The next part involves configuring the installation to work with your specific setup. See configuration section for description of configurable parameter.
Report any issues or feedback to TestLink Bug tracking system page.

>>> begin >>> 
まず次のプレインストール手順を行ってください。
ブラウザからhttp://<testlinkwebdir>/install/index.phpを表示してください。
'アップグレード インストール'リンクを選択してください。
スクリプトが実行されるので終了まで待ちます。
アップグレードに成功したのち、<testlinkwebdir>/install/ディレクトリはセキュリティの問題があるので削除してください。
次は個別のセットアップ環境の構成インストールです。設定パラメータを記述している設定の節を参照してください。
TestLinkバグ追跡システムページのインストールの結果やフィードバックが作成されます。
>>> end >>> 

4.2.3 手動でのバージョンアップ

This chapter describe changes in against previous versions. The automatic upgrade is recommended. Use this chapter for a special cases and fiddling config. You can do it of course after a study of changes in database and installation script. Good idea is to compare SQL files for create db tables (your current version and a new one).

>>> begin >>> 
この章は前のバージョンを考慮して変更することを記述しています。
自動アップグレードを推奨しています。
この章の内容は特殊なケースやわずかな構成の場合に使用します。
データベース変更やインストールスクリプトの学習後にこれらを行うことができるようになります。
(現在のバージョンと新しいバージョンの)DB作成SQLファイルを比較することは良い考えになるでしょう。
>>> end >>> 

4.2.4 データベーススキーマ変更

user password is encrypted (1.5)
A new tables for SRS feature: requirements,  req_coverage, requirement_doc (1.6)
Attachments (1.7)
Custom fields (1.7)

>>> begin >>> 
ユーザパスワードは暗号化されています。(1.5)
SRS機能のための新しいテーブル：要件、req_coverage、requirement_doc (1.6)
添付ファイル(1.7)
カスタムフィールド(1.7)
>>> end >>> 

4.2.5 旧バージョンとの互換性

TL 1.0.4 has not  relation Test Plan relation to Product. The solution from TL 1.6 table include field Product ID in the table. Test Plans could be available over all Products. Such Test Plan has Product ID value = 0.
Configuration within <testlinkinstalldir>/config.inc.php: 
$g_show_tp_without_prodid=1; 
$g_ui_show_check_filter_tp_by_product = 1;.

4.2.5.1 Latin to UTF-8 conversion (upgrade from 1.5 and older)

TestLink 1.6 allows for UTF-8 encoded character rendering, therefore any extended character data that may have snuck into your database and didn't show up in 1.5 may start appearing in 1.6 UI.  You can turn UTF-8 support off in testlink by modifying a value in the <testlinkinstalldir>/config.inc.php file, but then you will be missing out on the ability to use characters beyond ASCII.

If you have the same problem I did and see lots of extended characters appearing in your data after upgrading to 1.6 and having UTF-8 support turned on, you should read through the following instructions. Be sure to practice this exercise on a test machine before performing on your deployment system.

The instructions will help you clear out any non-ASCII characters from your database and setup your database to support UTF-8.

First make a backup of your current database using the mysqldump utility.
# /usr/bin/mysqldump -u root testlink15 -p > testlink15.backup
Now edit testlink15.backup so schema definitions for EACH table has utf8 encoding specified. Change the CHARSET for each table from latin1 to utf8. For example the following line in the definition of 1 table which reads as follows :
ENGINE=MyISAM DEFAULT CHARSET=latin1 COMMENT='This table holds the bugs filed for each result'; 
should be changed to 
ENGINE=MyISAM DEFAULT CHARSET=utf8 COMMENT='This table holds the bugs filed for each result';
Then ran testlink15.backup thru my the perl script below as follows:
/replaceScript.pl < testlink15.backup > testlink15.cleaned
replaceScript.pl is as follows :
#!/usr/bin/perl
while (<>) {
        chomp;
        tr/\000-\177/\040/cs;
        print $_, "\n";
}
Created an empty testlink16 db with utf8 charset as follows:
CREATE DATABASE testlink16 CHARACTER SET utf8;

Install the tables into the new database
# mysql testlink16 -u root -p < testlink15.cleaned

You can verify your database's "Db characterset" is now set to utf8 by using the following command:
login to mysql
use testlink16
mysql> \s
--------------
mysql  Ver 14.7 Distrib 4.1.11, for redhat-linux-gnu (i386)
Connection id:          26
Current database:       testlink15
Current user:           bugz@localhost
SSL:                    Not in use
Current pager:          stdout
Using outfile:          ''
Using delimiter:        ;
Server version:         4.1.11
Protocol version:       10
Connection:             Localhost via UNIX socket
Server characterset:    latin1
Db     characterset:    utf8
Client characterset:    latin1
Conn.  characterset:    latin1
UNIX socket:            /var/lib/mysql/mysql.sock
Uptime:                 36 min 55 sec

Run the upgrade installation provided by Testlink 1.6.

Other resources:
what the heck is UTF-8 ? 
http://www.joelonsoftware.com/articles/Unicode.html
octal table (you can see octal values 000 - 177 are "normal ascii" characters).
The perl script that is provided searches based on octal values.
http://web.cs.mun.ca/~michael/c/ascii-table.html
description of tr perl operation
http://www.unix.org.ua/orelly/perl/learn/ch15_05.htm

5 コンフィグレーション

5.1 コンフィグレーションファイル

すべての構成パラメータはconfig.inc.phpファイルにあります。このリリース(1.6)では、下記が構成ファイルになります。
<testlink installation directory>/config.inc.php
<testlink installation directory>/config_db.inc.php
<testlink installation directory>/cfg/<bug_tracking_system>.cfg.php

config.inc.php
メインの構成ファイルです。下記を参照して下さい。

config_db.inc.php
データベースにアクセスするための構成ファイルです。このファイルはインストーラにより、インストールあるいはアップグレード中に作成されます。通常このファイルをユーザが変更することはありません。

/cfg/bugzilla.cfg.php
/cfg/mantis.cfg.php
/cfg/jira.cfg.php
これらはそれぞれ、bugzilla, mantis, jiraのバグトレースシステムにアクセスするための構成ファイルです。
テストリンクからのこれらのシステムにアクセスしたい場合にはこれらのファイルを編集する必要があります。
この機能を使用したい場合には、config.inc.phpのパラメータをあわせて変更する必要があります。

5.2 5.2 構成パラメータ

DB_SUPPORTS_UTF8
MYSQLのバージョンが4.1以前のとき（UTF8サポートなし）の場合にはFALSEを設定してください。これによりすべてのページでキャラクタセットがISO-8859-1に設定されます。またデータベース内のキャラクタセットはlatin1に設定されます。

MySQLのバージョンが >= 4.1ならばTRUEに設定してください。それによりすべてのページでUTF-8がサポートされ、データベース内のデータのキャラクタセットはUTF8二設定されます。 
TL_LOG_LEVEL_DEFAULT
デフォルトのログ出力レベル(NONE, ERROR, INFO, DEBUG)を設定します。TestLinkは出力されたログのファイルサイズをチェックします。
例）DEBUGレベルは開発もしくはバグの調査のみに使用し、ディスク使用量を少なめにします。ERRORが通常のログ出力レベルが推奨されます。
TL_LOG_PATH
TestLinkから出力されるログのパスとファイル名を指定します。
例）/tmp/testlink.log
MAIN_PAGE_METRICS_ENABLED
このパラメータはメトリクステーブルがメインのページに表示されるかを指定します。
TRUEもしくはFALSEを指定してください。

TL_INTERFACE_BUGS
このパラメータはバグトラッキングへのインタフェースを設定します。値としては以下が設定できます。'NO', 'BUGZILLA', 'MANTIS', 'JIRA' (TestLink >= 1.6)
bugzillaの構成についてはcfg/bugzilla.cfg.phpを参照して下さい。Supported version: 0.19.1
mantisの構成についてはcfg/mantis.cfg.phpを参照してください。Supported version: 1.0.0.a3
JIRAの構成についてはcfg/jira.cfg.phpを参照してください。Supported version: JIRA 3.1.1
TL_TREE_KIND
このパラメータはテストリンクで使用されているツリー形式のメニューを設定します。値としては以下が設定されます。'LAYERSMENU', 'DTREE', 'JTREE'。LAYERSMENUがデフォルト値です。このコンポーネントはJTREEでもっともよいパフォーマンスが期待できます。その他の値では、最後にカーソルが当たっていた場所を保存できます。

TL_IMPORT_LIMIT
アップロードできる最大のファイルサイズを設定します。デフォルト値は200000です。この値を増やすことで、より大きいファイルをアップロードできます。パラメータしてTL_IMPORT_ROW_MAXがあります。このパラメータはエクスポートファイルの１行の最大サイズを設定します。この値のデフォルトは10000が設定されています。
$g_fckeditor_toolbar
fckeditorツールバーの定義をします。このパラメータによりfckeditorツールバーを構成できます。より詳細な情報についてはfckeditorのホームページを参照してください。

TL_TPL_CHARSET
中国語のユーザのみに適用されます。この値を以下のように設定します。Set: define('TL_TPL_CHARSET', 'gb2312'); これにより正しいキャラクタセットが設定されます。その他の言語ではこのパラメータを設定する必要がありません。

TL_DEFAULT_LOCALE
このパラメータではデフォルトロケールを設定します。このパラメータに設定する値は$g_localesに設定されているいづれかの値です。(同じ構成ファイルで設定されています)。デフォルト値はen_GBが設定されています。

TL_COMPANY, TL_DOC_COPYRIGHT, TL_DOC_CONFIDENT
このパラメータに設定された文字列は印刷されたドキュメントの表紙に出力されます（Version 1.6以降で有効です）。使用されない場合には、ブランクにしてください。

5.3 Customization

5.3.1 Cascading Style Sheet

You can change TestLink appearance writing you own CSS (Cascading Style Sheet) files.
You have to change the following constants:
define('TL_LOGIN_CSS','gui/css/tl_login.css'); - All Login/Logout pages CSS
define('TL_TESTLINK_CSS','gui/css/testlink.css'); - Main CSS
define('TL_DOC_BASIC_CSS','gui/css/tl_doc_basic.css'); - Used in Reports
Important: paths to CSS are relative to the <testlink installation directory>
If you want to use your own CSS files we suggest you to proceed as follow:
1.create a new directory inside the gui directory, example gui/css/my_css/
2.copy the testlink original files to the new directory (you can change the names if you want)
3.modify them at your will
4.edit config.inc.php
// Original configuration 
//define('TL_LOGIN_CSS','gui/css/tl_login.css'); //define('TL_TESTLINK_CSS','gui/css/testlink.css'); //define('TL_DOC_BASIC_CSS','gui/css/tl_doc_basic.css');  define('TL_LOGIN_CSS','gui/css/my_css/tl_login_acqua.css'); define('TL_TESTLINK_CSS','gui/css/my_css/testlink_acqua.css'); define('TL_DOC_BASIC_CSS','gui/css/my_css/tl_doc_basic.css');

5.3.2 Duplicate names for Products, Components, Categories, Test Cases

As you know, is possible to create one of this objects (Products, Components, Categories, testcases) doing a copy of an existing one.
You can configure how to proceed when the copy is done:
if you set $g_check_names_for_duplicates=TRUE then the following checks will be done:
1.Product Name is unique
2.Component Name Inside Product is unique
3.Category Name Inside Component is unique
4.Test Case Name inside Category is unique
One you have set $g_check_names_for_duplicates=TRUE, you can configure how to proceed, if a duplicate name is found, using $g_action_on_duplicate_name.
The options are:
'allow_repeat' : allow the name to be repeated (backward compatibility with version 1.0.4 and 1.5.x)
'generate_new' : generate a new name using the value of $g_prefix_name_for_copy and the original object name.
'block' : return with an error .
Example of formatting:
$g_action_on_duplicate_name='allow_repeat'; 
$g_prefix_name_for_copy= strftime("%Y%m%d-%H:%M:%S", time());

5.3.3 Test Plan relation to Product

Starting with version 1.6 when you create a Test Plan, it's associated to the current selected Product as default. This is means you can filter Test Plans by Product.
Before Teslink 1.6 the Test Plans where not associated to an specific Product. When upgrading from 1.5.x to 1.6, it's not possible for the installer to know to which Product relates ogni test plan, then Product ID is set to 0. This results in a situation where you find you can't see any of your old Test Plans !!!. To solve this problem the following configuration parameter was added:
$g_show_tp_without_prodid=TRUE;
You can also via DB administration assign this relation manual and use this feature for data from previous version.
 
5.3.4 Filtering Test Plans by Product

As stated before the default behavour for version 1.6, is to filter Test Plan by Product. Using the following configuration parameter: $g_ui_show_check_filter_tp_by_product.
You can:
Allow the user, through the user interface , to enable/disable test plan filter by Product. A check box is displayed over the test plan combo box. ($g_ui_show_check_filter_tp_by_product = TRUE)
Force Test Plan filtering, without any user possibility to change it.
$g_ui_show_check_filter_tp_by_product = FALSE;

5.3.5 Keyword Management

If you don't want to create multiple times the same keyword for the same Product:
$g_allow_duplicate_keywords=FALSE;

5.3.6 地域ごとの日付と時間設定

For every defined locale, you can set the format for date and time presentation. This is configured using the following associative arrays: $g_locales_date_format and $g_locales_timestamp_format.
At time of this writting the configuration is :
$g_locales_date_format = array(
	'en_GB' => "%d/%m/%Y", 'it_IT' => "%d/%m/%Y", 
	'es_AR' => "%d/%m/%Y", 'es_ES' => "%d/%m/%Y", 
	'de_DE' => "%d.%m.%Y", 'fr_FR' => "%d/%m/%Y", 
	'pt_BR' => "%d/%m/%Y" ); 
$g_locales_timestamp_format = array(
	'en_GB' => "%d/%m/%Y %H:%M:%S", 
	'it_IT' => "%d/%m/%Y %H:%M:%S", 
	'es_AR' => "%d/%m/%Y %H:%M:%S", 
	'es_ES' => "%d/%m/%Y %H:%M:%S", 
	'de_DE' => "%d.%m.%Y %H:%M:%S", 
	'fr_FR' => "%d/%m/%Y %H:%M:%S", 
	'pt_BR' => "%d/%m/%Y %H:%M:%S", );
If there is no entry in the previous arrays, the value of the following configuration variables will be used: $g_date_format and $g_timestamp_format.
Example of formatting:
$g_date_format ="%d/%m/%Y"; 
$g_timestamp_format = "%d/%m/%Y %H:%M:%S";

>>> begin >>> 
全ての違う地域の日付と時間の表示フォーマットを設定できます。
次の結合配列を使用して設定してください: $g_locales_date_format,$g_locales_timestamp_format
時間設定に関しては以下を参照してください:
$g_locales_date_format = array(
	'en_GB' => "%d/%m/%Y", 'it_IT' => "%d/%m/%Y", 
	'es_AR' => "%d/%m/%Y", 'es_ES' => "%d/%m/%Y", 
	'de_DE' => "%d.%m.%Y", 'fr_FR' => "%d/%m/%Y", 
	'pt_BR' => "%d/%m/%Y" ); 
$g_locales_timestamp_format = array(
	'en_GB' => "%d/%m/%Y %H:%M:%S", 
	'it_IT' => "%d/%m/%Y %H:%M:%S", 
	'es_AR' => "%d/%m/%Y %H:%M:%S", 
	'es_ES' => "%d/%m/%Y %H:%M:%S", 
	'de_DE' => "%d.%m.%Y %H:%M:%S", 
	'fr_FR' => "%d/%m/%Y %H:%M:%S", 
	'pt_BR' => "%d/%m/%Y %H:%M:%S", );
もし、これらの配列にあなたの地域がないとしたら次の設定変数を使用してください: $g_date_format, $g_timestamp_format
フォーマット例:
$g_date_format ="%d/%m/%Y"; 
$g_timestamp_format = "%d/%m/%Y %H:%M:%S";
>>> end >>> 

5.3.7 要件からのテストケース作成

One of the unique features of Test Link is Requirement Management. After creating the Software Requirements Specifications (SRS), and populating it with requirements you can choose to create test cases for every requirement (Component and Category are also created).
Using the configuration object: $g_req_cfg, you can configure :
Name to give to the Component created:
$g_req_cfg->default_component_name="Component Created by Requirement - Auto";
Component's Scope
$g_req_cfg->scope_for_component="Component/Category/Test Cases generated from Requirements";
Name to give to the Category created:
$g_req_cfg->default_category_name="TODO";
Category's Objective description:
$g_req_cfg->objective_for_category="Category/Test Cases generated from Requirements";
For the Category name you can configure the following options:
$g_req_cfg->use_req_spec_as_category_name=TRUE;
Then REQuirement Specification Title is used a Category name.
$g_req_cfg->use_req_spec_as_category_name=FALSE;
Then $g_req_cfg->default_category_name is used a Category name.

>>> begin >>> 
TestLinkの特徴的な機能として要件管理があります。
ソフトウェア要件仕様(SRS)を作成、要件定義後でもすべての要件の
テストケースを作成し選択することができます。
(コンポーネント、カテゴリーが既に作成されていても)
設定オブジェクト$g_req_cfgを使用してコンポーネント作成のための
命名を設定できます。
$g_req_cfg->default_component_name="Component Created by Requirement - Auto"; 
コンポーネントのスコープ 
$g_req_cfg->scope_for_component="Component/Category/Test Cases generated from Requirements"; 
カテゴリ作成のための命名: 
$g_req_cfg->default_category_name="TODO"; 
カテゴリオブジェクト記述: 
$g_req_cfg->objective_for_category="Category/Test Cases generated from Requirements"; 
次のオプションでカテゴリ命名を設定できます: 
$g_req_cfg->use_req_spec_as_category_name=TRUE; 
要件仕様タイトルはカテゴリ名を使用します。 
$g_req_cfg->use_req_spec_as_category_name=FALSE; 
その後 $g_req_cfg->default_category_name として使用できます。
>>> end >>> 

5.3.8 Smartyテンプレートを使用するには(GUI定義)

If You want to test a different solution for the user interface, you can develop your own Smarty Templates. At the time of this writting we have defined the following configuration array:
$g_tpl
with the following entries:
$g_tpl['tcView']
$g_tpl['tcSearchView']
$g_tpl['tcEdit']
$g_tpl['tcNew']
$g_tpl['execSetResults']
This allows you to create templates with different names that the original Testlink, without the risk to overwrite them, during the next upgrade.
Important: Not all TestLink pages are ready for this kind of configuration.
The standard configuration:
$g_tpl['tcView'] = "tcView.tpl"; 
$g_tpl['tcSearchView'] = "tcSearchView.tpl"; 
$g_tpl['tcEdit'] = "tcEdit.tpl"; 
$g_tpl['tcNew'] = "tcNew.tpl"; 
$g_tpl['execSetResults'] = "execSetResults.tpl"; 

>>> begin >>> 
もしユーザインターフェースのために違うテストソリューションを使用したいと思うなら、
Smartyテンプレートを使用して開発することができます。
以下にTestLinkとの構成配列の差異を示します。
$g_tpl 
次のように入力してください: 
$g_tpl['tcView'] 
$g_tpl['tcSearchView'] 
$g_tpl['tcEdit'] 
$g_tpl['tcNew'] 
$g_tpl['execSetResults']
これらのテンプレートは上書きの危険性を避けるため次のアップグレードまで
TestLinkオリジナルのテンプレートとは違う名前で作成してください。 
重要：これらの構成設定はTestLink全ページに準備されているわけではありません。
標準の設定：
$g_tpl['tcView'] = "tcView.tpl"; 
$g_tpl['tcSearchView'] = "tcSearchView.tpl"; 
$g_tpl['tcEdit'] = "tcEdit.tpl"; 
$g_tpl['tcNew'] = "tcNew.tpl"; 
$g_tpl['execSetResults'] = "execSetResults.tpl"; 
>>> end >>> 

6 FAQ

しばしば発生する問題を掲載しました。TestLink forumも同様にご確認下さい。

旧バージョンからアップグレードしたら、ログインできなくなった

あなたのデータベースは異なったcharsetかもしれません。
バージョン1.6より、デフォルトのcharsetはUTF-8です。config.inc.phpにて、
DB_SUPPORTS_UTF8 を FALSE に切り替えてみて下さい。

ログインページの代わりにSmarty errorが表示される

Linux/unixユーザー: temp ディレクトリに正しい許可が与えられているか確認して下さい。
(default: <testlink_root>/gui/template_c/). 

Revision History:
#
Description
Date
Author
1.0
Initial creation of the document in DocXML
2005/03/12
A. Morsing
1.1
Corrected title, updated structure and added new sections.
2005/04/12
M. Havlat 
1.2
Added some words for MySQL 4.1, UTF8 support
2005/06/27
A. Morsing
1.3
Updated automatic installation part
2005/09/12
F. Mancardi
1.4
Updated for TL 1.6.; added configuration parameters; restructured (created pre-installation steps section); corrected layout; added phpMyAdmin steps description
2005/09/13
M. Havlat
2.0
Converted to OO2 format; added DB Charset update explanation from Kevin
2005/12/04
M. Havlat
2.1
Corrected layout for export to HTML and PDF
2005/12/11
M. Havlat
2.2
Some small changes
2005/12/17
A. Morsing
2.3
Minor layout and grammar update
2006/02/14
M. Havlat
2.4
Updated for TL 1.7
06/11/17
M. Havl?t

インストール & 構成 マニュアル
TestLink version 1.7








Copyright ? 2004,2005,2006 TestLink Development Community
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. The license is available in "GNU Free Documentation License" homepage.
---
翻訳: Testing Engineer's Forum (TEF) - ソフトウェアテスト技術者交流会 -
「TEF有志によるTestLink日本語化プロジェクト」部会
---

1 このドキュメントの範囲

このドキュメントは、TestLink 1.7のインストールと構成方法に関するリファレンスと知識基盤を提供します。初めの部分は、インストールの手順、次の部分は構成方法の説明になっています。
最新のドキュメントは TestLinkのホームページで参照することができます。さらに TestLink フォーラムで問題の解決方法を質問することもできます。

インストール手順の概要:

1.Install background services
2.Tranfer and uncompress files into web directory
3.Generate database tables and add data (create default or transfer from previous db)
4.Edit configuration files
5.PHP File extensions
6.Login

1.使用するサービス環境のインストール
2.Webserverへの展開
3.データベーステーブルの作成とデータの追加(新規作成、または、以前のデータベースからの移行)
4.設定ファイルの編集
5.PHPの拡張設定
6.ログイン

2 必要とするシステム資源

TestLink requires these applications as background:
Database
MySQL 4.1.x and higher (4.0.x doesn't support UTF-8) 
Postgres
MS SQL
php 5.x and higher (version 5.2 is recommended)
Webserver (Apache 1.3.x or 2.x and higher, IIS 3 and higher, etc.). See <php_root>/install.txt for more information.
There is no requirement about your operating system (tested on Linux and MS Win32).
You can use also MySQL on different server than TestLink. 

TestLinkに必要な環境は以下の通りです：
データベース
MySQL 4.1.x もしくはそれ以上のバージョン
(4.0.x はUTF-8をサポートしていないため使用できません)
PostgresSQL
MS SQL

スクリプト
PHP 5.x以上(推奨は5.2です)

Webserver
Apache 1.3.x。 2.x またはそれ以上
IIS 3 以上
その他

使用環境
OSには依存しません(LinuxとWin32環境では確認済みです)
MySQLは様々なサーバで使用できるのでお勧めです

3 インストールの準備

Do the next steps before installation:
1.Install environment: Webserver, php4 and MySQL. Refer to documentation of these products. You can also find installations package of all these products and install it together. E.g. XAMPP, EasyPHP, Uniform Server, etc.
2.Transfer the TestLink installation file to your webserver using whatever method you like best (ftp, scp, etc.). You will need to telnet/ssh into the server machine for the next steps.
3.Next, untar/gunzip it to the directory that you want. The usual command is (1 step):
# tar zxvf <filename.tar.gz>
or
# gunzip <filename.tar.gz>
# tar xvf <filename.tar>
Winzip, Stuffit, and other programs should also be able to handle decompression of the archive.
At this point you may want to rename the directory to something simpler like 'testlink'. You will use the mv command to rename a directory (Windows users substitute the "ren" command or use explorer).
# mv <directory_name> testlink
4.Continue Installation or Upgrade.

>>> begin >>>
インストールを始める前に、以下のことを行ってください。
1.  環境のインストール：Webserver, php4, MySQL
    これらの製品のドキュメントを参照してください。
    また、これらの製品全てのインストールするパッケージを
    見つけて、インストールしてください。
    例  XAMPP, EasyPHP, Uniform Server など

2.  あなたの使う webserver に TestLink のインストールファイルを
    一番やりやすい方法で転送してください。(ftp, scp, 等)
    次のステップでは telnet か ssh がサーバーマシンに入っていることが
    必要です。

3.  次に、好きなディレクトリに untar か gunzip で解凍します。
    通常は以下のようなものです。(1 step): 
    # tar zxvf <filename.tar.gz> 
    もしくは
    # gunzip <filename.tar.gz> 
    # tar xvf <filename.tar> 
    Winzip や Stuffit などの他の解凍プログラムでも同じような操作で
    アーカイブを解凍できます。

    解凍したら、mv や rendir で、ディレクトリ名を単なる testlink に
    変えてください。
    (Windows の場合はコマンドラインの ren やエクスプローラで変えます)
    # mv <directory_name> testlink 

4.  インストールやアップグレードを続行します。
>>> end >>>

4 インストール

You can use automatic scripted installation or manual steps. If you are upgrading from a previous version of TestLink look at the Upgrading section.

>>> begin >>>
自動でのインストール、手動でのインストールのどちらでもできます。
もし、前バージョンの TestLink をアップグレードするのなら
アップグレードの章を読んでください。
>>> end >>>

4.1 自働でのインストール

The following details the basic steps for installation on any system. The instructions may seem unix-centric but should work fine on Windows systems. Barring complications, it should take you about 10-30 minutes to install, configure, and be using TestLink.
This installation process has changed with release 1.6. Next we will create the necessary database tables and a basic configuration file.
1.From your web browser access http://<yoursite>/testlink/install/index.php.
2.This page will walk through the following steps:
check basic parameters for the web server, php config and DB version.
prompt for the database type and location, and a database user/password pair. For installation, an administrative user/password pair can also be provided. The operating user requires ALTER, SELECT, INSERT, and UPDATE privileges. For installation, INDEX, CREATE, DELETE, and DROP privileges are also required.
create the database and tables.
Warning:
A DEFAULT ADMINISTRATOR level account is created.
The account name and password are: admin / admin. Use this when you first login to TestLink. Immediately go to Manage and create at least one administrator level account. Immediately after that DISABLE or DELETE the admin account. You can recreate it but you should delete the account to prevent the cookie_string from being used to trick the package. It would be even better to rename the account or delete it permanently. REMEMBER: After setting up the package, REMOVE the default admin account
perform some post installation checks on the system.
3.After a successful upgrade you should remove the <testlinkwebdir>/install/ directory for security reasons.
4.The next part involves configuring the installation to work with your specific setup. See configuration section for description of configurable parameter.

>>> begin >>>
システムにインストールするための基本的な手順を以下に示します。
命令の記述は unix を主な対象としていますが、Windows でも同じように
行ってください。
コンパイルなしで使えるのなら、インストール、コンフィギュレーションを行って
TestLink を使えるようになるまでにかかる時間は、10 分から 30 分程度です。
このインストール手順は release 1.6 で変更されました。
次からは、database tables と basic configuration file を作成することが
必要になります。

1.  Web ブラウザで http://<yoursite>/testlink/install/index.php に
    アクセスします。

2.  このページは以下のステップのリハーサルをします(walk through)：
    web server 、php のコンフィギュレーション、DB バージョンの
    基本的なパラメータのチェック。
    データベースのタイプや位置、ユーザやパスワードの指定。
    インストールには、アドミニストレータ権限を持つユーザとパスワードが
    必要です。変更、選択、挿入、更新の各操作を行う権利を要求するためです。
    また、インストールには、データベースや(データ)テーブルを生成するために
    インデックス、生成、削除、中断(DROP)操作を行う権利も必要です。
    警告：
    デフォルトのアドミニストレータレベルのアカウントは生成されています。
    アカウント名とパスワードは右のものです：admin / admin
    TestLink に最初にログインするときは、これを使用してください。
    ログイン後、まず最初に、最低でも一つのアドミニストレータレベルの
    アカウントを生成してください。そして最初のアドミニストレータの
    アカウント(admin)を無効にするか、削除してください。
    あなたは、この最初のアドミニストレータのアカウントを再生成できますが
    Testlink に対するクッキー文字列を使った犯罪(trick)を避けるために
    このアカウント(admin)は削除することを強くお勧めします。
    このアカウント(admin)は永久に使用しないことがお勧めです。
    覚えておいてください：パッケージの設定後、システム上でインストール後の
    操作を行う前に、デフォルトのアドミニストレータのアカウントを削除することを。

3.  更新が成功したら、セキュリティ上の理由のため、
    下記のディレクトリ以下を削除してください。
    <testlinkwebdir>/install/

4.  次のパートでは固有のセットアップ事項に基づいた
    コンフィギュレーションを行います。
>>> end >>>


4.1.1 手動でのインストール

If you want to perform a Manual installation (not recomended) here are the steps needed for a successful installation. For installing the DB you can either choose the command line tools available in your MySQL installation or any MySQL Database Client (e.g. phpMyAdmin).
Prepare MySQL via command line tools:
Create a new empty MySQL database.
for MySQL >= 4.1 (with UTF8) do CREATE DATABASE testlink CHARACTER SET utf8 COLLATE utf8_general_ci By choosing UTF8 you should also change the value of DB_SUPPORTS_UTF8 to TRUE in your <testlinkdir>/config.inc.php See Configuration for more.
Create tables for 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
Populate initial data for the newly created database (admin account, default roles).
# mysql -u <user> -p<password> <dbname> < <testlinkdir>/install/sql/testlink_create_default_data.sql
Alternatively you can use phpMyAdmin:
Create new database from main page (recommended UTF-8 character set).
Optionally create a new user and assign him correct rights for the created database.
Select the created database in the left pane.
Navigate to SQL window.
Upload SQL request from files /install/sql/testlink_create_tables.sql and run the script.
Upload SQL request from files /install/sql/testlink_create_default_data.sql and run the script.
Create a <testlinkdir>/config_db.inc.php file with the following data (example):
<?php // Automatically Generated by TestLink Installer 
define('DB_TYPE', 'mysql'); 
define('DB_USER', 'testlinker'); 
define('DB_PASS', 'testlink_pass'); 
define('DB_HOST', 'localhost'); 
define('DB_NAME', 'tl_master'); 
?>
(Optional) Create a DB user for connection from TestLink. Don't forget to assign a correct rights (at least SELECT, INSERT, UPDATE, DELETE) for the created database. The user must be defined in config_db.inc.php. Otherwise you can use any other user available in MySQL database with correct rights.
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. TestLink notifies if you don't do it.
After a successful upgrade you should remove the <testlinkwebdir>/install/ directory for security reasons.
The next part involves configuring the installation to work with your specific setup. See configuration section for description of configurable parameter.
Report any issues or feedback to TestLink Bug tracking system page.

>>> begin >>>
もし、手動でのインストールを行うなら(非推奨)、以下の手順で行ってください。
データベースのインストールは、MySQL のインストールで使用したコマンドライン
ツールか、MySQL のデータベースクライアント (例 phpMyAdmin) が選べます。

コマンドラインツールでの MySQL の準備：
新しい空の MySQL データベースを生成します。
MySQL は 4.1 以上(UTF8 の場合) で、testlink のデータベースの生成を行います。
文字セットは utf8_general_ci に UTF8 を選択することでutf8 で照合します。
また、<testlinkdir>/config.inc.php の中のDB_SUPPORTS_UTF8 の値も 
TRUE に変えてください。
詳細については、コンフィギュレーション(Configuration)を参照してください。
以下の書式で、新しく生成したデータベース用のテーブルを生成します。
# mysql -u <user> -p<password> <dbname> < <testlinkdir>/install/sql/testlink_create_tables.sql
例 # mysql -u testlink -ppass testlink < /var/www/html/testlink/install/sql/testlink_create_tables.sql 
以下の書式で、新しく生成したデータベース用の初期データを投入します。
(デフォルトはアドミンのアカウントです)
# mysql -u <user> -p<password> <dbname> < <testlinkdir>/install/sql/testlink_create_default_data.sql 

phpMyAdmin を使用する場合：
main page から新しいデータベースを生成します(UTF-8 文字セットを推奨)。
データベースの生成では、オプションで、新しいユーザの生成と権限の
割り当てが行えます。
左側のペイン(ウィンドウ枠)で、データベースの生成を選んでください。
SQL window がナビゲイトします。

/install/sql/testlink_create_tables.sql ファイルの SQL 要求を
アップロードして、そのスクリプトを実行します。
/install/sql/testlink_create_default_data.sql ファイルの SQL 要求を
アップロードして、そのスクリプトを実行します。
<テストリンクディレクトリ>/config_db.inc.php を生成して、
以下の例を参考にデータを設定してください：
<?php // Automatically Generated by TestLink Installer 
define('DB_TYPE', 'mysql'); 
define('DB_USER', 'testlinker'); 
define('DB_PASS', 'testlink_pass'); 
define('DB_HOST', 'localhost'); 
define('DB_NAME', 'tl_master'); 
?> 

(オプション)TestLink から繋ぐことのできるDB ユーザーを生成します。
ユーザーにはデータベース生成の権限を与えることを忘れないように！
(最低限の権限は選択、挿入、更新、削除です)
ユーザーは config_db.inc.php で定義されていることが必要です。
そのほかの点では、MySQL データベースの権限を他のユーザーと同じように
使えます。
Linux / UNIX 上では、webserver によって書き込みが可能なように
templates_c ディレクトリのパーミッションを変えてください。
TestLink のルートディレクトリから以下のように実行します。
# chmod 777 gui/templates_c 

TestLink のデフォルトでのログインは以下を使用します：
user: admin; pass: admin
このパスワードは、安全のためにログインしたらすぐに変更すべきです。
もし、変更しなければ TestLink から通告されます。
アップグレード成功後は、安全のために
<testlinkwebdir>/install/ ディレクトリは削除してください。

次にやることはあなたの環境に合わせたコンフィギュレーションです。
コンフィギュレーション可能なパラメータについては
コンフィギュレーション セクションを参照してください。

問題点やフィードバックに関しては、TestLink Bug tracking system ページに
報告をお願いします。
>>> end >>>


4.2 プログラムのバージョンアップ

主要なバージョンアップ:手動と自動(スクリプト経由)のどちらでも可能です。
どちらの方法であっても、TL 1.6, 1.5, 1.0.4に対してデータベースのいくつかの変更があるため、
直接にオリジナルのデータベースを使う事はできません。
Hot-Fix(修正)バージョンへのバージョンアップは必須ではありません (例:1.7.0 -> 1.7.2)。

4.2.1 Hot-Fixリリース(修正プログラム)へのアップグレード

Maintenance (Bug fixing) release is for example 1.6.0 -> 1.6.1. Database schema doesn't changed in this case. 
Save files of the previous version.
Remove the all files from directory.
Copy a new version to the same directory.
Copy config_db file to the new structure and modify configuration parameters acording your previous settings.
Now, it should work.

>>> begin >>> 
例えば1.6.0 -> 1.6.1のように保守(バグ修正)プログラムを公開することがあります。
この場合はデータベーススキーマは変更されません。
前のバージョンのファイルを保存してください。(別のディレクトリに)
すべてのファイルをディレクトリから削除してください。
同じディレクトリに新しいバージョンをコピーしてください。
新しいファイル構造に対してconfig_dbファイルをコピーするとともに、
前のバージョンに適用していた設定に沿って構成パラメータを修正してください。
これで更新完了です。
>>> end >>> 

4.2.2 メジャーバージョンへの自動アップグレード

Follows preinstallation steps.
From a web browser run http://<testlinkwebdir>/install/index.php
Choose 'Upgrade Installation' link. Run the scripts until you see that process is finished.
After a successful upgrade you should remove the <testlinkwebdir>/install/ directory for security reasons.
The next part involves configuring the installation to work with your specific setup. See configuration section for description of configurable parameter.
Report any issues or feedback to TestLink Bug tracking system page.

>>> begin >>> 
まず次のプレインストール手順を行ってください。
ブラウザからhttp://<testlinkwebdir>/install/index.phpを表示してください。
'アップグレード インストール'リンクを選択してください。
スクリプトが実行されるので終了まで待ちます。
アップグレードに成功したのち、<testlinkwebdir>/install/ディレクトリはセキュリティの問題があるので削除してください。
次は個別のセットアップ環境の構成インストールです。設定パラメータを記述している設定の節を参照してください。
TestLinkバグ追跡システムページのインストールの結果やフィードバックが作成されます。
>>> end >>> 

4.2.3 手動でのバージョンアップ

This chapter describe changes in against previous versions. The automatic upgrade is recommended. Use this chapter for a special cases and fiddling config. You can do it of course after a study of changes in database and installation script. Good idea is to compare SQL files for create db tables (your current version and a new one).

>>> begin >>> 
この章は前のバージョンを考慮して変更することを記述しています。
自動アップグレードを推奨しています。
この章の内容は特殊なケースやわずかな構成の場合に使用します。
データベース変更やインストールスクリプトの学習後にこれらを行うことができるようになります。
(現在のバージョンと新しいバージョンの)DB作成SQLファイルを比較することは良い考えになるでしょう。
>>> end >>> 

4.2.4 データベーススキーマ変更

user password is encrypted (1.5)
A new tables for SRS feature: requirements,  req_coverage, requirement_doc (1.6)
Attachments (1.7)
Custom fields (1.7)

>>> begin >>> 
ユーザパスワードは暗号化されています。(1.5)
SRS機能のための新しいテーブル：要件、req_coverage、requirement_doc (1.6)
添付ファイル(1.7)
カスタムフィールド(1.7)
>>> end >>> 

4.2.5 旧バージョンとの互換性

TL 1.0.4 has not  relation Test Plan relation to Product. The solution from TL 1.6 table include field Product ID in the table. Test Plans could be available over all Products. Such Test Plan has Product ID value = 0.
Configuration within <testlinkinstalldir>/config.inc.php: 
$g_show_tp_without_prodid=1; 
$g_ui_show_check_filter_tp_by_product = 1;.

4.2.5.1 Latin to UTF-8 conversion (upgrade from 1.5 and older)

TestLink 1.6 allows for UTF-8 encoded character rendering, therefore any extended character data that may have snuck into your database and didn't show up in 1.5 may start appearing in 1.6 UI.  You can turn UTF-8 support off in testlink by modifying a value in the <testlinkinstalldir>/config.inc.php file, but then you will be missing out on the ability to use characters beyond ASCII.

If you have the same problem I did and see lots of extended characters appearing in your data after upgrading to 1.6 and having UTF-8 support turned on, you should read through the following instructions. Be sure to practice this exercise on a test machine before performing on your deployment system.

The instructions will help you clear out any non-ASCII characters from your database and setup your database to support UTF-8.

First make a backup of your current database using the mysqldump utility.
# /usr/bin/mysqldump -u root testlink15 -p > testlink15.backup
Now edit testlink15.backup so schema definitions for EACH table has utf8 encoding specified. Change the CHARSET for each table from latin1 to utf8. For example the following line in the definition of 1 table which reads as follows :
ENGINE=MyISAM DEFAULT CHARSET=latin1 COMMENT='This table holds the bugs filed for each result'; 
should be changed to 
ENGINE=MyISAM DEFAULT CHARSET=utf8 COMMENT='This table holds the bugs filed for each result';
Then ran testlink15.backup thru my the perl script below as follows:
/replaceScript.pl < testlink15.backup > testlink15.cleaned
replaceScript.pl is as follows :
#!/usr/bin/perl
while (<>) {
        chomp;
        tr/\000-\177/\040/cs;
        print $_, "\n";
}
Created an empty testlink16 db with utf8 charset as follows:
CREATE DATABASE testlink16 CHARACTER SET utf8;

Install the tables into the new database
# mysql testlink16 -u root -p < testlink15.cleaned

You can verify your database's "Db characterset" is now set to utf8 by using the following command:
login to mysql
use testlink16
mysql> \s
--------------
mysql  Ver 14.7 Distrib 4.1.11, for redhat-linux-gnu (i386)
Connection id:          26
Current database:       testlink15
Current user:           bugz@localhost
SSL:                    Not in use
Current pager:          stdout
Using outfile:          ''
Using delimiter:        ;
Server version:         4.1.11
Protocol version:       10
Connection:             Localhost via UNIX socket
Server characterset:    latin1
Db     characterset:    utf8
Client characterset:    latin1
Conn.  characterset:    latin1
UNIX socket:            /var/lib/mysql/mysql.sock
Uptime:                 36 min 55 sec

Run the upgrade installation provided by Testlink 1.6.

Other resources:
what the heck is UTF-8 ? 
http://www.joelonsoftware.com/articles/Unicode.html
octal table (you can see octal values 000 - 177 are "normal ascii" characters).
The perl script that is provided searches based on octal values.
http://web.cs.mun.ca/~michael/c/ascii-table.html
description of tr perl operation
http://www.unix.org.ua/orelly/perl/learn/ch15_05.htm

5 コンフィグレーション

5.1 コンフィグレーションファイル

すべての構成パラメータはconfig.inc.phpファイルにあります。このリリース(1.6)では、下記が構成ファイルになります。
<testlink installation directory>/config.inc.php
<testlink installation directory>/config_db.inc.php
<testlink installation directory>/cfg/<bug_tracking_system>.cfg.php

config.inc.php
メインの構成ファイルです。下記を参照して下さい。

config_db.inc.php
データベースにアクセスするための構成ファイルです。このファイルはインストーラにより、インストールあるいはアップグレード中に作成されます。通常このファイルをユーザが変更することはありません。

/cfg/bugzilla.cfg.php
/cfg/mantis.cfg.php
/cfg/jira.cfg.php
これらはそれぞれ、bugzilla, mantis, jiraのバグトレースシステムにアクセスするための構成ファイルです。
テストリンクからのこれらのシステムにアクセスしたい場合にはこれらのファイルを編集する必要があります。
この機能を使用したい場合には、config.inc.phpのパラメータをあわせて変更する必要があります。

5.2 構成パラメータ

DB_SUPPORTS_UTF8
MYSQLのバージョンが4.1以前のとき（UTF8サポートなし）の場合にはFALSEを設定してください。これによりすべてのページでキャラクタセットがISO-8859-1に設定されます。またデータベース内のキャラクタセットはlatin1に設定されます。

MySQLのバージョンが >= 4.1ならばTRUEに設定してください。それによりすべてのページでUTF-8がサポートされ、データベース内のデータのキャラクタセットはUTF8二設定されます。 
TL_LOG_LEVEL_DEFAULT
デフォルトのログ出力レベル(NONE, ERROR, INFO, DEBUG)を設定します。TestLinkは出力されたログのファイルサイズをチェックします。
例）DEBUGレベルは開発もしくはバグの調査のみに使用し、ディスク使用量を少なめにします。ERRORが通常のログ出力レベルが推奨されます。
TL_LOG_PATH
TestLinkから出力されるログのパスとファイル名を指定します。
例）/tmp/testlink.log
MAIN_PAGE_METRICS_ENABLED
このパラメータはメトリクステーブルがメインのページに表示されるかを指定します。
TRUEもしくはFALSEを指定してください。

TL_INTERFACE_BUGS
このパラメータはバグトラッキングへのインタフェースを設定します。値としては以下が設定できます。'NO', 'BUGZILLA', 'MANTIS', 'JIRA' (TestLink >= 1.6)
bugzillaの構成についてはcfg/bugzilla.cfg.phpを参照して下さい。Supported version: 0.19.1
mantisの構成についてはcfg/mantis.cfg.phpを参照してください。Supported version: 1.0.0.a3
JIRAの構成についてはcfg/jira.cfg.phpを参照してください。Supported version: JIRA 3.1.1
TL_TREE_KIND
このパラメータはTestLinkで使用されているツリー形式のメニューを設定します。値としては以下が設定されます。'LAYERSMENU', 'DTREE', 'JTREE'。LAYERSMENUがデフォルト値です。このコンポーネントはJTREEでもっともよいパフォーマンスが期待できます。その他の値では、最後にカーソルが当たっていた場所を保存できます。

TL_IMPORT_LIMIT
アップロードできる最大のファイルサイズを設定します。デフォルト値は200000です。この値を増やすことで、より大きいファイルをアップロードできます。パラメータしてTL_IMPORT_ROW_MAXがあります。このパラメータはエクスポートファイルの１行の最大サイズを設定します。この値のデフォルトは10000が設定されています。
$g_fckeditor_toolbar
fckeditorツールバーの定義をします。このパラメータによりfckeditorツールバーを構成できます。より詳細な情報についてはfckeditorのホームページを参照してください。

TL_TPL_CHARSET
中国語のユーザのみに適用されます。この値を以下のように設定します。Set: define('TL_TPL_CHARSET', 'gb2312'); これにより正しいキャラクタセットが設定されます。その他の言語ではこのパラメータを設定する必要がありません。

TL_DEFAULT_LOCALE
このパラメータではデフォルトロケールを設定します。このパラメータに設定する値は$g_localesに設定されているいづれかの値です。(同じ構成ファイルで設定されています)。デフォルト値はen_GBが設定されています。

TL_COMPANY, TL_DOC_COPYRIGHT, TL_DOC_CONFIDENT
このパラメータに設定された文字列は印刷されたドキュメントの表紙に出力されます（Version 1.6以降で有効です）。使用されない場合には、ブランクにしてください。

5.3 Customization

5.3.1 Cascading Style Sheet

You can change TestLink appearance writing you own CSS (Cascading Style Sheet) files.
You have to change the following constants:
define('TL_LOGIN_CSS','gui/css/tl_login.css'); - All Login/Logout pages CSS
define('TL_TESTLINK_CSS','gui/css/testlink.css'); - Main CSS
define('TL_DOC_BASIC_CSS','gui/css/tl_doc_basic.css'); - Used in Reports
Important: paths to CSS are relative to the <testlink installation directory>
If you want to use your own CSS files we suggest you to proceed as follow:
1.create a new directory inside the gui directory, example gui/css/my_css/
2.copy the testlink original files to the new directory (you can change the names if you want)
3.modify them at your will
4.edit config.inc.php
// Original configuration 
//define('TL_LOGIN_CSS','gui/css/tl_login.css'); //define('TL_TESTLINK_CSS','gui/css/testlink.css'); //define('TL_DOC_BASIC_CSS','gui/css/tl_doc_basic.css');  define('TL_LOGIN_CSS','gui/css/my_css/tl_login_acqua.css'); define('TL_TESTLINK_CSS','gui/css/my_css/testlink_acqua.css'); define('TL_DOC_BASIC_CSS','gui/css/my_css/tl_doc_basic.css');

5.3.2 Duplicate names for Products, Components, Categories, Test Cases

As you know, is possible to create one of this objects (Products, Components, Categories, testcases) doing a copy of an existing one.
You can configure how to proceed when the copy is done:
if you set $g_check_names_for_duplicates=TRUE then the following checks will be done:
1.Product Name is unique
2.Component Name Inside Product is unique
3.Category Name Inside Component is unique
4.Test Case Name inside Category is unique
One you have set $g_check_names_for_duplicates=TRUE, you can configure how to proceed, if a duplicate name is found, using $g_action_on_duplicate_name.
The options are:
'allow_repeat' : allow the name to be repeated (backward compatibility with version 1.0.4 and 1.5.x)
'generate_new' : generate a new name using the value of $g_prefix_name_for_copy and the original object name.
'block' : return with an error .
Example of formatting:
$g_action_on_duplicate_name='allow_repeat'; 
$g_prefix_name_for_copy= strftime("%Y%m%d-%H:%M:%S", time());

5.3.3 Test Plan relation to Product

Starting with version 1.6 when you create a Test Plan, it's associated to the current selected Product as default. This is means you can filter Test Plans by Product.
Before Teslink 1.6 the Test Plans where not associated to an specific Product. When upgrading from 1.5.x to 1.6, it's not possible for the installer to know to which Product relates ogni test plan, then Product ID is set to 0. This results in a situation where you find you can't see any of your old Test Plans !!!. To solve this problem the following configuration parameter was added:
$g_show_tp_without_prodid=TRUE;
You can also via DB administration assign this relation manual and use this feature for data from previous version.
 
5.3.4 Filtering Test Plans by Product

As stated before the default behavour for version 1.6, is to filter Test Plan by Product. Using the following configuration parameter: $g_ui_show_check_filter_tp_by_product.
You can:
Allow the user, through the user interface , to enable/disable test plan filter by Product. A check box is displayed over the test plan combo box. ($g_ui_show_check_filter_tp_by_product = TRUE)
Force Test Plan filtering, without any user possibility to change it.
$g_ui_show_check_filter_tp_by_product = FALSE;

5.3.5 Keyword Management

If you don't want to create multiple times the same keyword for the same Product:
$g_allow_duplicate_keywords=FALSE;

5.3.6 地域ごとの日付と時間設定

For every defined locale, you can set the format for date and time presentation. This is configured using the following associative arrays: $g_locales_date_format and $g_locales_timestamp_format.
At time of this writting the configuration is :
$g_locales_date_format = array(
	'en_GB' => "%d/%m/%Y", 'it_IT' => "%d/%m/%Y", 
	'es_AR' => "%d/%m/%Y", 'es_ES' => "%d/%m/%Y", 
	'de_DE' => "%d.%m.%Y", 'fr_FR' => "%d/%m/%Y", 
	'pt_BR' => "%d/%m/%Y" ); 
$g_locales_timestamp_format = array(
	'en_GB' => "%d/%m/%Y %H:%M:%S", 
	'it_IT' => "%d/%m/%Y %H:%M:%S", 
	'es_AR' => "%d/%m/%Y %H:%M:%S", 
	'es_ES' => "%d/%m/%Y %H:%M:%S", 
	'de_DE' => "%d.%m.%Y %H:%M:%S", 
	'fr_FR' => "%d/%m/%Y %H:%M:%S", 
	'pt_BR' => "%d/%m/%Y %H:%M:%S", );
If there is no entry in the previous arrays, the value of the following configuration variables will be used: $g_date_format and $g_timestamp_format.
Example of formatting:
$g_date_format ="%d/%m/%Y"; 
$g_timestamp_format = "%d/%m/%Y %H:%M:%S";

>>> begin >>> 
全ての違う地域の日付と時間の表示フォーマットを設定できます。
次の結合配列を使用して設定してください: $g_locales_date_format,$g_locales_timestamp_format
時間設定に関しては以下を参照してください:
$g_locales_date_format = array(
	'en_GB' => "%d/%m/%Y", 'it_IT' => "%d/%m/%Y", 
	'es_AR' => "%d/%m/%Y", 'es_ES' => "%d/%m/%Y", 
	'de_DE' => "%d.%m.%Y", 'fr_FR' => "%d/%m/%Y", 
	'pt_BR' => "%d/%m/%Y" ); 
$g_locales_timestamp_format = array(
	'en_GB' => "%d/%m/%Y %H:%M:%S", 
	'it_IT' => "%d/%m/%Y %H:%M:%S", 
	'es_AR' => "%d/%m/%Y %H:%M:%S", 
	'es_ES' => "%d/%m/%Y %H:%M:%S", 
	'de_DE' => "%d.%m.%Y %H:%M:%S", 
	'fr_FR' => "%d/%m/%Y %H:%M:%S", 
	'pt_BR' => "%d/%m/%Y %H:%M:%S", );
もし、これらの配列にあなたの地域がないとしたら次の設定変数を使用してください: $g_date_format, $g_timestamp_format
フォーマット例:
$g_date_format ="%d/%m/%Y"; 
$g_timestamp_format = "%d/%m/%Y %H:%M:%S";
>>> end >>> 

5.3.7 要件からのテストケース作成

One of the unique features of Test Link is Requirement Management. After creating the Software Requirements Specifications (SRS), and populating it with requirements you can choose to create test cases for every requirement (Component and Category are also created).
Using the configuration object: $g_req_cfg, you can configure :
Name to give to the Component created:
$g_req_cfg->default_component_name="Component Created by Requirement - Auto";
Component's Scope
$g_req_cfg->scope_for_component="Component/Category/Test Cases generated from Requirements";
Name to give to the Category created:
$g_req_cfg->default_category_name="TODO";
Category's Objective description:
$g_req_cfg->objective_for_category="Category/Test Cases generated from Requirements";
For the Category name you can configure the following options:
$g_req_cfg->use_req_spec_as_category_name=TRUE;
Then REQuirement Specification Title is used a Category name.
$g_req_cfg->use_req_spec_as_category_name=FALSE;
Then $g_req_cfg->default_category_name is used a Category name.

>>> begin >>> 
TestLinkの特徴的な機能として要件管理があります。
ソフトウェア要件仕様(SRS)を作成、要件定義後でもすべての要件の
テストケースを作成し選択することができます。
(コンポーネント、カテゴリーが既に作成されていても)
設定オブジェクト$g_req_cfgを使用してコンポーネント作成のための
命名を設定できます。
$g_req_cfg->default_component_name="Component Created by Requirement - Auto"; 
コンポーネントのスコープ 
$g_req_cfg->scope_for_component="Component/Category/Test Cases generated from Requirements"; 
カテゴリ作成のための命名: 
$g_req_cfg->default_category_name="TODO"; 
カテゴリオブジェクト記述: 
$g_req_cfg->objective_for_category="Category/Test Cases generated from Requirements"; 
次のオプションでカテゴリ命名を設定できます: 
$g_req_cfg->use_req_spec_as_category_name=TRUE; 
要件仕様タイトルはカテゴリ名を使用します。 
$g_req_cfg->use_req_spec_as_category_name=FALSE; 
その後 $g_req_cfg->default_category_name として使用できます。
>>> end >>> 

5.3.8 Smartyテンプレートを使用するには(GUI定義)

If You want to test a different solution for the user interface, you can develop your own Smarty Templates. At the time of this writting we have defined the following configuration array:
$g_tpl
with the following entries:
$g_tpl['tcView']
$g_tpl['tcSearchView']
$g_tpl['tcEdit']
$g_tpl['tcNew']
$g_tpl['execSetResults']
This allows you to create templates with different names that the original Testlink, without the risk to overwrite them, during the next upgrade.
Important: Not all TestLink pages are ready for this kind of configuration.
The standard configuration:
$g_tpl['tcView'] = "tcView.tpl"; 
$g_tpl['tcSearchView'] = "tcSearchView.tpl"; 
$g_tpl['tcEdit'] = "tcEdit.tpl"; 
$g_tpl['tcNew'] = "tcNew.tpl"; 
$g_tpl['execSetResults'] = "execSetResults.tpl"; 

>>> begin >>> 
もしユーザインターフェースのために違うテストソリューションを使用したいと思うなら、
Smartyテンプレートを使用して開発することができます。
以下にTestLinkとの構成配列の差異を示します。
$g_tpl 
次のように入力してください: 
$g_tpl['tcView'] 
$g_tpl['tcSearchView'] 
$g_tpl['tcEdit'] 
$g_tpl['tcNew'] 
$g_tpl['execSetResults']
これらのテンプレートは上書きの危険性を避けるため次のアップグレードまで
TestLinkオリジナルのテンプレートとは違う名前で作成してください。 
重要：これらの構成設定はTestLink全ページに準備されているわけではありません。
標準の設定：
$g_tpl['tcView'] = "tcView.tpl"; 
$g_tpl['tcSearchView'] = "tcSearchView.tpl"; 
$g_tpl['tcEdit'] = "tcEdit.tpl"; 
$g_tpl['tcNew'] = "tcNew.tpl"; 
$g_tpl['execSetResults'] = "execSetResults.tpl"; 
>>> end >>> 

6 FAQ

しばしば発生する問題を掲載しました。TestLink forumも同様にご確認下さい。

旧バージョンからアップグレードしたら、ログインできなくなった

あなたのデータベースは異なったcharsetかもしれません。
バージョン1.6より、デフォルトのcharsetはUTF-8です。config.inc.phpにて、
DB_SUPPORTS_UTF8 を FALSE に切り替えてみて下さい。

ログインページの代わりにSmarty errorが表示される

Linux/unixユーザー: temp ディレクトリに正しい許可が与えられているか確認して下さい。
(default: <testlink_root>/gui/template_c/). 

Revision History:
#
Description
Date
Author
1.0
Initial creation of the document in DocXML
2005/03/12
A. Morsing
1.1
Corrected title, updated structure and added new sections.
2005/04/12
M. Havlat 
1.2
Added some words for MySQL 4.1, UTF8 support
2005/06/27
A. Morsing
1.3
Updated automatic installation part
2005/09/12
F. Mancardi
1.4
Updated for TL 1.6.; added configuration parameters; restructured (created pre-installation steps section); corrected layout; added phpMyAdmin steps description
2005/09/13
M. Havlat
2.0
Converted to OO2 format; added DB Charset update explanation from Kevin
2005/12/04
M. Havlat
2.1
Corrected layout for export to HTML and PDF
2005/12/11
M. Havlat
2.2
Some small changes
2005/12/17
A. Morsing
2.3
Minor layout and grammar update
2006/02/14
M. Havlat
2.4
Updated for TL 1.7
06/11/17
M. Havl?t