ページを選択

Docker へのインストール

docker-compose を利用して TestRail をインストールする方法については以下を参照してください。

注意事項

docker-compose は Linux 環境のみ本番運用をサポートいたします。

    • Windows 環境 (Docker for Windows) でも動作することを確認していますが、本番運用はサポートいたしません。評価目的のみでご利用ください。

要件

    • Docker 、 docker-compose を利用できる環境であること
    • Docker の基本知識があること
      • Docker公式ドキュメントはこちらにあります。

準備

testrail-docker-ja-master_<version>.zip を任意のディレクトリで展開します。
Linux 環境でご利用の場合、ホスト側のディレクトリのパーミッションを確認してください。(www-dataが望ましいです。)

設定

.env ファイルを利用環境に合わせて変更します。

    • WDPATH を docker-compose.yml の配置場所を絶対パスで指定するように変更してください。
    • HTTP のポートを変更したい場合は、.env ファイルで HTTP_PORT を 追記して指定します。
      • デフォルトは、8000 ポートを利用します。
HTTP_PORT=8000
DB_USER=testrail
DB_NAME=testrail
DB_PWD=testrailpass
DB_ROOT_PWD=techmatrix
RABBITMQ_USER=testrail
RABBITMQ_PWD=testrail
TESTRAIL_VERSION=9.4.1.1002
WDPATH=C:\\temp\\testrail\\testrail-docker-ja-master

compose ファイルに関する注意点

すべての compose ファイルは、次の追加ボリュームに依存します。

    • testrail_root：TestRail がインストールされる場所。/var/www/testrailにマウントされます。
    • testrail_opt ：アップロードされたファイルなどが格納される場所。/opt/testrailにマウントされます。
    • testrail_db ：データベースがある場所。/var/lib/mysql.にマウントされます。
    • testrail_config ：TestRail を設定する config.php ファイルがある場所。/var/www/testrail/configにマウントされます。

コンテナーは testrail ブリッジ ネットワークで接続されます。php、ウェブ サーバーとDBの順に起動されます。

コンテナ起動/停止

コンテナ起動

docker-compose で起動します。（パッケージのダウンロードやビルドが実行されるため初回起動は 10 分程度必要です。）

docker-compose up -d

起動完了後、http://localhost:8000/ へアクセスして TestRail のセットアップを行います。

    • Step 2/8 “Database Settings” では以下のデータベース情報を入力します。
      • Driver： MySQL(5.x and higher)
      • Server： db:3306
      • Database： testrail
      • User： testrail
      • Passworkd： testrailpass
      • 注意：.env ファイルにおいてデータベース名 (DB_NAME)、ユーザー (DB_USER) 、パスワード (DB_PWD) をデフォルトから変更した場合は、変更内容に合わせてください。
    • Step 3/8 “RabbitMQ Settings” では TestRail の Webhook 機能を利用する場合のみ、以下の設定情報を入力します。(インストール後に設定画面から設定を行うこともできます。)
      • Message Queue Server：rabbitmq
      • Message Queue Port：5672
      • Message Queue User：testrail
      • Message Queue Password：testrail
      • Use TLS：No (チェックボックスにチェックしない)
    • Step 4/8 “Application Settings” では以下の設定を変更します。そのほかの項目もご利用の環境に合わせて変更してください。
      • Default Language： 日本語
        • 日本語が反映されるのは、インストール完了後です。
      • Attachment Directory : /opt/testrail/attachments/
      • Report Directory : /opt/testrail/reports/
      • Log Directory * : /opt/testrail/logs/
      • Audit Directory * : /opt/testrail/audit/
      • Chrome Headless Shell Path *: /usr/bin/chrome-headless-shell-linux64/chrome-headless-shell
    • Step 6/8 の “License Key” では TestRail のライセンスキーを License Key に設定します。

コンテナ停止

コンテナを停止する場合は、docker-compose で停止します。

docker-compose stop

コンテナ再開

コンテナを再開する場合は、docker-compose で再開します。

docker-compose start

コンテナ削除

コンテナを最初から作り直す場合は、以下の手順で行います。

    • コンテナ、ボリューム、ネットワークを削除 
      docker-compose down -v
    • イメージを削除 (同じイメージでコンテナを再作成する場合は、削除しなくても構いません。) 
      docker rmi testrail-docker-ja-master_srv testrail-docker-ja-master_db rabbitmq
    • データ用フォルダを削除 ( _config / _mysql / _opt / _rabbitmq) ※TestRailに登録したデータが削除されます。 
      rm -r _cassandra _config _mysql _opt _rabbitmq
      • コンテナを再作成するときは同名で空のフォルダを再作成してください。

    (参考)docker-compose の使用

    docker-compose CLI リファレンスはこちらにあります。

    その他の便利なオプション

    オプション 説明
    -v (名前付きボリュームを削除)  このオプションは、シャットダウン後に一時ボリュームを削除するために重要であり、使用することが推奨されます。ボリュームをパージすべきでない場合は、このパラメータ―を使用しないでください。ただし、副作用がある可能性があるので注意が必要です。
    -f (ファイル) 別の compose ファイルを指定するのに使用します (デフォルトでは docker-compose.yml が使用されます)。
    -p (プロジェクト) 複数の TestRail インスタンスを起動する場合は必須です。指定されていない場合、docker-compose はすでに実行されているコンテナと通信します。

    docker-compose が起動されたフォルダー名 (この場合は「internal-docker」) がプロジェクト名として使用され、生成されるすべてのコンテナーの先頭に付加されます。

    推奨事項: 名前付きボリュームおよび匿名ボリュームを削除する docker-compose down -v を使用します。