|
Configuring
Netscape to Use the WebZ Extension
Contents
Supported Versions of the "Netscape" Web Server
Introduction
Document
Conventions
Requirements
Netscape
WebZ Configuration Procedure
Netscape
Record Builder Configuration Procedure
Netscape
obj.conf Example for UNIX
Netscape
obj.conf Example for Windows NT
Sun ONE 6.0 Example Changes (*see
Supported Versions of the "Netscape" Web Server)
Supported Versions of the "Netscape" Web Server
Netscape halted development of the Netscape Enterprise Server after version 3.6. After that,
new development to the Netscape Server was done under the product name iPlanet
. And now, Sun has renamed the iPlanet line of products to
Sun ONE.
The following configuration
instructions should work for all versions and product names of what was
once the "Netscape Web Server" up until Sun ONE
version 6.0. SiteSearch will work with Sun ONE version 6.0
with a slightly modified configuration file. In order to install SiteSearch
with the Sun ONE web server, first read the configuration
information below for the previous versions, then
review the changes that need to be made to the existing configuration
files in order for them to work properly with the Sun ONE
Web Server 6.0.
Introduction
After you install the
Netscape WebZ Extension for your operating system, you must
register the extension with the Netscape Web server to allow it to access
the WebZ system and (optionally) Record Builder. This document contains
two procedures – one for Netscape
WebZ configuration and another for Netscape
Record Builder configuration.
As described in the
Requirements section, you do not complete these tasks until after you
install all applicable SiteSearch products.
Document Conventions
- <WebZ_root> refers to the location of your WebZ
environment.
- SiteSearch
4.1.x refers to SiteSearch 4.1.0, 4.1.1, or 4.1.2
- SiteSearch
4.0.x refers to SiteSearch 4.0.0, 4.0.0a, 4.0.1, or 4.0.2.
Requirements
You must complete the
following tasks before configuring the Netscape WebZ Extension:
Important Note:
Refer to your Netscape server documentation for information regarding
server administration and operation.
Return
to Contents
Netscape WebZ Configuration Procedure
Complete the following
procedure to configure your Netscape Web server to work with WebZ. In this
procedure, you:
- Add information
about the WebZ extension to the obj.conf file for the Netscape server
used for WebZ
- Set the document
root for the Netscape server for WebZ to the directory that contains the
WebZ HTML files
- Verify that the
<WebZ_root>/ini/WebSvrExt.ini file contains valid
information.
|
1. When you
installed the Netscape Web server, you created one instance of a Web
server. Is this the Web server you are going to use for
WebZ?
- Yes.
Go to step 2.
- No. Use the
Netscape Web server's administrative interface to create a new
server for WebZ. Then go to step 2.
|
| 2. Make a
backup copy of the obj.conf file for the Netscape server you will
use for WebZ. You can find this file in the Netscape server
directory structure. |
|
3. Open the original of the obj.conf file you
copied in step 2 with a text editor. |
|
4. Add the
following two initialization statements to the end of the first
section of the obj.conf file (immediately before the <Object
name=default> section).
The first
statement calls the function load_modules at server startup to load
the libWebz shared object. The second statement calls the function
webzInit at startup to initialize the WebZ extension and points to
the location of the WebSvrExt.ini file created during the SiteSearch
installation in the <WebZ_root>/ini
directory.
UNIX
Init fn="load-modules"
shlib="<WebZ_root>/httpd/netscape/lib/<platform>/libWebz.so"
funcs="webzInit,webzRequest" LateInit="no" Init fn="webzInit" ini="<WebZ_root>/ini/WebSvrExt.ini" LateInit="no"
Notes:
(UNIX only)
|
(1)
Include the first three lines shown above as a single line
without any line or paragraph breaks in the obj.conf
file.
(2) <platform>
represents your operating system, as
follows:
|
Operating System |
|
<platform>
value |
|
Solaris |
|
so |
|
AiX |
|
aix |
|
Digital UNIX |
|
osf1 |
|
HP-UX |
|
hpux
(SiteSeach 4.1.1 and previous versions) |
|
IRIX |
|
irix |
|
Linux |
|
linux | |
Windows
NT
Init fn="load-modules" shlib="<WebZ_root>/nsapi/nsapiwebz.dll"
funcs="webzInit,webzRequest" LateInit="no" Init fn="webzInit" ini="<WebZ_root>/ini/WebSvrExt.ini" LateInit="no"
| Note: |
(NT only)
Include the first two lines shown above as a single line
without any line or paragraph breaks in the obj.conf
file. |
Refer to the
sample Netscape obj.conf files for UNIX
and Windows
NT to see where to insert these lines in the
file. |
|
5. Add the
following WebZ Service definition to the <Object name=default>
section, directly after the ObjectType definitions. Make sure
that the WebZ Service definition appears before the Netscape Service
definitions.
This statement
adds webzRequest as a Server Application Function (SAF) executed
during the Service step of request processing. This function passes
requests from the Netscape server to the JaSSI.
Service fn="webzRequest"
Refer to the
sample Netscape obj.conf file for UNIX
and Windows
NT to see where to insert this line in the
file. |
|
6. Save and
close the obj.conf file. |
|
7. Using your
Netscape administrative interface, define WebZ's document root
directory using the directory path you defined during the SiteSearch
installation (such as <WebZ_root>/htdocs/, plus the
subdirectory that contains the HTML files. For the WebZ
Out-of-the-Box Interface (OBI) that is the SiteSearch default, this
path is <WebZ_root>/htdocs/obiv1). |
|
8. Did Netscape
prompt you to apply the manual changes you made to the obj.conf file
when you used the Netscape administrative interface in step 7?
- Yes.
Go to directly to step 9.
- No.
Restart your Netscape server to pick up the configuration changes
you made to the obj.conf file. Then to go step 9.
|
| 9. Open the
<WebZ_root>/ini/WebSvrExt.ini
file in a text editor. Review the values defined in this file to
ensure that they are accurate. Make any necessary changes. Save and
close the file. |
|
10. Start
the WebZ System to test
access to the system through the Netscape server using a Web
browser. |
Return
to Contents
Netscape Record Builder Configuration
Procedure
Complete the following
steps to configure your Netscape Web server to work with Record Builder.
In this procedure, you:
- Add a server for
Record Builder to Netscape
- Set the document
root for the Netscape server used for Record Builder to the directory
that contains Record Builder's HTML files
- Add information
about the WebZ extension to the obj.conf file for the Netscape server
used for Record Builder
- Verify that the
<WebZ_root>/ini/WebSvrExt_rb.ini file contains valid
information.
| 1. Use the
Netscape Web server's administrative interface to create a new
server for Record Builder. |
| 2. Define the
document root directory for the Record Builder Web server, using the
directory path <WebZ_root>/htdocs/rbv0. |
|
3. Make a backup
copy of the obj.conf file for the Netscape server you will use for
Record Builder. You can find this file in the Netscape server
directory structure. |
|
4. Open the
original of the obj.conf file you copied in step 3 with a text
editor. |
|
5. Add the
following two initialization statements to the end of the first
section of the obj.conf file (immediately before the <Object
name=default> section).
The first
statement calls the function load_modules at server startup to load
the libWebz shared object. The second statement calls the function
webzInit at startup to initialize the WebZ extension and points to
the location of the WebSvrExt_rb.ini file created during the
SiteSearch installation in the <WebZ_root>/ini
directory.
UNIX
Init fn="load-modules"
shlib="<WebZ_root>/httpd/netscape/lib/<platform>/libWebz.so"
funcs="webzInit,webzRequest" LateInit="no" Init fn="webzInit" ini="<WebZ_root>/ini/WebSvrExt_rb.ini" LateInit="no"
Notes:
(UNIX only)
|
(1)
Include the first three lines shown above as a single line
without any line or paragraph breaks in the obj.conf
file.
(2) <platform>
represents your operating system, as
follows:
|
Operating System |
|
<platform>
value |
|
Solaris |
|
so |
|
AiX |
|
aix |
|
Digital UNIX |
|
osf1 |
|
HP-UX |
|
hpux
(SiteSeach 4.1.1 and previous versions) |
|
IRIX |
|
irix |
|
Linux |
|
linux (beginning with SiteSearch
4.1.2) | |
Windows
NT
Init fn="load-modules" shlib="<WebZ_root>/nsapi/nsapiwebz.dll"
funcs="webzInit,webzRequest" LateInit="no" Init fn="webzInit" ini="<WebZ_root>/ini/WebSvrExt_rb.ini" LateInit="no"
| Note: |
(NT only)
Include the first two lines shown above as a single line
without any line or paragraph breaks in the obj.conf
file. |
Refer to the
sample Netscape obj.conf files for UNIX
and Windows
NT to see where to insert these lines in the
file. |
|
6. Add the
following WebZ Service definition to the <Object name=default>
section, directly after the ObjectType definitions. Make sure
that the WebZ Service definition appears before the Netscape Service
definitions.
This statement
adds webzRequest as a Server Application Function (SAF) executed
during the Service step of request processing. This function passes
requests from the Netscape server to the JaSSI.
Service fn="webzRequest"
Refer to the
sample Netscape obj.conf file for UNIX
and Windows
NT to see where to insert this line in the
file. |
| 7. Save and
close the obj.conf file. |
|
8. Open the
<WebZ_root>/ini/WebSvrExt_rb.ini
file in a text editor. Review the values defined in this file to
ensure that they are accurate. Make any necessary changes. Save and
close the file. |
|
9. Restart your
Netscape server to pick up the configuration changes you made to the
obj.conf file. |
|
10. Start
Record Builder and test
access to the system through the Netscape server using a Web
browser. |
Return
to Contents
Netscape obj.conf Example for
UNIX
Refer to the obj.conf
example below as you configure a Netscape server for WebZ or Record
Builder on a UNIX platform. The items you add appear in dark blue bold print.
# Netscape Communications Corporation - obj.conf
# You can edit this file, but comments and formatting changes
# might be lost when the admin server makes changes.
Init fn=flex-init access="/ss/netscape/https-JohnDoe/logs/access"
format.access="%Ses->client.ip% - %Req->vars.auth-user% [%SYSDATE%] \"%Req-
>reqpb.clf-request%\" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-
length%"
Init fn=load-types mime-types=mime.types
Init fn="load-modules"
shlib="<WebZ_root>/httpd/netscape/lib/<platform>/libWebz.so"
funcs="webzInit,webzRequest" LateInit="no"
Init fn="webzInit" ini="<WebZ_root>/ini/WebSvrExt.ini" LateInit="no"
<Object name=default>
NameTrans fn=pfx2dir from=/ns-icons dir="/ss/netscape/ns-icons"
NameTrans fn=pfx2dir from=/mc-icons dir="/ss/netscape/ns-icons"
NameTrans fn=document-root root="<WebZ_root>/htdocs"
PathCheck fn=unix-uri-clean
PathCheck fn="check-acl" acl="default"
PathCheck fn=find-pathinfo
PathCheck fn=find-index index-names="index.html,home.html"
ObjectType fn=type-by-extension
ObjectType fn=force-type type=text/plain
Service fn="webzRequest"
Service method=(GET|HEAD) type=magnus-internal/imagemap fn=imagemap
Service method=(GET|HEAD) type=magnus-internal/directory fn=index-common
Service method=(GET|HEAD) type=*~magnus-internal/* fn=send-file
AddLog fn=flex-log name="access"
</Object>
<Object name=cgi>
ObjectType fn=force-type type=magnus-internal/cgi
Service fn=send-cgi
</Object>
|
Return
to Contents
Netscape obj.conf Example for Windows
NT
Refer to the obj.conf
example below as you configure a Netscape server for WebZ or Record
Builder on the Windows NT platform. This example is from Netscape
SuiteSpot 3.6; other versions may differ slightly.
# Netscape Communications Corporation - obj.conf
# You can edit this file, but comments and formatting changes
# might be lost when the admin server makes changes.
Init
fn="flex-init" access="C:/Netscape/SuiteSpot/https-webz/logs/access"
format.access="%Ses->client.ip% - %Req->vars.auth-user%
[%SYSDATE%] \"%Req->reqpb.clf-request%\"
%Req->srvhdrs.clf-status%
%Req->srvhdrs.content-length%"
Init fn="load-types"
mime-types="mime.types"
Init
fn="load-modules"
shlib="<WebZ_root>/nsapi/nsapiwebz.dll"
funcs="webzInit,webzRequest" LateInit="no"
Init fn="webzInit"
ini="<WebZ_root>/ini/WebSvrExt.ini"
LateInit="no"
<Object
name="default">
NameTrans fn="pfx2dir" from="/ns-icons"
dir="C:/Netscape/SuiteSpot/https-webz/netscape/suitespot/ns-icons"
NameTrans
fn="pfx2dir" from="/mc-icons"
dir="C:/Netscape/SuiteSpot/https-webz/netscape/suitespot/ns-icons"
NameTrans
fn="document-root"
root="<WebZ_root>/htdocs/obiv1"
PathCheck
fn="check-acl" acl="default"
PathCheck
fn="find-pathinfo"
PathCheck fn="find-index"
index-names="index.html,home.html"
ObjectType
fn="type-by-extension"
ObjectType fn="force-type"
type="text/plain"
Service
fn="webzRequest"
Service method="(GET|HEAD)"
type="magnus-internal/imagemap" fn="imagemap"
Service
method="(GET|HEAD)" type="magnus-internal/directory"
fn="index-common"
Service method="(GET|HEAD)"
type="*~magnus-internal/*" fn="send-file"
AddLog fn="flex-log"
name="access"
</Object>
<Object
name="cgi">
ObjectType fn="force-type"
type="magnus-internal/cgi"
Service
fn="send-cgi"
</Object> |
Return
to Contents
Changes for Sun ONE version 6.0 Example
When using Sun ONE
version 6.0, the "Init" statements have been moved out of the
obj.conf file and moved into another file called magnus.conf
located in the same directory as the obj.conf file. So, the first task
is to remove the "Init" statements from the top of the obj.conf
file. The following is the NT example from above without the Init statements:
# Netscape Communications Corporation - obj.conf
# You can edit this file, but comments and formatting changes
# might be lost when the admin server makes changes.
<Object
name="default">
NameTrans fn="pfx2dir" from="/ns-icons"
dir="C:/Netscape/SuiteSpot/https-webz/netscape/suitespot/ns-icons"
NameTrans
fn="pfx2dir" from="/mc-icons"
dir="C:/Netscape/SuiteSpot/https-webz/netscape/suitespot/ns-icons"
NameTrans
fn="document-root"
root="<WebZ_root>/htdocs/obiv1"
PathCheck
fn="check-acl" acl="default"
PathCheck
fn="find-pathinfo"
PathCheck fn="find-index"
index-names="index.html,home.html"
ObjectType
fn="type-by-extension"
ObjectType fn="force-type"
type="text/plain"
Service
fn="webzRequest"
Service method="(GET|HEAD)"
type="magnus-internal/imagemap" fn="imagemap"
Service
method="(GET|HEAD)" type="magnus-internal/directory"
fn="index-common"
Service method="(GET|HEAD)"
type="*~magnus-internal/*" fn="send-file"
AddLog fn="flex-log"
name="access"
</Object>
<Object
name="cgi">
ObjectType fn="force-type"
type="magnus-internal/cgi"
Service
fn="send-cgi"
</Object> |
Then you need to add the WebZ init statements into your magnus.conf file.
The following is an example of original magnus.conf file from an NT installation
followed directly by a new magnus.conf file with the proper changes for WebZ.
#ServerRoot SERVER_ROOT
NetsiteRoot SUN_ONE_ROOT
ServerID https-Your Server ID
ServerName YOUR HOST NAME
ErrorLog SERVER_ROOT/logs/errors
ExtraPath SUN_ONE_ROOT/bin/https/bin;${NSES_JRE_RUNTIME_LIBPATH}
AdminUsers SUN_ONE_ROOT/https-admserv/config/admpw
MtaHost name-of-mail-server
DNS off
Security off
ClientLanguage en
AdminLanguage en
DefaultLanguage en
RqThrottle 128
Init fn=flex-init access="$accesslog" format.access="%Ses->client.ip% - %Req->vars.auth-user% [%SYSDATE%] \"%Req->reqpb.clf-request%\" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length%"
Init fn=load-types mime-types=mime.types
Init fn="load-modules" shlib="D:/iPlanet/Servers/bin/https/bin/NSServletPlugin.dll" funcs="NSServletEarlyInit,NSServletLateInit,NSServletNameTrans,NSServletService" shlib_flags="(global|now)"
Init fn="NSServletEarlyInit" EarlyInit=yes
Init fn="NSServletLateInit" LateInit=yes
|
And now the changed
magnus.conf file . . .
#ServerRoot SERVER_ROOT
NetsiteRoot SUN_ONE_ROOT
ServerID https-Your Server ID
ServerName YOUR HOST NAME
ErrorLog SERVER_ROOT/logs/errors
ExtraPath SUN_ONE_ROOT/bin/https/bin;${NSES_JRE_RUNTIME_LIBPATH}
AdminUsers SUN_ONE_ROOT/https-admserv/config/admpw
MtaHost name-of-mail-server
DNS off
Security off
ClientLanguage en
AdminLanguage en
DefaultLanguage en
RqThrottle 128
Init fn=flex-init access="$accesslog" format.access="%Ses->client.ip% - %Req->vars.auth-user% [%SYSDATE%] \"%Req->reqpb.clf-request%\" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length%"
Init fn=load-types mime-types=mime.types
Init fn="load-modules" shlib="D:/iPlanet/Servers/bin/https/bin/NSServletPlugin.dll" funcs="NSServletEarlyInit,NSServletLateInit,NSServletNameTrans,NSServletService" shlib_flags="(global|now)"
Init fn="NSServletEarlyInit" EarlyInit=yes
Init fn="NSServletLateInit" LateInit=yes
Init fn="load-types" mime-types="mime.types"
Init fn="load-modules" shlib="<WebZ_Root>/nsapi/nsapiwebz.dll" funcs="webzInit,webzRequest" LateInit="no"
Init fn="webzInit" ini="D:/SiteSearch4.2.1/ini/WebSvrExt.ini" LateInit="no"
|
See
Also
Installing
and Configuring the Open SiteSearch Suite
Operating
the WebZ System
Operating
Record Builder
Configuring
the WebZ
Extension |