This document encoding is the UTF-8, and the newline is LF.

これはWebEscorter 1.2.x系のドキュメントです

このドキュメント内で， > から始まるものは、ファイルの一部分かプロンプト
を示します。

　このスクリプトは、Apacheのプロキシ機能を利用してWeb閲覧(HTTP)のログを
解析するものです。
　Apacheのログファイルを利用するため、基本的にApacheと同じサーバにスクリ
プトを設置してください。また、利用準備としてroot権限での操作が必要です。
　動作時には特殊な権限を付与する必要はありません。Apacheはwww-dataや
nobodyといったユーザで稼働してもこのスクリプトは動作します。

　（特色）
 * Apacheのプロキシのログを使っているので、設備投資が殆ど要らない（既存
   のサーバにApacheを入れてプロキシの設定をすればよい）
 * CGIとして動いているので常駐型の監視ソフトなどよりはリソースも食わない
 * Version 0.1.xから変わったこと
       o CONNECTメソッドを使用したHTTPS通信も解析の対象に
 * Version 0.2.xから変わったこと
       o Ajaxによるグラフィカルでわかりやすいインターフェースに刷新
       o ログの順序を並び替え，新しい順からソートするように改善
 * Version 1.0.xから変わったこと
       o ユーザーインターフェイスを改良し，使いやすくなった
       o GoogleやYahooで検索した語句を表示できるようになり，さらにWebア
         クティビティを調べられるようになった
 * Version 1.1.xから変わったこと
       o WebEscorter Ajax Clientのユーザーインターフェイスを改良した
       o 日付とIPアドレスを同時に絞り込めるようになった
       o 検索ワードの表示がMSNにも対応
       o FTPによるプロキシ経由の通信にも対応
       o ログのIPアドレスからホスト名への逆引きができるようになった
       o URLを表示するとき，HTTPステータス番号も表示できるようになった
       o 処理の高速化
 * 高速なサーバ処理
       o サーバにmod_perlを導入するとさらに高速に（mod_perlの導入を推奨）
 * Ajaxクライアントによる使いやすいログ・ビューア
       o グラフィカルカレンダー，高速なサーバとの非同期通信

1.前準備
1.1. -- ログファイルのパーミッションを設定する --
	- 1.1.a --------------------------------------------------------
	このセクションでは、Apacheの既存のログのパーミッションを変更する
	方法を解説します。
	----------------------------------------------------------------
	
	/var/log/の"apache2"ディレクトリのパーミッションを755(rwxr-xr-x)
	に設定する
	
	/var/log/apache2の中のファイルのパーミッションをすべて
	644(rw-r--r--)に設定する
	
	- 1.1.b --------------------------------------------------------
	このセクションでは、loglotateでローテーション時に付与されるログ
	のパーミッションを変更する方法を解説します。
	----------------------------------------------------------------
	
	/etc/logrotate/apache2をroot権限で編集し、
	
	  >create 640 root adm
	
	を
	
	  >create 644 root adm
	
	
	に変更する。これにより、ログのローテーションが自動で行われても、
	グループ外であるWebEscorterのCGIからログが読み込めるようになる。

1.2. -- Apacheのプロキシ設定 --

	Apacheのプロキシを設定します。監視対象のクライアントのプロキシ設
	定は、このプロキシが稼働しているマシンに設定します。
	セキュリティのため、インターネットからの接続を拒否し、不用意に公
	開プロキシにしないようにしてください。

	  ><Proxy *>                    
	  >Order deny,allow             
	  >Deny from all                
	  >Allow from 192.168.0.0/24    #インターネットからの接続を拒否
	  ></Proxy>                     
	
	Allow from ... はプロキシアクセスを許可するサブネットに合わせた
	設定をしてください。

1.3. -- モジュールのインストール --

	Perlのモジュールをインストールします。
	
	  >sudo cpan
	
	CPANシェルが起動したら、
	
	  >install Parse::AccessLogEntry
	
	と入力しインストールする。

1.4. -- 設置 --

	/cgi-bin/以下などの、スクリプト実行権限のあるディレクトリに
	WebEscorterのすべてのファイルを展開し、パーミッションを755などの
	実行権限のあるものに設定してください。

	また、お使いのシステムのApacheのログファイルのディレクトリに合わ
	せ、viewer.cgi内の

	 >my $file = '...';

	の変数の''内を適宜変更してください。
	DebianやUbuntuでデフォルトのディレクトリは
	/var/log/apache2/access.log です。
	
	その下の行の
	
	>my $entry_limit = '...';
	
	はログの出力の最大値で、検索結果がこれ以上になると出力を停止しま
	す。クライアントがAjaxクライアントの場合で、ブラウザのメモリの消
	費を抑えるための設定です。
	1000～5000程度が適当な値でしょう。

2.使用
2.2. -- 使用する --

	設置が完了したら、そのディレクトリにアクセスできるか確認してくだ
	さい。
	  > IPアドレスで絞り込む
	というタブをクリックし、フィルタしたいホストのIPアドレスを入力し
	ます。
	  > 日付で絞り込む
	タブをクリックすると日付で絞り込むことができます。
	ただし、IPアドレス/日付両方を一緒に指定して絞り込むAND検索はでき
	ません。

	  > 検索ワードを表示
	タブをクリックするとプロキシを通ったGoogle、Yahoo!検索のクエリが
	解析され、何を検索したのか表示されます。

	検索をクリックするかEnterを打つと、検索が開始され、下部に結果が
	表示されます。

	JavaScriptで処理しているため、ログの行数が多い場合は時間がかかり
	ます。処理能力が低いマシンで閲覧する際は、Ajax不使用版のページを
	使用してください。


---- COPYRIGHT ----
    Copyright (C) 2008 Keiya CHINEN. All rights reserved.
    
    グラフィカルなカレンダー機能の実装にはYahoo! Inc.のYUIを使用しています。
    Copyright (C) 2008, Yahoo! Inc. All rights reserved.
