|
Installing
Open SiteSearch 4.2.0a
Contents
Introduction
Document Conventions
What's Included in SiteSearch 4.2.0a?
Requirements
Installation Procedure
Removing SiteSearch 4.2.0a
Introduction
This document
explains how to install version 4.2.0a of
Open SiteSearch. This is the initial Open Source SiteSearch release.
Important:: |
|
Existing
SiteSearch users should apply the 4.2.0a upgrade patch (which should
be available by March 31, 2002) to their current SiteSearch environment
rather than using this installer. |
Document
Conventions
What's
Included in SiteSearch 4.2.0a?
WebZ Extension
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 software includes WebZ extensions for
the following Web servers:
For UNIX-Based
Servers
- Apache
- Netscape/iPlanet
Fast Track and Enterprise Servers
For NT Servers
- Netscape/iPlanet
Fast Track and Enterprise Servers
- 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's
iPlanet Enterprise edition and FastTrack edition Web 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.
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.
WebZ
WebZ installation
includes the WebZ configuration files, Out-of-the-Box Interface (OBI)
HTML files, image files, Java classes, and API documentation, and the
WebZ source code on your host system. For UNIX, it also adds MySQL as
the relational database management software for the Access component.
Database Builder
Database Builder
provides the Pears database engine introduced with SiteSearch 4.2.0, including
source code. (The Pears
source code is available from the OCLC Office of Research under a
separate Open Source license.)
Database Builder
also includes the Record Builder application, an end-user application
built on WebZ technology that harnesses Database Builder's administrative
utilities to allow you to create, modify, and maintain searchable Pears
databases for local collections of digital objects (such things as images,
sound files, Web sites, and .PDF files) and data.
You can obtain sample
Pears databases from the SiteSearch
Open Source Web site. The SiteSearch installer does not contain sample
databases to keep the size of the installer to a reasonable size.
Return
to Contents
Requirements
Before completing
this installation, review the information in the Installing
and Configuring the Open SiteSearch Suite and OCLC
SiteSearch Suite System Requirements to ensure that you meet the system
requirements and have all of the information you need to install WebZ
successfully.
UNIX users:
|
|
If you
have an existing Apache Web server and you use the Web server only
to run the Open SiteSearch software, OCLC recommends that you install
all SiteSearch software in the same directory as your Web server.
|
All users:
|
|
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. Doing so creates a root directory for HTML documents
(htdocs) that the installer cannot override.
|
Return
to Contents
Installation
Procedure
Before you install
the WebZ software, configure your UNIX
system environment variables or Windows
NT system environment variables and create a top-level directory to
contain your SiteSearch environment. Then read the instructions below,
and make sure that you have the SiteSearch4_2_0aInstaller.jar installation
file. There is a single installer for all supported UNIX operating systems
(Solaris, Linux, DIGITAL UNIX, or Tru64 UNIX) and Windows NT. OCLC recommends
that UNIX users install using a graphical user interface.
Time Required
for Installation
Plan on up to
30 minutes to install SiteSearch. The specific time required depends on
the speed of your processor and the system load at the time you perform
the installation.
Directions
1. Are you
going to run SiteSearch under UNIX or Windows NT?
- UNIX.
- Which
version of the Java Development Kit (JDK) are you using?
- Version
1.2.2 or higher. Enter this command from the directory
where the installers reside:
java
-jar SiteSearch4_2_0aInstaller.jar
- Version
1.1.8 or below.
Enter this command from the directory where the installers
reside:
java
-classpath \
<fullpath_to_JDK>/lib/classes.zip:SiteSearch4_2_0aInstaller.jar
Note: |
|
Do
not include the backslashes on the command line.
They are included only for readability. Insert a
space in place of the first backslash. Do not insert
a space in place of the second backslash. |
- Windows
NT.
- From
Windows Explorer, double-click the SiteSearch4_2_0aInstaller.jar
file.
- If
double-clicking the file doesn't work, open a DOS window and
enter one of the commands shown for UNIX users, based on your
JDK version.
|
Note: |
|
With
an X-Windows and a PC X server (such as Exceed,
X-WinPro,
or SuperX),
you may receive messages about font problems following the
command prompt to start the installation, such as this:
Font
specified in font.properties not found
[-urw-itc zapfdingbats-medium-r-normal--*-%d-*-*-p-*-sun-
fontspecific]
They
do not affect the installation and you can safely ignore them.
|
|
2. The installer
searches for your Java Development Kit (JDK). After it finds the
JDK, it displays a Welcome screen.
|
3. Click
Next> at the bottom of the Welcome screen.
|
4. Carefully
review the source code license agreement. Use the scroll bars to
scroll horizontally or vertically as needed. After reviewing the
license agreement:
Note: |
|
With
an X-Windows and a PC X server, you may receive one or messages
like this in the UNIX session window after scrolling:
Warning:
Name: HorScrollBar
Class: XmScrollBar
The specified scrollbar value is greater than the maximum
scrollbar value minus the scrollbar slider size.
They
do not affect the installation and you can safely ignore them.
|
|
5. Specify
the directory where you want to install SiteSearch in the Directory
Name text box. The default is the directory where the installer
resides. To specify a different directory, type its name in the
text box or click Browse to select the directory. (The directory
must already exist on the host system.)
|
6. Enter
information about the server where you are installing SiteSearch.
Prompt
|
Description
|
Example
|
Server's
Host Name
|
Full
name of the server that will host SiteSearch.
|
bongo.dev.oclc.org
|
Server's
IP Address
|
Internet
Protocol (IP) address of the SiteSearch host system. |
132.174.211.231
|
Web
Server Name
|
Web
server used for WebZ and Record Builder (if applicable). Click
the radio button that corresponds to your Web server type.
- For
UNIX, click Apache or Netscape.
- For
Windows NT,
click Netscape or Microsoft IIS (Internet Information Server).
|
Apache
|
Note: |
|
The
installer automatically detects the name and IP address of
the server from which you are running the installer.
|
Click Next>
to continue.
|
7. Which operating
system are you using?
- UNIX.
Go to step 8.
- Windows
NT. Go to step 10.
|
8. If you are
installing under UNIX and you selected Apache as your Web server,
you see a screen requesting the following information about the
Apache Web server.
Prompt
|
Description
|
Example
|
Apache
root location
|
Full
path to the Apache Web server's top-level directory. You would
not normally need to change this value.
|
/sitesearch/ss_prod/httpd
|
Apache
administrator e-mail
|
Electronic
mail (e-mail) address of the Open SiteSearch suite system administrator,
who is normally also the administrator of the Apache Web server.
|
jsmith@anywhere.edu
|
WebZ
Apache port
|
Port
on the host system users will access WebZ.
|
8080
|
Record
Builder Apache port
|
Port
on the host system where your staff will access the Record
Builder application. (This must be a different port than the
WebZ Apache port.)
|
8081
|
Click Next>
to continue.
|
9. If you are
installing under UNIX, you see a screen requesting additional information
about your Web server.
Prompt
|
Description
|
Example
|
Apache
process username
|
User
name of the Open SiteSearch suite system administrator.
|
jsmith
|
Apache
process group name
|
Name
of the UNIX group that has file permissions to the files and
directories in the directory specified as the Apache
root location. |
reference
|
Perl
interpreter location
|
Full
path name of the Perl interpreter on the host system.
|
/usr/bin/perl
|
Click Next>
to continue.
|
10. Enter the
following information about the SiteSearch access component. While
the installers use this information, you do not have to use the
Access component to operate WebZ and/or Record Builder.
Prompt
|
Description
|
Example
|
Java
SQL Driver Class Name
|
Fully
qualified class name of the MySQL driver. The default is org.gjt.mm.mysql.Driver,
which is located in the mysql_comp.jar file in the <WebZ_root>/mysql/classes/lib
directory.
|
org.gjt.mm.mysql.Driver
|
MySQL
Port
|
Port
number of the host system that the MySQL server runs on to
provide user authentication to the WebZ OBI and/or staff authentication
for Record Builder. The port number must be greater
than 1024. (The MySQL server manages authentication for both
WebZ and Record Builder through a single port.)
|
2500
|
MySQL
Process Name
|
User
name of the MySQL system administrator.
|
jsmith
|
Click Next>
to continue. Then go to step 12.
|
11. If you
are installing under Windows NT, you see a screen requesting information
about the SiteSearch access component. Enter information about your
SQL server. WebZ and Record Builder for Windows NT supports Microsoft
SQL server as the relational database management system for WebZ's
access control database, as part of the SiteSearch
Access component. While the installers use this information,
you do not have to use the Access component to operate WebZ and/or
Record Builder.
Prompt
|
Description
|
Example
|
Java
SQL Driver Class Name
|
The
fully qualified class name of the SQL driver.
|
sun.jdbc.odbc.JdbcOdbcDriver
|
Click Next>
to continue.
|
12. Indicate
whether you want to install WebZ only or WebZ and Database Builder
by clicking the appropriate radio button:
- WebZ.
Includes WebZ, the WebZ extension, and the WebZ source code.
For UNIX, this also includes a preconfigured Apache Web server
and the WebZ extension for Netscape. For Windows NT, it includes
the WebZ extensions for both Netscape and IIS. (The WebZ extensions
take little space and SiteSearch functions properly with both
WebZ extensions installed.)
- Database
Builder. Includes everything included in a WebZ-only installation,
plus Database Builder (the Pears database engine, Record Builder,
and the SiteSearch Database Operations Tool (SSDOT)), and
and the Database Builder source code.
Click Next>
to continue.
|
13.
The installer displays a confirmation screen, which includes the
<WebZ_root> directory, the components that will be
installed, and the amount of disk space required for the installation.
Click:
|
14. While
the installation proceeds, you can follow its progress by reading
the messages displayed and the progress bar.
|
15. When
the installer completes, click Finish to end the installation.
|
16. Is your
operating system Solaris?
- Yes.
Are you using JDK 1.3.x?
- Yes.
Verify that the text in dark
bold blue print has been added to the two places
shown below in the jassi section of your ssmgr.hostname
file in <WebZ_root>/scripts:
jassi)
if [ $# -eq 1 ]
then
Java -Dfile.encoding=ISO-8859-1
ORG.oclc.jassi.JaSSI \
$ROOTDIR/ini/JaSSIServer.ini
&
else
Java -Dfile.encoding=ISO-8859-1
ORG.oclc.jassi.JaSSI \
$ROOTDIR/ini/$ININAME &
fi
;;
Note: |
The backslashes (\) are included for readability.
DO NOT add them to ssmgr.hostname.
|
- No.
Go to step 17.
- No.
Go to step 17.
|
17. Are you
planning to use Record Builder?
- Yes.
Go to step 18.
- No.
Go to step 21.
|
18. Set the
startup and maximum sizes of the memory allocation pool for the
JaSSIRB server.
Notes: |
(1)
The examples use backslashes (\) only for readability. Do
not include them in your file.
(2) You may wish to refine these values based on your system
configuration and your experience running Record Builder.
|
|
19. For Windows
NT, edit the following variables in the [servername]
section of <WebZ_root>\ini\JaSSIServer_rb.ini so that
they read as follows:
LowUsedMemory
= 45000
MedUsedMemory = 50000
HighUsedMemory = 55000
|
20.
Edit the StartThreshold
and StopThreshold
variables in the [JaSSI] and [JaSSIRB] sections of <WebZ_root>\ini\OpServe_rb.ini
so that they read as follows:
StartThreshold
= 4.0
StopThreshold = 2.25
|
21.
If you are using Netscape or Microsoft IIS, configure your WebZ
server to use the WebZ extension, as described in the following
documents:
|
Return
to Contents
Removing
SiteSearch 4.2.0a
In SiteSearch
4.2.0a, the installers lays down an uninstall directory, <WebZ_root>/_uninst.
This directory contains two files: uninstall.dat and uninstall.jar.
You cannot use the uninstall option if you delete these directories.
The
uninstaller removes all files it created during the installation, including
any of these files that you have modified. To retain your customized versions
of files created during the installation (such as configuration files
in the <WebZ_root>/ini directory), copy or move them elsewhere
before running the uninstaller.
The uninstaller
does not remove new files or directories that you create after the installation,
such as custom Java class packages or HTML files.
Running the
Uninstaller
To remove SiteSearch,
follow these steps:
- Go to <WebZ_root>/_uninst.
- Type:
Java
-jar uninstall.jar
- Follow the
onscreen instructions.
Return
to Contents
See Also
Installing
and Configuring the Open SiteSearch Suite
Operating the WebZ System
|