Research Artisan Lite - インストールマニュアル
この文書は、Research Artisan Lite バージョン1.xx系を基にして書かれています。
【最終更新日:2009/12/2】
はじめに
アクセス解析ツール「Research Artisan Lite」をダウンロード頂き、ありがとうございます。
Research Artisan Lite のインストールはとても簡単、手作業はファイルを設置してアクセス権(パーミッション)を変更するだけ、後はインストール画面より行えます。インストール後は、発行された解析用タグを解析したいサイトの各ページに埋め込むだけでアクセスログが記録されますので、ログインすればサイトのアクセス状況がリアルタイムにわかります。また上級者向けとして、解析用タグ以外にPHP埋め込み用コードを用意していますので、これを解析したいサイトに設定すればクローラー等の解析用タグでは記録できないアクセスログも記録されて、より正確なアクセス状況を確認できます。
まずは、以下の内容を参考にインストールしてみてください。このResearch Artisan Lite があなたのサイトのアクセスアップの手助けになれれば幸いです。
目次
1. 動作環境
Research Artisan Lite を動作させるには、以下の環境が必要です。
サーバー環境
- ■OS
- Linux、Windows、MacOS等で、以下の環境が構築できるOS
- ■Webサーバー
- Apacheを推奨(Apacheのみ動作確認済み)
- 各設定(httpd.conf等のコンフィグファイル、レンタルサーバーの場合はサーバー仕様をご確認下さい)
- .htaccessファイルが有効であること
※無効であってもご利用は可能ですが、セキュリティを考慮すると有効であることを推奨します。
- .htaccessファイルが有効であること
- ■PHP
- 5.1.x 以降(PHP4では動作しません)
※以下の拡張モジュールが無い場合、インストール時にエラーが表示されます。
- mbstring 拡張モジュールが必要
- mysql 拡張モジュールが必要
- 各設定(php.iniファイルや.htaccessファイル、もしくはphpinfo関数にてご確認下さい。)
- 「memory_limit」が大きく設定されていること(16M以上を強く推奨します)
※推奨値以下であれば解析機能に一部制限があります。
**メモリエラーについて - 「max_execution_time」が大きく設定されていること(30秒以上を強く推奨します)
※推奨値以下であればタイムアウトエラーが発生する可能性があります。
**タイムアウトエラーについて
- 「memory_limit」が大きく設定されていること(16M以上を強く推奨します)
- ■データベースサーバー
- MySQL4.0 以降(4.1 以降を強く推奨します)
※4.0 では解析結果に文字化けが発生する可能性があります。
クライアント環境
- ■OS
- Windows、MacOS、Linux等で、各ブラウザがインストールされているOS
- ■各ブラウザ
- InternetExploer、Firefox、Safari、Opera、Google Chrome等の各主要ブラウザ(Javascript、Cookieが有効であること)
- ■FTPソフト等
- ファイルをWebサーバーにアップロードできるソフトであること。また、アクセス権(パーミッション)を変更できる機能があること。
2. ファイルの設置
ダウンロードした圧縮ファイルを解凍して展開された各ファイルについて、以下の手順でWebサーバー上に設置してください。Webサーバーにアップロードするには、FTPソフト等をご利用ください。
2.1 ファイルの設置(基本)
- ■「public_html(ドキュメントルート)」ディレクトリ
- public_htmlディレクトリは、ドキュメントルート(ブラウザから閲覧することのできる最上位のディレクトリ)を表しています。この「public_html(ドキュメントルート)」ディレクトリの中身全てを、そのままWebサーバーに設置してください。
※ご利用のWebサーバーのドキュメントルートのディレクトリ名がpublic_htmlという名前でなければ、Research Artisan Lite のファイル内のpublic_htmlディレクトリを、適切なディレクトリ名に変更してから設置してください。
- ■「ra_core」ディレクトリ
- 「ra_core」ディレクトリの中身全てを、そのままWebサーバーに設置してください。
【基本設置例】
/ (root) ├ ... ├ public_html(ドキュメントルート) └ ra ├ ... └ ... ├ ra_core ├ ... └ ... └ ...
ダウンロードした「public_html(ドキュメントルート)」ディレクトリ、「ra_core」ディレクトリをそのままWebサーバーにアップロードすると、上記例のようになります。
【推奨しない設置例】
/ (root) ├ ... ├ public_html(ドキュメントルート) ├ ra ├ ... └ ... └ ra_core(ドキュメントルートの下の階層にある) ├ ... └ ... └ ...
上記例のように、「ra_core」ディレクトリをドキュメントルートの下の階層に設置することは、できるだけ避けてください。設置しても動作はしますが、その場合は「ra_core」ディレクトリの直下にある.htaccessファイルが有効になる環境でご利用ください。有効にならない環境においては、セキュリティ上、この設置方法を推奨しておりません。
※有効になる環境であれば、「ra_core」ディレクトリより下の階層の各ディレクトリやファイルについて、ブラウザからのアクセスは全て「403 Forbidden」エラーとなりアクセスできないようになります。この場合は設置しても問題ありません。
2.2 ファイルの設置(応用)
※このファイルの設置(応用)については、主にファイルの設置(基本)のディレクトリ構成やアクセス解析画面へのURLを変更したい場合にご覧ください。ファイルの設置(基本)の内容で利用する場合は読み飛ばしてください。
「public_html(ドキュメントルート)」ディレクトリの下の階層にある、「ra」ディレクトリについては、ドキュメントルートの下の階層であればどこにでも設置できます。通常(ファイルの設置(基本)にてインストール)、 Research Artisan Lite へアクセスするには「http://Webサーバー/ra/analyze/index.php」の形で呼び出しますが、これを例えば「http://Webサーバー/kaiseki/ra/analyze/index.php」の形で呼び出したい場合は、次の用にファイルを設置します。
【設置例:ディレクトリ位置の変更】
/ (root) ├ ... ├ public_html(ドキュメントルート) └ kaiseki └ ra(kaisekiディレクトリの下の階層に設置) ├ ... └ ... ├ ra_core ├ ... └ ... └ ...
また、「ra」ディレクトリ自体の名前も変更できます。例えば「http://Webサーバー/access/analyze/index.php」の形で呼び出したい場合は、次の用にファイルを設置します。
【設置例:「ra」ディレクトリの名前変更】
/ (root) ├ ... ├ public_html(ドキュメントルート) └ access(raをaccessにディレクトリ名を変更) ├ ... └ ... ├ ra_core ├ ... └ ... └ ...
更に、「analyze」ディレクトリ自体の名前も変更できます。例えば「http://Webサーバー/access/admin/index.php」の形で呼び出したい場合は、次の用にファイルを設置します。
【設置例:「analyze」ディレクトリの名前変更】
/ (root) ├ ... ├ public_html(ドキュメントルート) └ access(raをaccessにディレクトリ名を変更) ├ admin(analyzeをadminにディレクトリ名を変更) └ ... ├ ra_core ├ ... └ ... └ ...
※これらの変更は複数組み合わせても可能です。
「ra_core」ディレクトリについては、「public_html(ドキュメントルート)」ディレクトリと同階層、もしくは同階層より上の階層であればどこにでも設置できます。
【設置例】
/ virtual ├ sample └ public_html(ドキュメントルート) └ admin └ ra ├ ... └ ... └ ra_core(public_html(ドキュメントルート)の1つ上の階層にある sampleディレクトリと同じ階層に設置) ├ ... └ ...
※「ra_core」ディレクトリの名前は変更できません。
以上のように、ご利用のWebサーバー環境に応じてファイルを設置してください。わからない場合は、ファイルの設置(基本)の内容で設置してください。
2.3 アクセス権(パーミッション)の変更
※アクセス権を変更するには、FTPソフト等をご利用ください。
※Windows系のOSについては、基本的にアクセス権の変更の必要はありません。必要な場合は下記ディレクトリについて、適切なアクセス権を設定してください。
2.3.1 定義ファイル
Research Artisan Lite は、インストール時にシステムに必要な定義ファイルを自動で作成します。この為、以下のディレクトリのアクセス権(パーミッション)を書き込み可能("777")に変更する必要があります。
※インストール完了後はアクセス権を元に戻してください。
【「public_html(ドキュメントルート)」ディレクトリの下の階層にある「setting」ディレクトリ】
- public_html(ドキュメントルート) └ ra ├ ... └ setting("777"に変更)
2.3.2 アプリケーションログファイル
Research Artisan Lite は、システム実行時に発生した致命的なエラーや各処理の実行状況(正常に終了しているか?等)といった情報を、アプリケーションログファイルを記録します。この為、以下のディレクトリのアクセス権(パーミッション)を書き込み可能("777")に変更する必要があります。
※インストール完了後もアクセス権はそのままにしておいてください。
【「ra_core」ディレクトリの下の階層にある「logs」ディレクトリ】
- ra_core ├ application ├ ... ├ tmp └ logs("777"に変更) └ ... └ ...
3. データベース作成
Research Artisan Lite 用に新たにデータベースを作成する場合は、以下のコマンドを参考にデータベースを作成してください。
※レンタルサーバーで既にデータベースが作成されている場合や、既存のデータベース上にResearch Artisan Lite のデータを置きたい場合は、作成の必要はありません。
【MySQL4.1 以降の場合】
CREATE DATABASE 新しいデータベース名 CHARACTER SET utf8;
【MySQL4.0 の場合】
CREATE DATABASE 新しいデータベース名;
4. インストール
これまでの設定が完了すれば、後はインストール画面からの作業となります。「http://Webサーバー/ra/analyze/index.php」**1にアクセスしてインストールを開始してください。
- ■インストール画面で行う作業は以下の通りです。
-
- データベースへの接続設定の登録
- 解析するサイト名とURL、ログイン用のパスワードの登録
- 発行された解析用タグの確認
- 発行されたPHP埋め込み用のコードの確認(上級者用)
インストール後は、まず解析用タグを解析したいサイトの全てのページに貼りつける必要があります。解析用タグを貼りつけた時点でアクセスログの記録が開始されますので、後は再度「http://Webサーバー/ra/analyze/index.php」**1にアクセスしてログインしてください。
また、Research Artisan Lite では解析用タグ以外に、ご利用のサイトのPHPソース内に発行されたPHP埋め込み用コードを埋め込むことで、アクセスログを記録することができます。
※PHP埋め込み用コードについては、ご利用のサイトがPHPで作られたCMS等の場合に限ります。この設定は上級者用ですので、わかならい場合は解析用タグを貼りつけてください。
インストール後は、必ず書き込み可能に設定した「setting」ディレクトリのアクセス権を元に戻してください。
※書き込み可能のままであれば、ログイン後にシステムメッセージが表示されます。
5. アップグレード
アップグレードする場合は、アップグレード用のファイルをダウンロードしてください。ダウンロードしたアップグレード用ファイルを解凍すると、更新した差分ファイル(「ra_coreディレクトリ」、「public_htmlディレクトリ」)とアップグレード用スクリプトファイル(「ra_upgrade」ディレクトリ)が展開されます。
まずは更新した差分ファイルをファイルの設置にて設置した「public_html(ドキュメントルート)」ディレクトリ、「ra_core」ディレクトリに、それぞれ上書きで設置してください。
次にアップグレード用スクリプトファイルを設置します。解凍したファイル内の「ra_upgrade」ディレクトリを「ra_core」ディレクトリと同じ階層に設置してください。**2
「ra_upgrade」ディレクトリの中にはバージョン毎のディレクトリが存在します。
【「ra_upgrade」ディレクトリ設置例】
/ (root) ├ ... ├ ra_core ├ ... └ ... ├ ra_upgrade └ 1.01(バージョン毎のディレクトリ) └ ...
設置後に、「http://Webサーバー/ra/analyze/index.php」**1にアクセスするとアップグレード処理が開始されます。アップグレード処理終了後は、設置した「ra_upgrade」ディレクトリを削除してください。
※Research Artisan Lite を複数のサイトで運用している場合は、サイト毎にアップグレード処理を行なう必要があります。サイト毎のURLにアクセスして全てのサイトについてアップグレード処理が完了した後に、「ra_upgrade」ディレクトリを削除してください。
バージョンアップは、基本的に1回のバージョンアップがリリースされる毎に行う必要がありますが、複数のバージョンアップを一度に行いたい場合は、複数の差分ファイル、もしくは最新バージョンの全てのファイルを上書きアップロードした後に、以下のように複数のバージョンアップ用ファイルを「ra_upgrade」ディレクトリにアップロードしてから、「http://Webサーバー/ra/analyze/index.php」**1にアクセスしてください。
【バージョン1.0から1.03にバージョンアップしたい場合】
/ (root) ├ ... ├ ra_core ├ ... └ ... ├ ra_upgrade(複数のバージョンアップ用ファイルを設置) ├ 1.01 ├ 1.02 └ 1.03 └ ...
※できる限り、バージョンアップはリリース毎に行なってください。大幅なバージョンアップの場合は、上記の限りではありません。その際のアップグレード方法の詳細は、サポートフォーラムにて告知いたします。
6. アンインストール
アンインストールする場合は、Research Artisan Lite にログイン後、「アンインストール」のメニューを選択する事でシステムの初期化(全データの削除と設定の初期化)が行われます。完全にアンインストールするには、画面からのアンインストール後に、ファイルの設置にて設置したWebサーバー上の全ファイルを手動で削除してください。
※アンインストールの際は、「setting」ディレクトリのアクセス権を書き込み可能に再設定してください。
7. その他
7.1 ログイン用パスワードを忘れた場合
ログイン用パスワードを忘れた場合は、「public_html(ドキュメントルート)」ディレクトリの下の階層にある「setting」ディレクトリ内の、「install_complete」ファイルを削除してください。削除後に、「http://Webサーバー/ra/analyze/index.php」**1にアクセスすると、インストールの初期画面が表示されますので、インストール時と同様に各項目に入力してください。パスワードもここで再設定ができます。
※この場合は再度インストールするのではなく、設定をし直すだけになり、アクセスログ等のデータは削除されませんのでご安心ください。
- public_html(ドキュメントルート) └ ra ├ ... └ setting ├ ... └install_complete(削除してください)
7.2 データベース設定を変更したい場合
データベース設定を変更したい場合は、ログイン用パスワードを忘れた場合と同様に「setting」ディレクトリ内の、「install_complete」ファイルを削除してから「http://Webサーバー/ra/analyze/index.php」**1にアクセスして設定を変更してください。
※データベース設定を変更する際、テーブルプレフィックスは変更しないでください。変更すると、新しくテーブルが作成される為、これまでのアクセスログを閲覧することはできません。また、アンインストール時のデータ削除も変更前のテーブルが削除できない為に不完全になります。
7.3 Research Artisan Lite を解析対象のサイトとは別のサーバーで運用したい
Research Artisan Lite は、基本的に解析したいサイトと同じサーバー上にインストールしますが、別途Research Artisan Lite 用のサーバーを用意し、そこにインストールして運用することも可能です。この場合も、本マニュアルに記載されている手順通りにインストールしてください。
※但し、上級者用のPHP埋め込み用のコードを利用する場合は、解析したいサイトと同じサーバー上での運用しかできません。
7.4 Research Artisan Lite を複数のサイトで使いたい
Research Artisan Lite は基本的には1インストールで1つのサイトを解析しますが、複数のサイトを解析することもできます。その場合は、「public_html(ドキュメントルート)」ディレクトリの中身全てを名前を変えてコピーし、複数のサイト毎にデータベースを作成するだけ、後は同様にインストール画面からインストールできます。インストール後は、「http://Webサーバー/コピーしたディレクトリ名/analyze/index.php」にアクセスすれば複数サイト毎の解析を行えます。
【複数サイト設置例】
/ (root) ├ ... ├ public_html(ドキュメントルート) └ ra ├ ... └ ... └ second(「ra」ディレクトリをコピーして、secondディレクトリに名前変更) ├ ... └ ... ├ ra_core ├ ... └ ... └ ...
上記設定例では、「http://Webサーバー/ra/analyze/index.php」で1つのサイト、「http://Webサーバー/second/analyze/index.php」でもう1つのサイトのそれぞれの解析結果を閲覧することができます。
※コピーする際、「public_html(ドキュメントルート)」ディレクトリの中身はインストール前の初期状態(「install_complete」ファイル等が無い状態)である必要があります。また、コアファイル(「ra_core」ディレクトリの中身全て)はコピーする必要がありません。コアファイル1つで複数サイトの運用ができます。尚、1つのデータベースで複数サイトの運用はできませんので、必ずサイト毎にデータベースを作成してください。(これにより、訪問者名・ドメイン名等のデータの共有はできません。)
7.5 サーバー容量について
Research Artisan Lite は、月毎のアクセスログを自動で作成(ログイン時に自動で作成されます)しますが、ご利用のサーバーのディスク容量が不足してきた場合にはアクセスログが記録できなくなりシステムも不安定になります。これを防ぐためにも、「ログ容量確認」画面にて定期的に各ログの容量確認と場合によってはログの削除を行なってください。
7.6 メモリエラーについて
解析画面で以下ようなのエラーが発生する場合があります。**3
【エラー例】
Fatal error: Allowed memory size of 8388608 bytes exhausted (tried to allocate 77824 bytes)...
これはResearch Artisan Lite 実行時にPHPが使用できるメモリの最大量を超えた場合に表示されます。これについては、PHPの設定ファイル(php.ini、もしくは.htaccess)内の「memory_limit」の値を大きく設定してください。尚、アクセス数が多いサイトほどエラーがでる可能性がありますので、アクセス数に比例して大きく設定する必要があります。
※メモリの最大量が充分でないと、上記エラー以外にログイン状態が保持できない等の不具合が発生する可能性があります。
7.7 タイムアウトエラーについて
解析画面で以下ようなのエラーが発生する場合があります。**3
【エラー例】
Fatal error: Maximum execution time of 10 seconds exceeded in...
これはResearch Artisan Lite 実行時にPHPが使用できる実行時間の最大秒を超えた場合に表示されます。これについては、PHPの設定ファイル(php.ini、もしくは.htaccess)内の「max_execution_time」の値を大きく設定してください。尚、アクセス数が多いサイトほどエラーがでる可能性がありますので、アクセス数に比例して大きく設定する必要があります。
※アクセス数が多いサイトであれば、120秒程度の値を設定してください。
7.8 文字コードについて
Research Artisan Lite で扱うデータの文字コードは"UTF-8"となっています。よって、MySQL4.0 でインストールする場合は文字化けが発生する可能性があります。また、PHP埋め込みコードを使用する場合において、解析対象のサイトの文字コードがUTF-8以外の場合は、適宜文字コード変換が必要な場合があります。
7.9 インストールに関するお知らせ等
その他インストールに際し重要な変更等が発生した場合は、サポートフォーラムにて告知いたします。
1** ファイルの設置(応用)で設置された場合は適切なURLを指定してください。
2** ファイルの設置(応用)で「ra_core」ディレクトリの階層を変更している場合も、その変更した階層と同じ階層に「ra_upgrade」ディレクトリを設置してください。
3** PHPの設定「display_errors」が"On"になっている必要があります。(php.iniファイルや.htaccessファイル、もしくはphpinfo関数にてご確認下さい。)"Off"の場合は、エラーが表示されません。(真っ白な画面になります。)
Copyright ©2009 Research Artisan Project All Rights Reserved.