WebRefer Installation Guide

This manual is for system administrator to install WebRefer as a remote service in the form of ASP (Application Service Provider). Such installation enable your web site to host WebRefer service for your web pages.

Requirements

A web server (HTTP)
A mail server (SMTP)
PHP should be supported.
The mail() in PHP should be configured to use your SMTP server. By default, PHP will take care of this. But if you want to get more details, please check here: http://www.php.net/manual/en/ref.mail.php
To enable logging, you should allow PHP to write text log into disk.
Have gnu WGET ulility installed. http://www.gnu.org/software/wget/wget.html

Installation

Get the package: http://saintus.com/webrefer/download.php Select the server modules and download it.
Extract the web_refer.tgz to a web server document directory.
Suppose your HTML documents is installed under "/usr/local/apache/htdocs", and you extract WebRefer under "/usr/local/apache/htdocs/WebRefer/".
Edit "/usr/local/apache/htdocs/WebRefer/web_refer.conf". Replace the value of variable "$WGET_BIN" to the file path where "wget" located.
Review "/usr/local/apache/htdocs/WebRefer/conf/host.list" and "/usr/local/apache/htdocs/WebRefer/cont/client.list" to set appropriate access control.
Download the "embeded HTML" from http://saintus.com/webrefer/manual/sample.zip

Create WebRefer embeded text

Replace all occurrances of http://saintus.com/web_refer/web_refer.gif with your own image, i.e. http://host.yourdomain/WebRefer/web_refer.gif
Replace all occurrances of http://saintus.com/web_refer/mail_form with your own image, i.e. http://host.yourdomain/WebRefer/mail_form.php
Review the "embeded HTML" varialbes before releasing embed HTML code file to your web designer. For the meanings of variables, please read user's manual.

Access log

You can find detailed access log at "/usr/local/apache/htdocs/WebRefer/log". The log is grouped by month. Each line is an entry. Each entry is consisted of these attributes:

date/time
client network address
referred web page url
sender name
sender address
receiver address
preface
referred web page size (in byte)
mail subject

Language support

WebRefer is designed to support multi-languages. You can create your own language interface by adding a message table file.

For example, suppose you want to add an Arabic interface. Please check the content of "/usr/local/apache/htdocs/WebRefer/conf/msg_table.en". Create a new file named "/usr/local/apache/htdocs/WebRefer/conf/msg_table.arabic". Translate each line of original msg_table.en into msg_table.arabic.

Change the variable "language" in the embeded WebRefer script in web pages. Set its value to "arabic".