TouchUpWeb プロジェクト — A Better Web for Everyone.

ホーム » サーバのセットアップ方法と使い方

TouchUpWeb サーバのセットアップ方法と使い方

注意：この内容は現在開発中のソフトウェアに基づいて作成されており、適宜、変更が加わる場合があります。

必要な動作環境

TouchUpWeb サーバを動作させるには以下のソフトウェアが必要になります。インストールの前に、これらのソフトウェアが用意されていることを確認し、もしシステムに存在しなかったりバージョンが古いものがインストールされている場合は、下記のバージョン以降のソフトウェア環境を用意してください。

JDK 1.5.0_06
Tomcat 5.5
MySQL 4.1
MySQL Connector/J (JDBC ドライバ)

環境設定

JDK 1.5 および Tomcat 5.5 をインストールし、それぞれが正しく動作するように適宜、環境変数 JAVA_HOME、CATALINA_HOME と PATH の設定を適切な場所に指定しておきます。また MySQL は文字コードとして UTF-8 を扱うように設定しておきます。

また MySQL にはあらかじめデータベースをひとつ作成しておきます (以下の説明では tuwdb とします。また tuwdb にはユーザ tuw_user がパスワード tuw_password で特権アクセス可能としておきます)。JDBC ドライバのインストールを忘れないようにしましょう。mysql.com から「MySQL Connector/J」の「Source and Binaries (tar.gz)」をダウンロードします。そのファイルを展開し、出てきた jar ファイルを $CATALINA_HOME/common/lib ディレクトリに配置しておきます。

サーバアプリケーションの配備

TouchUpWeb サーバのアプリケーションを Tomcat 環境に配備します。

ダウンロードした TouchUpWeb.war ファイルを、$CATALINA_HOME/webapps に置きます。

TouchUpWeb サーバを操作するユーザを指定するファイル touchupweb-users.xml を作成します。このファイルは $CATALINA_HOME/conf に配置します。ファイルの例を次に示します。

<?xml version='1.0' encoding='utf-8'?>
<tomcat-users>
  <role rolename="install"/>
  <role rolename="tobsrv"/>
  <role rolename="tadmin"/>
  <user username="yamada" password="xxxxx" roles="tadmin,tobsrv,install"/>
</tomcat-users>

次に、$CATALINA_HOME/conf/server.xml を修正します。まずアカウントとロールの設定として、server.xml の GlobalNamingResources 要素の中に以下を記述します。

<Resource
  auth="Container"
  description="User database for TouchUpWeb System"
  name="TouchUpWebAdminDB"
  type="org.apache.catalina.UserDatabase"
  pathname="conf/touchupweb-users.xml"
  factory="org.apache.catalina.users.MemoryUserDatabaseFactory"/>

また、コンテキストの設定として、$CATALINA_HOME/conf/server.xml の Host 要素の内側 (</Host> タグの直前の行) に以下をコピーします。

<Context
  path="/TouchUpWeb"
  reloadable="true">
<Realm className="org.apache.catalina.realm.UserDatabaseRealm"
  resourceName="TouchUpWebAdminDB"/>
<Resource
  name="jdbc/bugs"
  type="javax.sql.DataSource"
  password="tuw_password"
  driverClassName="com.mysql.jdbc.Driver"
  maxIdle="2"
  maxWait="5000"
  username="tuw_user"
  url="jdbc:mysql://localhost/tuwdb"
  maxActive="4"/>
</Context>

上記の Context 要素の子要素 Resource のうち、以下の属性を環境に合わせて書き換えます。

url	MySQL の tuwdb データベースへの接続文字列	(ここでは jdbc:mysql://localhost/tuwdb)
username	tuwdb データベースのユーザ	(ここでは tuw_user)
password	上記ユーザのパスワード	(ここでは tuw_password)

Tomcat を再起動して、以下の URL にアクセスしてみましょう。次の画面が表示されれば TouchUpWeb アプリケーションの配備と設定は完了です。

http://localhost:8080/TouchUpWeb/install/index.jsf

サーバのインストール

上記のシステムインストール用ログイン画面から、touchupweb-users.xml で「install」ロールを実行する権限を与えたユーザでログインします。ログインに成功すると、次の画面が表示されます。

このインストール画面で、マスターシステム型かスレーブシステム型を選択します。通常は、Mozilla Japan が運営するマスター DB から情報提供を受けることを前提として、スレーブシステム型を選択すればよいでしょう。独立してシステムを運用する場合には、マスターシステム型を選択します。

どちらかを選択し、[インストール処理を行う] ボタンをクリックします。設定に問題がなければ、次の画面に遷移してインストール処理が終了します。なおこの段階で、必要なテーブルがデータベースに新たに作成されています。

TouchUp 情報参照サーバの設定 (スレーブサーバの場合)

TouchUp 情報の管理、サーバのメンテナンス等は、次の URL (管理用 URL) からアクセスします。

http://localhost:8080/TouchUpWeb/system/index.jsf

ログインすると、次のような画面になります。

スレーブシステム型として運用するには、[受信設定] メニューから TouchUp 情報参照サーバの設定を行います。マスタサーバでメンテナンスされている TouchUp 情報を、特定のタイミングで取得しにいくことで、最新の情報を利用することができるようになります。

[受信設定] メニューをクリックすると、次の画面に遷移します。

このメニューから、上流サーバとして参照する TouchUpWeb サーバの URL や、受信タイミングを指定します。

TouchUp 情報の新規登録

マスタシステム型でインストールした TouchUpWeb サーバでは、TouchUp 情報を登録することができます。スレーブシステム型として運用されているサーバはマスタサーバからの情報を受信することでデータが蓄積されるため、新規に登録することはできません。

TouchUp 情報の登録は [TouchUp 情報新規登録] メニューから行います。管理用 URL からログインし、[TouchUp 情報新規登録] メニューをクリックすると、次の画面になります。

この画面から、新しい TouchUp 情報を登録します。登録する情報の内容は以下のとおりです。

フィールド	説明	備考
カテゴリ	問題の種別です。	複数登録可能
深刻度	問題の深刻度です。	無視できる、修正可能、修正不可能、のいずれかを選択
登録者	情報の登録者です。	メールアドレス等を利用
更新者	情報を更新した担当者です。	メールアドレス等を利用
ブラウザ情報	検証したブラウザを示します。	複数登録可能
スクリプトファイル	問題点を修正するためのスクリプトを登録します。	ローカルに存在するスクリプトファイルをアップロードして登録

[カテゴリ] や [ブラウザ情報] は、複数の項目を指定することができます。これらを登録するには、右下にある [選択] ボタンをクリックします。[選択] ボタンをクリックすると、次のような画面になります。

この画面から、必要なカテゴリを選択します。コントロールキーを押しながらクリックすることで、複数の項目を選択することができます。また新たな項目が必要になった場合には、下部にある [新規カテゴリの追加] から、新しい項目をその場で追加することが可能です (カテゴリ名に新しい項目を入力し、[追加] ボタンをクリックすると、上部のリストに新しい項目が追加されます)。

すべての項目を入力したら [登録] ボタンをクリックしてください。新しい情報が登録されます。

TouchUp 情報の検索と更新・削除

TouchUp 情報の検索は [TouchUp 情報検索] メニューから行います。管理用 URL からログインし、[TouchUp 情報検索] メニューをクリックすると、次の画面になります。

この画面で、検索条件を入力します。いくつかの項目については [選択] ボタンをクリックすることで検索条件の選択画面を利用することができます。検索結果は次のように表示されます。

検索結果から [更新] をクリックすることでその詳細を確認することができます。更新画面を利用して、登録内容を修正することが可能です。また [削除] をクリックすることで当該データを削除することも可能です。

サーバのアンインストール

TouchUpWeb サーバ・アプリケーションをバージョンアップする際は、いったんシステムを停止させ、アンインストールしてから新しいバージョンを再インストールしなければなりません (現バージョンでは、データ移行はまだサポートされていません)。

アンインストールの手順を簡単に説明します。

Tomcat を停止します。
$CATALINA_HOME/webapps に配備されている TouchUpWeb.war を削除します。
Tomcat を実行しているユーザのホームディレクトリにある .java ディレクトリを削除します。
以下の順番で、tuwdb データベースのテーブルを削除します。

drop table if exists TUW_CAT_SCR_MAP;
drop table if exists TUW_BRW_SCR_MAP;
drop table if exists TUW_PTN_SCR_MAP;
drop table if exists TUW_UPDATER_MAP;
drop table if exists TUW_DIST_HIST;
drop table if exists TUW_SEND_HIST;
drop table if exists TUW_RECV_HIST;
drop table if exists TUW_SCRIPT;
drop table if exists TUW_USER;
drop table if exists TUW_CATEGORY;
drop table if exists TUW_BROWSER;
drop table if exists TUW_PATTERN;
drop table if exists TUW_SITE;
drop table if exists TUW_FEEDBACK;