|
|
Installing
the WebZ Extension (Version 4.0.x)
Table of
Contents
Introduction
Requirements
Document Conventions
Installation Methods
Java Installation Procedure (for UNIX and NT)
Perl Installation Procedure (UNIX only)
Introduction
This document
explains how to install version 4.0.x of the WebZ extension. To install
version 4.1.0 of the WebZ extension, see Installing
the Web Extension (Version 4.1.0).
The WebZ extension
allows a Web server to route requests from a patron to the appropriate
JaSSI server in the WebZ system. After installing the WebZ extension,
you must specifically configure your Web server to use the WebZ extension.
The WebZ software includes WebZ extensions for several popular Web servers,
as listed below.
For UNIX-Based
Servers
For NT Servers
- Netscape
- Microsoft Internet
Information Server (IIS)
See OCLC
SiteSearch Suite System Requirements. for the version(s) of each Web
server that WebZ supports.
Apache
A freeware version
of the Apache Web
server, including a customized, built-in WebZ extension, is shipped
with the WebZ extension installer for UNIX (currently, Apache is available
only for UNIX). To use this preconfigured server, select Apache when prompted
for the Web server during installation.
| Note: |
You must
install the entire Apache Web server even if you intend to use an
existing Apache server to run the Open SiteSearch Suite. The Web
server installation package contains the WebZ extension module that
you need to configure your existing
Apache server to access WebZ.
|
Netscape and
IIS
A WebZ extension
is also available for Netscape
Enterprise and FastTrack servers and Microsoft's
Internet Information Server (IIS). To install the WebZ extension for either
of these servers, select the desired option when prompted for the Web
server during installation. After installing the WebZ extension, you must
add the extension to the Web server's configuration to access WebZ. See
Configuring Netscape to Use the WebZ Extension
or Configuring Microsoft Internet Information
Server (IIS) to Use the WebZ Extension, as appropriate. (If you are
using Microsoft IIS version 4.0 or higher, you do not have to configure
the Web server to use the WebZ extension.)
Important:
Do not set a document root in Netscape or IIS until after you install
both the WebZ Extension and WebZ. These servers use the same directory
for HTML documents. If you set the document root before installing both
these products, you create a root directory for HTML documents (htdocs)
that the installer cannot override.
Requirements
Before completing
this installation, review the Open SiteSearch
Suite System Requirements and Installing
and Configuring the Open SiteSearch Suite documents to ensure that
you meet the system requirements and have all of the information that
you need to install the WebZ extension successfully.
Document
Conventions
- <WebServer_root>
refers to the location of your Web server.
- <WebZ_root>
refers to the location of your WebZ environment.
- <version>
refers to the version of WebZ you are installing.
- Items or commands
you must type appear in single quotes, like this: "apache". Type them
without the quotes.
For example:
- UNIX: the server
root directory (<WebServer_root>) might be /web/netscape.
- NT: the server
root directory (<WebServer_root>) might be J:\web\netscape.
- UNIX: the WebZ
root directory (<WebZ_root>) might be /web/netscape/ss_prod.
- NT: the WebZ
root directory (<WebZ_root>) might be J:\web\netscape\ss_prod.
- Your WebSvrInstaller_<version>.class
file might be WebSvrInstaller_4_0_2.class.
Installation
Methods
OCLC recommends
that you install the WebZ extension before installing any other Open SiteSearch
suite components. You may use one of two methods for installation, the
Java Installation Procedure (for NT and UNIX)
(a graphical user interface), or the Perl Installation
Procedure (for UNIX only) (a command line interface).
Java
Installation Procedure (for UNIX and NT)
Before you install
the WebZ extension, you must set the
system environment variables to execute the Java installer. Then read
the instructions below, and make sure that you have the following installation
files:
- WebSvrInstaller_<version>.class
(UNIX and NT)
- WebSvrInstaller_<version>.bat
(NT only)
Time Required
for Installation
Plan on about
15 minutes to install the WebZ extension using the Java installer. The
specific time required depends on the speed of your processor and the
system load at the time you perform the installation.
A Note to UNIX
Administrators
The following
instructions assume that you have configured your UNIX DISPLAY variable
for your desktop display and started an X server session and terminal
emulator window with a connection to the system hosting the WebZ extension
installation.
Directions
Follow the instructions
below to install the WebZ extension.
|
1. Create
a new directory for the Open SiteSearch Suite software or move to
the directory containing your existing Web server. This procedure
refers to this directory as your <WebZ_root> directory.
| Note: |
If
you are installing on UNIX and plan to use the preconfigured
Apache server that comes with SiteSearch, OCLC recommends
that you install the Apache server and Open SiteSearch Suite
software in the same directory if you are only using the server
to run SiteSearch.
|
|
|
2. Copy
the installation file(s) into the <WebServer_root>
directory.
- UNIX:
Copy the WebSvrInstaller <version>.class file into
the <WebServer_root> directory.
- NT: Copy
the WebSvrInstaller _<version>.class file and the
WebSvrInstaller_<version>.bat file into the <WebServer_root>
directory.
|
|
3. Start
the installation process.
- UNIX:
From the <WebServer_root> directory, type "java
WebSvrInstaller_<version>" at the command prompt
and then press Enter.
- NT: Double-click
the WebSvrInstaller_<version>.bat file. The Welcome
screen appears.
|
|
4. The installation
program extracts the compressed Java class file and begins the installation.
The Welcome screen appears.
|
|
5. Click
Next at the bottom of the Welcome screen to move to the System
Information screen.
|
|
6. Select
the appropriate operating system from the Choose an Operating System
drop-down list, and the appropriate Web server from the Choose a
Webserver drop-down list. Click Next to move to the Web Server
Installation Directory screen.
|
|
7. Enter
the location of the WebZ extension. Make sure that you include the
full path name for the directory's location.
|
|
8. Click
Next to move to the System Configuration Information screen.
|
|
9.
Enter the following information on the System Configuration Information
screen:
- Web
Server Document Root Directory - the full path name of the
directory that will contain the WebZ HTML files. If, during your
planning stage, you decided to use an existing directory, note
that the installation overwrites HTML files with the same name.
Example: <WebZ_root>/htdocs
| Note: |
If you select the Apache Web server, the installer places
the HTML and image files associated with the Apache server
in this directory. For the Apache server, the document root
directory should be <WebServer_root>/htdocs.
|
- Web
Server CGI-BIN Directory - the full path name of the directory
that contains any Common Gateway Interface (CGI) scripts used
for the Web server and WebZ operations. If you are using an existing
Apache server, this directory MUST be the same CGI-BIN directory
that you defined in the Apache installation.
Example: <WebZ_root>/cgibin
- WebZ
Installation Root Directory - the full path name of the WebZ
environment.
Example: <WebServer_root>.
- Web
Server Host Name - the name of the host system for the Web
server.
Example: admin.anywhereU.edu
- Host
Name IP Address - the Internet Protocol (IP) address of the
host system.
Example: 123.456.78.90
- Web
Server Port - the port number where you intend to run your
Web server on the host system.
Example: 80
- Process
Username - the user name of the Open SiteSearch suite system
administrator.
Example: jsmith
- Process
Groupname - the UNIX or NT group that has the access rights
to the files and directories in the <WebServer_root>
directory.
Example: siteadmingroup
- Server
Admin Email - the electronic mail (e-mail) address of the
Open SiteSearch suite system administrator.
Example: jsmith@anywhereU.edu
- Netscape
Root Directory - the directory on the host system where the
Netscape server is installed. This field only appears if you select
Netscape as your Web server.
|
|
10. Click
Next to continue installing the WebZ extension.
|
|
11. While
the installation proceeds, you can follow its progress by reading
the messages displayed. You will see the following messages, in
this order:
Extracting
files...
Configuring
initialization files. This may take several minutes, please wait...
Creating
web server directory structure, please wait...
Cleaning
up temporary files, please wait...
This part
of the installation usually takes about 5-10 minutes.
|
|
12. When
the installer completes its tasks, you see a screen that lists the
files and directories extracted during the installation.
| Note: |
The
number of extracted files and directories varies, and depends
on your operating system and the WebZ extension you install.
|
|
|
13. Click
Finish to end the installation.
|
|
14. Complete
all the necessary configuration instructions for your Web server.
The following documents provide configuration information for each
type of supported Web server:
| Note: |
You must complete all of the required configuration procedures
before using SiteSearch. However, if you are using Netscape
or IIS, do not set a document root for until after you install
both the WebZ Extension and WebZ. These servers use
the same directory for HTML documents. If you set the document
root before installing both these products, you create a root
directory for HTML documents (htdocs) that the installer cannot
override.
|
|
|
15. Proceed
to the WebZ installation procedure.
|
Perl
Installation Procedure (UNIX only)
Before you install
the WebZ extension, make sure that you have the following installation
files:
- ss<version>.webserver.tar.Z
- WebSvrInstaller_<version>.sh
Time Required
for Installation
Plan on about
10 minutes to install the WebZ extension using Perl scripts. The specific
time required depends on the speed of your processor and the system load
at the time you perform the installation.
Directions
Follow the instructions
below to install the WebZ extension using Perl scripts.
|
1. Create
a new directory for the Open SiteSearch suite. Copy the ss<version>.webserver.tar.Z
and WebSvrInstaller_<version>.sh files into this
directory.
| Note: |
If
you are installing on UNIX and plan to use the preconfigured
Apache server that comes with SiteSearch, OCLC recommends
that you install the Apache server and Open SiteSearch Suite
software in the same directory if you are only using the server
to run SiteSearch.
|
|
|
2. Type
"WebSvrInstaller_<version>.sh" at the command prompt
in the <WebServer_root> directory and press Enter
to start the installation scripts.
|
|
3. You see
the following prompt:
Do you want to continue? [y]
Press Enter
or type "y".
|
|
4.
You receive a series of prompts asking you for information needed
to complete the installation. Accept the default value that appears
by pressing Enter at the prompt (a bracketed value appears after
most prompts; this is the default). If there is no default or the
default value is incorrect, type the necessary information and press
Enter. Definitions of each prompt, in the order in which they appear,
follow.
- Directory
of Perl Interpreter - the full path name of the Perl interpreter.
- Operating
System - the operating system of your host environment. Enter
the value for your operating system from those shown: "aix" (AiX),
"osf1" (DIGITAL UNIX), "hpux" (HP-UX), "irix" (IRIX), or "sol"
(Solaris).
- Web
Server Installation Directory - the full path name of the
<WebServer_root> directory.
- Web
Server - the Web server you use to access WebZ. Type "apache"
or "netscape" and press Enter.
- Web
Server Document Root Directory - the full path name of the
directory that contains the Web server HTML files.
| Note: |
If you select the Apache Web server, the installer places
the HTML and image files associated with the Apache server
in this directory. For the Apache server, the document root
directory should be <WebServer_root>/htdocs.
|
- Web
Server CGI-BIN Directory - the full path name of the directory
that contains any Common Gateway Interface (CGI) scripts used
for the Web server and WebZ operations.
- WebZ
Installation Root Directory - the full path name of the WebZ
environment.
- Web
Server Host Name - the name of the host system for the Web
server.
- Host
Name IP Address - the Internet Protocol (IP) address of the
host system.
- Web
Server Port - the port number where you intend to run your
Web server on the host system.
- Process
Username - the user name of the Open SiteSearch suite system
administrator.
- Process
Groupname - the name of the UNIX group that has file permissions
to the files and directories in the <WebServer_root>
directory.
- Server
Admin Email - the electronic mail (e-mail) address of the
Open SiteSearch suite system administrator.
- Directory
where Netscape Server is installed - the directory on the
host system where the Netscape server is installed. This prompt
only appears if you select Netscape as your Web server.
|
|
5. A verification
screen appears. Check this screen to ensure that the information
you entered is correct. An example of the verification screen is
shown below:
Directory of Perl Interpreter: /usr/bin/perl
Operating System: sol
Web Server Type: apache
Web Server Installation Directory: <WebServer_root>
Web Server Document Root Directory: <WebServer_root>/htdocs
Web Server CGI-BIN Directory: <WebServer_root>/cgi-bin
WebZ Installation Root Directory: <WebZ_root>
Web Server Host Name: hostname
Host Name IP Address: XXX.XXX.XX.XX
Web Server Port: 80
Process Username: username
Web Server Group: groupname
Server Admin Email: username@hostname
Netscape Server Install Directory: <WebServer_root>
Is this correct? [y]
|
|
|
6. Is everything
on the verification screen correct?
- Yes.
Continue the installation by pressing Enter.
- No.
Type "n" and press Enter to cycle through the prompts again. Edit
any value that you need to change. When the verification screen
appears again, press Enter to continue with the installation.
|
|
8. When
the installation script finishes, you see a message similar to the
following:
WebZ server installer script Finished!
To start apache, change to httpd/apache/scripts
and type 'apache start'
updating cache ./config.cache
creating ./config.status
|
| Note: |
Some
UNIX platforms return an error message stating that the installer
was unable to update the cache. However, this does not affect
the installation. If you receive this message, ignore it.
|
|
|
9. Complete
all the necessary configuration instructions for your Web server.
The following documents provide configuration information for each
type of supported Web server:
| Note: |
You must complete all of the required configuration procedures
before using SiteSearch. However, if you are using Netscape
or IIS, do not set a document root for until after you install
both the WebZ Extension and WebZ. These servers use
the same directory for HTML documents. If you set the document
root before installing both these products, you create a root
directory for HTML documents (htdocs) that the installer cannot
override.
|
|
| 10. Proceed
to the WebZ installation procedure. |
|