Fisheye 4.8 + Crucible 4.8 のインストール (Linux)

はじめに

Fisheye は、Subversion、Git、Mercurial、CVS、Perforce に対応したソースコードリポジトリブラウザーです。機能の詳細については、こちらのページ もご確認ください。
Crucible は、Fisheye と組み合わせて使用するコードレビュー支援ツールです。Crucible の詳細については、こちらのページ も参照してください。

インストールする環境は以下を想定しています。

このページの手順を実施する前に、以下のページの手順を実施して下さい。

• PostgreSQL のインストールと DB (データベース) の作成 (CentOS 7.x)
• OpenJDK 8 のインストール

Fisheye のプログラムファイルをダウンロードする

Fisheye は、Atlassian のホームページからダウンロードできます。

ダウンロードするファイルを選択する画面が表示されます。
ここでは、2020/4/20 現在、最新のバージョンである Fisheye 4.8.1 の ZIP Archive を選択し Get started をクリックします。

同意を求めるダイアログが表示されるので、内容に問題がなければチェックボックスを有効にし Submit をクリックします。

ダウンロードしたファイルは、Fisheye をインストールするサーバーへ転送しておいてください。

インストール

Fisheye を Linux 環境にインストールします。

1. アプリケーションを実行するユーザーを作成する

以下のコマンドを実行し、Fisheye を実行するユーザーを作成します。

useradd --create-home --comment "Account for running Fisheye and Crucible" --shell /bin/bash fisheye

2. プログラムディレクトリを作成する

以下のコマンドを実行し、Fisheye のプログラムを配置するディレクトリを作成します。

mkdir -p /opt/atlassian/fisheye

3. Fisheye のプログラムファイルを展開する

以下のコマンドを実行し、サーバーへ転送しておいた ZIP ファイルを、新しく作成した /opt/atlassian/fisheye の配下に展開します。

unzip fisheye-4.8.1.zip -d /opt/atlassian/fisheye

4. シンボリックリンクを作成する

Fisheye のアップグレードなど、プログラムディレクトリの構成に変更があっても正しく動作させられるように、プログラムディレクトリに対してシンボリックリンクを作成しておきましょう。

以下のコマンドを実行し、展開されたプログラムディレクトリに対するシンボリックリンクを作成します。

ln -s /opt/atlassian/fisheye/fecru-4.8.1/ /opt/atlassian/fisheye/latest

5. データディレクトリを作成する

以下のコマンドを実行し、Fisheye のデータを保存するディレクトリを作成します。

mkdir -p /var/atlassian/application-data/fisheye

6. 設定ファイルをコピーする

Fisheye を正しく起動するために、以下のコマンドを実行し、config.xml ファイルをデータディレクトリにコピーします。

cp /opt/atlassian/fisheye/latest/config.xml /var/atlassian/application-data/fisheye/

7. ファイルの権限を与える

Fisheye を実行するユーザー (fisheye) に、プログラムディレクトリとデータディレクトリの権限を与えます。

1. 以下のコマンドを実行し、プログラムディレクトリとデータディレクトリの所有者を fisheye に変更します。

   chown -R fisheye:fisheye /opt/atlassian/fisheye/fecru-4.8.1/ /var/atlassian/application-data/fisheye/

2. 以下のコマンドを実行し、プログラムディレクトリとデータディレクトリの権限を指定します。

   chmod -R u=rwx,go-rwx /opt/atlassian/fisheye/fecru-4.8.1/ /var/atlassian/application-data/fisheye/

8. データディレクトリを指定する

Fisheye の設定ファイルを編集し、Fisheye で使用するために作成したデータディレクトリを指定します。

1. 以下のコマンドを実行し、fisheyectl.sh ファイルをテキストエディタで開きます。

   vi /opt/atlassian/fisheye/latest/bin/fisheyectl.sh

2. 以下の行を "#!/bin/sh" の下に追記します。

   FISHEYE_INST="/var/atlassian/application-data/fisheye"

3. 保存してテキストエディタを閉じます。

9. Fisheye を起動する

設定が完了したら、以下のコマンドを実行して Fisheye を起動します。

su - fisheye -c /opt/atlassian/fisheye/latest/bin/start.sh

Fisheye を停止するときは、以下のコマンドを実行します。

su - fisheye -c /opt/atlassian/fisheye/latest/bin/stop.sh

セットアップ

インストールした Fisheye を起動し、初めてブラウザーからアクセスすると、セットアップウィザードが始まります。

セットアップウィザードでは、ライセンス情報の入力や管理用のパスワードの設定などを行います。

1. セットアップウィザードを実行する

Fisheye を実行し、ブラウザーから "http://(IP アドレスまたはホスト名):8060" にアクセスすると、下図のようなセットアップウィザードの画面が表示されます。
Enter exsiting license ボタンをクリックすると Enter license key テキストボックスが表示されます。ここに弊社からメールでお送りした Fisheye のライセンスキーを入力してください。
入力できたら Next ボタンをクリックします。 

2. Crucible の設定を行う

ライセンスが確認されたら、ソースコードレビューツールである Crucible も一緒に使用するか確認する画面が表示されます。
同じく Enter exsiting license ボタンをクリックすると Enter license key テキストボックスが表示されますので、ここに弊社からメールでお送りした Crucible のライセンスキーを入力してください。
入力できたら Next ボタンをクリックします。 

3. Jira との接続設定を行う

Jira との接続設定を行う画面が表示されます。
ここでは Jira とは接続せずに進めますので、Skip ボタンをクリックします。

4. パスワードを設定する

Set administrator password の画面では、管理画面にアクセスするためのパスワードを設定します。
2つ のテキストボックスに同じパスワードを入力してください。簡単すぎるパスワードは、Fisheye に拒否されることがありますのでご注意ください。
パスワードを入力したら Next ボタンをクリックします。

5. Fisheye を開始する

一通りの設定が完了し、Fisheye を利用する準備ができました。
Add repository ボタンをクリックして Fisheye を開始します。

管理画面を開くための入力画面が表示されるので、セットアップウィザードで指定したパスワード入力し Log in ボタンをクリックします。

外部データベースの設定

Fisheye のセットアップが完了したら、外部データベースの設定を行いましょう。
Fisheye のデフォルトでは、データ保存用に内蔵データベースを使用します。このデータベースは本番稼動で使用するにはパフォーマンスに問題があるため、PostgreSQL などの外部データベースを使用するように設定します。
利用可能なデータベースは、Atlassian の サポートプラットフォームページ から確認できます。

ここでは、PostgreSQL を例にして手順を説明します。

1. データベースの編集画面を開く

Fisheye の管理画面左側のメニュー System Settings > Database から Database Configuration の画面を開き、下部にある Edit ボタンをクリックします。

2. データベースを指定する

データベース設定の編集画面が開きます。

Type に PostgreSQL を選択し、各項目を入力していきます。

入力する内容は以下を参考にしてください。
指定できたら Test connection ボタンを押します。

接続テストが成功すると Connection succeeded というメッセージが表示されます。 
失敗したときは、データベース作成時に指定した内容と画面の入力内容が異なっていないか確認してください。
成功したときは Save & Migrate ボタンが使用できるようになるので、ボタンをクリックします。

3. データベースの移行を実行する

データベースを移行するか確認するダイアログボックスが表示されます。
内容に問題がなければ、Confirm ボタンをクリックしてデータベースの移行を実行します。

Confirm ボタンをクリックすると、Fisheye の内蔵データベースから外部データベースに移行する作業が実行されます。
登録されているデータ量によっては時間がかかることがありますので、しばらくお待ちください。

4. データベースの移行を完了する

データベースの移行作業が完了すると、ダイアログボックス画面に Database migration successful. というメッセージが表示されます。
Ok ボタンをクリックし、データベースの移行作業を完了します。

Database Configuration の画面 が表示されるので、変更した内容が反映されていることを確認してください。

コンテキストパスの設定

つづいて、Fisheye にコンテキストパスを設定します。

コンテキストパスとは、URL でサーバー名に続く文字です。
セットアップウィザードを実行するときは http://(IP アドレス):8060 をブラウザーで開きましたが、コンテキストパスとして /fisheye を設定すると、http://(IP アドレス):8060/fisheye といった URL で Fisheye へアクセスできるようになります。

1. サーバー設定画面を開く

Fisheye の管理画面左側のメニュー Global Settings > Server のリンクをクリックします。

2. サーバー設定の編集画面を開く

Server Settings の画面が表示されるので、Edit settings のボタンをクリックします。

3. コンテキストパスを設定する

Edit Web Settings の画面内、Web context の項目に "/fisheye" を入力し、画面下部にある Update ボタンをクリックします。

Server Settings 画面の Web context の値が変更されていることを確認します。

4. Fisheye を再起動する

この設定を反映するには、Fisheye の再起動が必要となります。

Fisheye が稼働しているサーバーにて、以下の手順で Fisheye を再起動してください。

1. 以下のコマンドを実行し、Fisheye を停止します。

   su - fisheye -c /opt/atlassian/fisheye/latest/bin/stop.sh

2. 以下のコマンドを実行し、Fisheye を起動します。

   su - fisheye -c /opt/atlassian/fisheye/latest/bin/start.sh

5. Fisheye へアクセスする

Fisheye の再起動後、http://(IP アドレス):8060/fisheye といった URL で Fisheye へアクセスできるか確認してください。

自動起動の設定

サーバーの起動時に Fisheye が自動的に起動するように設定しましょう。

1. Unit ファイルを追加する

以下のコマンドを実行し、自動起動させるための Unit ファイルを追加します。

vi /etc/systemd/system/fisheye.service

2. 内容を記述する

/etc/systemd/system/fisheye.service ファイルの内容として以下のように記述し、保存します。

[Unit]
Description=Fisheye and Crucible Service
After=network.target iptables.service firewalld.service postgresql-9.6.service

[Service]
Type=forking
User=fisheye
Environment=JAVA_HOME=/usr/java/default
LimitNOFILE=65536
LimitNPROC=65536
ExecStart=/opt/atlassian/fisheye/latest/bin/start.sh
ExecStop=/opt/atlassian/fisheye/latest/bin/stop.sh

[Install]
WantedBy=multi-user.target

3. 自動起動の設定をする

以下のコマンドを実行し、サーバーの起動時に Fisheye が自動的に起動するように設定します。

systemctl enable fisheye

Fisheye の起動と停止を、以下のコマンドから行うことができるようになりました。

• Fisheye の起動

  systemctl start fisheye

• Fisheye の停止

  systemctl stop fisheye

リポジトリの登録

ここでは、Fisheye に既存のリポジトリを登録し、参照する手順を説明します。

1. 管理画面を開く

ブラウザーで Fisheye にアクセスし、画面の最下部にある Administration のリンクをクリックします。

管理画面を開くためのパスワード入力画面が表示されるので、Fisheye のセットアップ時に設定したパスワードを入力し、Log in ボタンをクリックします。

2. リポジトリを追加する

リポジトリの管理画面が表示されるので、Add repository ボタンをクリックします。

3. リポジトリの基本情報を設定する

追加したいリポジトリの情報を入力します。ここでは、例として Git のリポジトリを参照してみます。

Repository Type に Git を選択し、Display Name にリポジトリの名前、Description にリポジトリの説明を入力し、Next ボタンをクリックします。

4. 参照するリポジトリを設定する

次に、参照するリポジトリに接続するための情報を入力します。入力内容の詳細については、リポジトリ管理者にご確認ください。
Test Connection ボタンを押すと接続テストを実行できます。

接続テストが成功すると Connection succeeded. というメッセージが表示されます。

Close ボタンを押して参照するリポジトリの情報入力画面に戻ったら、Next ボタンをクリックします。

5. リポジトリの最終設定をする

追加するリポジトリに関する最終的な設定を行います。
ここでは、すぐにリポジトリを利用できるようにするため Enable Repository After Adding チェックをつけてください。
Add ボタンをクリックしてリポジトリを追加します。リポジトリのサイズによっては時間がかかることがあります。

リポジトリ管理画面のリストに追加したリポジトリが表示され、State が Running であることを確認します。

6. 追加されたリポジトリを確認する

リポジトリの内容を参照するときは、以下の手順からリポジトリ画面を開いてください。

1. 画面上部のメニューから Repsitories > All repositories をクリックします。
   
   
   
2. リポジトリの一覧画面から、参照したいリポジトリ名のリンクをクリックします。
   
   
   
3. リポジトリの内容が表示されることを確認します。
   

以上で Fisheye と Crucible のインストールは完了です。