Main -> Documentation -> WebZ System Administration -> Configuring the WebZ Extension -> Configuring an Existing 1.2.x Apache Web Server to Use the WebZ System

Configuring an Existing Version 1.2.x Apache Web Server to Use the WebZ System

You can use an existing Apache Web server to connect patrons to the Open SiteSearch WebZ system through a Web browser instead of using the Apache server that is included in the SiteSearch installation. To use an existing server, you must add the WebZ Extension module that is included in the Open SiteSearch Web server installation package to the Apache server configuration file and recompile the server. You will also need to move the HTML and image files used to create the WebZ Out-of-the-Box Interface (OBI), and edit the WebZ configuration files.

Important Note: If you use your existing Apache server to host the Open SiteSearch system in addition to hosting other Web resources, the server's performance may be affected. It is recommended that you use the Apache server included with the SiteSearch installation as a dedicated server for your WebZ Z39.50 and non-Z39.50 resources to ensure searching efficiency.

Requirements

As the SiteSearch suite system administrator, you must have

Assumptions

This document makes the following assumptions:

  • You have maintained the default installed directory structure for your existing Apache server.
  • Your existing Apache server and the WebZ software are running on the same host.

Document Conventions

  • <ExistingServer_root> is the location of the existing Apache server.
  • <WebZ_root> is the location of the WebZ software, including the Apache server that you installed as part of the SiteSearch installation.
  • Version 4.0.x refers to any SiteSearch version prior to 4.1.0; that is 4.0.2, 4.0.1, 4.0.0a, and 4.0.0.

Procedure

Follow the steps below to use an existing Apache server to access the WebZ system through a Web browser.

1. Define the location of the WebSvrExt.ini configuration file in the existing server's srm.conf file.

Move to the <ExistingServer_root>/conf/ directory, and open the srm.conf file in a text editor. At the end of the file, add the following line:

WebZIni   <WebZ_root>/ini/WebSvrExt.ini

Save and close the file.

Note:

In the Open SiteSearch suite, version 4.0.0, the WebSvrExt.ini file was named ApacheExt.ini. With the 4.0.0a release, the ApacheExt.ini file was renamed WebSvrExt.ini.

2. Define the HostnameLookups variable in the server's httpd.conf file.

From the <ExistingServer_root>/conf/ directory, open the httpd.conf file in a text editor. Set the HostnameLookups variable contained in the file to "on." Save and close the file.

3. Move to the <WebZ_root>/htdocs/ directory and rename index.html to sitesearch.html.

4. Edit the WebZ HTML files to change the index.html file to sitesearch.html.

Move to the <WebZ_root>/htdocs/html/ directory, and open the logoff.html file in a text editor. Locate the following line of text:

<A HREF="/WebZ/LOGOFF:&context;?next=index.html" target="_top">

Change index.html to sitesearch.html. The text should now look like the following:

<A HREF="/WebZ/LOGOFF:&context;?next=sitesearch.html" target="_top">

Save and close the file.

Move to the <WebZ_root>/htdocs/error/ directory, and open the nosessionpage.html file in a text editor. Locate the following line of text:

<A HREF="/index.html" target="_top">

Change index.html to sitesearch.html. The text should now look like the following:

<A HREF="/sitesearch.html" target="_top">

Save and close the file.

5. Move the HTML and image files associated with the OBI to the existing Apache server.

Copy the following directories and files located in the <WebZ_root>/htdocs/ directory into the <ExistingServer_root>/htdocs/ directory: error/, html/, images/, help/, icons/, and sitesearch.html.

Important Note: The OBI directories and files MUST be moved directly under the <ExistingServer_root>/htdocs/ directory. DO NOT change the directory structure of these files or move them underneath any subdirectories in the <ExistingServer_root>/htdocs/ directory. If the exact directory structure is not maintained, you will need to make adjustments to the HTML files and Java classes to reference images and links within the OBI.

6. Configure a new DocumentRoot for the WebZ system to locate the OBI HTML and image files.

Move to the <WebZ_root>/ini/ directory, and open the JaSSIServer.ini configuration file in a text editor. Edit the value of the DocumentRoot variable in the [JaSSI] section to reflect the full path name of the <ExistingServer_root>/htdocs/ directory.

7. Move the WebZ Extension to the existing server's directory.

Create a new directory called "webz" in the <ExistingServer_root>/src/modules/ directory. Copy the contents of the <WebZ_root>/httpd/apache/lib/platform/, where platform is the type of operating system that your host is running on, into the <ExistingServer_root>/src/modules/webz directory.

Note:

The Apache configuration scripts used to recompile the server (as instructed in step 9 below) require that a Makefile also be included in the <ExistingServer_root>/src/modules/webz directory. Create a new file called Makefile with the following contents:

libWebZ.a:
        echo "libWebZ.a build"

This file will allow the server to recompile with the WebZ Extension.

8. Make sure that the Apache server configuration includes all of the modules necessary to access the WebZ system, including the WebZ Extension.

Open the Configuration file in the <ExistingServer_root>/src/ directory in a text editor. The following modules should be activated in this file:

  • config_log_module
  • mime_module
  • negotiation_module
  • dir_module
  • access_module
  • auth_module
Note:

If you intend to implement Common Gateway Interface (CGI) functionality in the OBI, you must also include the env_module, cgi_module, and alias_module modules.

Add the following line to the end of the file:

Module webz_module         modules/webz/libWebZ.a

Save the file and close it.

9. Stop and recompile the existing Apache server.

Stop the Apache server as instructed in the server documentation. In the <ExistingServer_root/src/ directory, type "./Configure" and press Enter. You will see information similar to the following as a Makefile for the server is created:

Using config file: Configuration
Using Makefile template file: Makefile.tmpl
+ configured for Solaris 2 platform
+ setting C compiler to gcc
+ setting C compiler optimization-level to -O2

At the command prompt, type "make" and press Enter. You will see information similar to the following on the screen as the server recompiles the modules defined in the Configuration file:

gcc -c -Iregex  -O2 -DSOLARIS2   alloc.c
gcc -c -Iregex -O2 -DSOLARIS2 http_main.c
gcc -c -Iregex -O2 -DSOLARIS2 http_core.c
gcc -c -Iregex -O2 -DSOLARIS2 http_config.c
gcc -c -Iregex -O2 -DSOLARIS2 http_request.c
gcc -c -Iregex -O2 -DSOLARIS2 http_log.c
gcc -c -Iregex -O2 -DSOLARIS2 http_protocol.c
gcc -c -Iregex -O2 -DSOLARIS2 rfc1413.c
gcc -c -Iregex -O2 -DSOLARIS2 util.c
gcc -c -Iregex -O2 -DSOLARIS2 util_script.c
gcc -c -Iregex -O2 -DSOLARIS2 modules.c
gcc -c -Iregex -O2 -DSOLARIS2 buff.c
gcc -c -Iregex -O2 -DSOLARIS2 md5c.c
gcc -c -Iregex -O2 -DSOLARIS2 util_md5.c
gcc -c -Iregex -O2 -DSOLARIS2 explain.c
gcc -c -Iregex -O2 -DSOLARIS2 http_bprintf.c
In file included from /usr/local/include/arpa/inet.h:72,
from conf.h:580,
from http_bprintf.c:19:
/usr/local/include/sys/cdefs.h:80: warning: `__P' redefined
/usr/local/lib/gcc-lib/sparc-sun-solaris2.5/2.7.2.3/include/
math.h:20: warning: this is the location of the previous
definition
gcc -c -Iregex -O2 -DSOLARIS2 util_date.c
gcc -c -Iregex -O2 -DSOLARIS2 util_snprintf.c
gcc -c -Iregex -O2 -DSOLARIS2 mod_env.c
gcc -c -Iregex -O2 -DSOLARIS2 mod_log_config.c
gcc -c -Iregex -O2 -DSOLARIS2 mod_mime.c
gcc -c -Iregex -O2 -DSOLARIS2 mod_negotiation.c
gcc -c -Iregex -O2 -DSOLARIS2 mod_include.c
gcc -c -Iregex -O2 -DSOLARIS2 mod_dir.c
gcc -c -Iregex -O2 -DSOLARIS2 mod_cgi.c
gcc -c -Iregex -O2 -DSOLARIS2 mod_asis.c
gcc -c -Iregex -O2 -DSOLARIS2 mod_imap.c
gcc -c -Iregex -O2 -DSOLARIS2 mod_actions.c
gcc -c -Iregex -O2 -DSOLARIS2 mod_userdir.c
gcc -c -Iregex -O2 -DSOLARIS2 mod_alias.c
gcc -c -Iregex -O2 -DSOLARIS2 mod_access.c
gcc -c -Iregex -O2 -DSOLARIS2 mod_auth.c
gcc -c -Iregex -O2 -DSOLARIS2 mod_browser.c
(cd modules; \
make CC='gcc' AUX_CFLAGS='-O2 -DSOLARIS2 ' RANLIB='ranlib')
(cd webz; make CC='gcc' AUX_CFLAGS='-I../../regex -O2 -DSOLARIS2'
RANLIB='ranlib')
`libWebZ.a' is up to date.
Done building module subdirectories
gcc -o httpd alloc.o http_main.o http_core.o http_config.o
http_request.o http_log.o http_protocol.o rfc1413.o util.o
util_script.o modules.o buff.o md5c.o util_md5.o explain.o
http_bprintf.o util_date.o util_snprintf.o mod_env.o
mod_log_config.o mod_mime.o mod_negotiation.o mod_include.o
mod_dir.o mod_cgi.o mod_asis.o mod_imap.o mod_actions.o
mod_userdir.o mod_alias.o mod_access.o mod_auth.o mod_browser.o
modules/webz/libWebZ.a regex/libregex.a -lsocket -lnsl

10. Verify the Web sites and resources currently running on the existing server function correctly with the new module(s) before testing the WebZ system.

Start the existing Apache server as instructed in the server documentation. Navigate through the resources, making sure that nothing has been affected by the adjustment to the server configuration. Pay particular attention to any advanced features implemented in the Web site(s), such as CGI scripts or JavaScript.

11. Add a link on the existing server's index.html page to the OBI logon screen.

Move to the <ExistingServer_root>/htdocs/ directory, and open the index.html file in a text editor. Add a link similar to the following in the index.html file to allow you to test access to the OBI.

<A HREF="sitesearch.html">Search the WebZ System</A>

Save and close the file.

12. Start the WebZ system.

13. Test the WebZ system through the new server.

Open the existing server's index.html page in a Web browser. Click on the WebZ link that you created. The following logon screen should appear:

WebZ OBI Logon Screen

Use the default User ID, WebZGuest, and password, WebZGuest. Click the Go! button to move to the database selection screen. Perform several searches and review the search results to ensure that the system is functioning correctly.

If this test fails for any reason, repeat the steps above to ensure that you have added the WebZ Extension correctly.

See Also

Operating the WebZ System
Installing the WebZ Extension (Version 4.0.x)
Installing WebZ


[Main][Documentation][Support][Technical Reference][Community][Glossary][Search]

Last Modified: