Chapter 2   Installing iPlanet Web Proxy Server


This chapter tells you how to install your iPlanet Web Proxy Server. It also explains how to migrate from a previous version of the proxy server and to install multiple proxy servers.

Installing iPlanet Web Proxy Server

---

After you've installed the prerequisite software, you can install iPlanet Web Proxy Server. You can install a new proxy, replace an existing proxy server, or install more than one proxy.

---

Note	While it is possible to install your proxy server on the same machine as another iPlanet server, it is not recommended that you do so. Running two or more iPlanet servers on the same machine will cause a significant impact on the servers' performance.

---

If you're already running a proxy server, you must install the new proxy server on a different port. For example, if you are replacing a proxy that listens to port 8080, you might first install the new proxy server on port 8081, assuming that port is available. After the new proxy server is properly configured, shut down the old proxy server and then change the new proxy to use port 8080.

---

Note	The proxy server must be installed in an empty directory. By default, the installation process uses the directory /usr/netscape/suitespot.

---

To install iPlanet Web Proxy Server:

1. Log in to your computer as root or superuser unless you meet all of the following conditions:
   • You plan to install the server on a port greater than 1024.

   • The location where you plan to install the server (the server root directory) is writable with your current login. For example, you might log in with the server's user account and install to a directory where it has write permissions.

   • The location you plan to use for the cache root is writable with your current login status.

   When you submit the installation forms, you'll get an error if you don't have sufficient permissions to the server root directory (the directory where you want to install the server). If this happens, you have to either change the directory where you install to, change your user permissions, or log in as root and start the installation over. Even if you meet these conditions, you still must log in as root or superuser for the installation.

2. Check to be sure the standard Unix tar program is in your path before you run the installation process.

3. If you have downloaded the software from the iPlanet website, go to your download directory and untar the package by typing the following command:

   prompt% tar xvf proxy.tar

   Replace the proxy.tar variable by the actual name of the tar file.

   If you are installing the software from the product CD, navigate to the directory containing the setup program.

   
   

   ---

   Note	If you use the Solaris operating system, or any other operating system with a memory-based file system, don't use the /tmp directory because you might encounter problems later in the installation.

   ---

   
   

4. Type ./ns-setup to start the server installation.

   This program extracts proxy server files and installs them in the server root directory you specify. If you aren't logged in as root (superuser) or if you don't have sufficient write permissions, you'll get an error message.

5. The installation process will require the following information:
   • Server Root—This is the directory into which the proxy server will be installed. You can either choose the default directory, /usr/netscape/suitespot, or enter another directory.

   • Machine Name—This is the fully qualified host name of the machine onto which you are installing the proxy server. You can either choose the default name in brackets, or type a new name and press Enter.

   • SuiteSpot User—This is the Unix user account that the proxy server will run as. This user should have no privileges in the rest of the system. You can either choose the default user, nobody, or enter another user name.

   • Directory Service—This is the service you will use to store user and group information. You can use either an LDAP-based service, such as iPlanet Directory Server, or you can use the local directory service. If you choose an LDAP-based service, you need to enter the directory server's name, its port, and its Base Distinguished Name. (The Base Distinguished Name is the directory under which all relevant user and group information is stored.)

   • Administration Server Port—This is the port address that the administration server will use. If you are not running as root, this port number must be higher than 1024. You can either choose the default port number in brackets, or type another port number.

   • Administration Server User—This is the user the administration server will run as. This user should be different from the user that the proxy server runs as. Only the user that you specify as the administration server user will have write permission to the proxy server's configuration files (the proxy needs only read permission). The installation program uses the user account you are currently running with (for example, root) as the default. You can either choose this default, or type another user name.

   • Server Administrator's User name and Password—These are the user name and password you will need to access the administration server.

   • Web Browser—This is the command-line name of the web browser you will use to configure your proxy server. If you plan to access the administration server forms from a remote client (such as from a PC), enter NONE and then copy the URL the installation program lists—this is the URL you use to go to the administration server forms. You can either choose the default browser, netscape, or type another browser name.

6. On the Server Administration page, click the "Create New Netscape Proxy Server 3.6" link.

   Fill out the iPlanet Web Proxy Server Installation form that appears. For instructions on filling out this form, see Installing Multiple Proxy Servers.

   
   

   ---

   Note	You can choose the default values on this form during installation and then change the information later by using the Server Manager.

   ---

   
   

   Once you have filled out this form and clicked the OK button, the proxy server is installed.

What Does Installation Do?

---

Some temporary files are written to the /tmp directory and then removed after installation.

The installation program places all of the server files under the server root directory that you specified during installation. If you enabled caching, the cache framework is created under the cache root directory. The following files and directories are created under the server root directory.

Table 2-1    Files and Directories Created by the Proxy Installation Program

Administration server:
start-admin	Script to start the administration server
stop-admin	Script to stop the administration server
bin/admin/ns-config	Script to configure the administration server
bin/admin/admin	Binaries and icons used in the administration server
bin/admin/ns-admin	Administration server main program
admin-serv/config/admpw	Administration server password file
admin-serv/config/cron.conf	Administration server batch processing configuration
admin-serv/config/cron.error	Administration server batch processing error log
admin-serv/logs/errors	Administration server error log
admin-serv/config/ns-admin.conf	Administration server configuration file
admin-serv/config/servers.lst	List of the Netscape servers that are installed
Proxy Server:
bin/proxy/ns-proxy	Proxy binary
bin/proxy/ns-proxy.so	Shared library use by the proxy and the administration server
bin/proxy/admin/	Binaries and icons used in the proxy configuration
bin/proxy/install/	Binaries and icons used in the proxy installation
Server Plug-In API:
nsapi/examples/	Server plug-in example code
nsapi/include/	Server plug-in include files
Miscellaneous:
bin/proxy/install/misc/license.txt	Web Proxy Server license
extras/flexanlg/	Flex-log analyzer
extras/proxy	Miscellaneous tools
ns-icons/	Icons for Gopher menus and FTP listings

Migrating from a Previous Version of the Proxy Server

---

This section tells you how to migrate from an earlier version of iPlanet Web Proxy Server. The migration process supports migration from Netscape Proxy Server 2.5 and 3.5 releases to iPlanet Web Proxy Server 3.6.

The migration process involves installing the new server in a new or empty directory and then transferring the configuration information from the old proxy server to the new one.

To migrate from an earlier version of the proxy server:

1. Shut down your server.

2. Follow the directions in the "Installing iPlanet Web Proxy Server" section to install the new 3.6 server into a separate directory.

3. Start the administration server.

4. On the Server Administration page, click the "Migrate from previous version" button.

5. Type the absolute path to the directory where the older version of the server is installed.

6. Click the Find Servers button.

7. Select the checkbox next to the server for which you want to import the configuration.

8. Click OK. The installation program transfers the configuration information from the old server to the new one. This process can take a few minutes depending on the complexity of your configuration.

9. After this process, you will have two working servers (the old server will be turned off).

   To use your previous cache structure with the new 3.6 server, use the cupgrade utility, as described in the iPlanet Web Proxy Server 3.6 Administrator's Guide.

Installing Multiple Proxy Servers

---

Once you have one proxy server running on your computer, you can install another proxy server without going through the installation program.

Each proxy server you have installed can run on any TCP/IP port on your system, but you cannot run two servers on the same port at the same time. Your proxy server software license allows you to have as many proxy servers as you want on one computer. With multiple servers on your computer, you will see several subdirectories in your server root directory; each of these servers can be managed from the Server Administration page.

To install another proxy server:

1. On the Server Administration page, click the "Create New iPlanet Web Proxy Server 3.6" link.

   The iPlanet Web Proxy Server Installation form appears.

2. Enter values for the following:
   • Server name—Type the fully qualified domain name for your server. If you are installing a second server for a different domain, enter the domain here.

   • Bind address—If you're installing another server in order to have your machine answer to multiple IP addresses, enter the IP address to which this instance of the server should listen. Your system should already be configured to listen to multiple IP addresses. If you're not going to use multiple IP addresses, leave this field blank.

   • Server port—Type the port number to which you want this server to listen.

   • Server identifier—Type the server identification the administration server will use for your server. This is the name that appears in the Server Selector and becomes part of the name for the main directory for this new server. All server instances on the same machine must have a unique server identifier.

   • Server user—Type the user you want the server to run as. You can use an existing user that other servers use.

   • Processes—Type the number of processes that are created when your server starts. The number of processes should be based on the number of requests you anticipate for the server and the speed of the system the server is installed on.

   • DNS behavior—Select whether you want the proxy server always to resolve host names, to resolve them for access control, or never to resolve them.

   • Log format—Select whether you want to use common, extended, or extended-2 log format. For more information on these formats, see the iPlanet Web Proxy Server 3.6 Administrator's Guide.

   • Proxied protocols—Select which protocols (HTTP, FTP, Gopher) your proxy will service.

   • SSL tunneled protocols—Select which secure protocols (HTTPS, NNTP) your proxy server will tunnel.

   • Caching behavior—Specify whether caching is enabled for your proxy server. If you do enable caching, specify the directory where cached files will be stored. For more information on caching, see the iPlanet Web Proxy Server 3.6 Administrator's Guide.

   • Cache size—Select the size of your cache. For more information on cache size, see the iPlanet Web Proxy Server 3.6 Administrator's Guide.

   • Cache sections—Select the number of sections that will be in your cache. Fore more information on cache sections, see the iPlanet Web Proxy Server 3.6 Administrator's Guide.

   • Cache directories per section—Select the number of subdirectories that will be within each section in your cache. For more information on cache directories, see the iPlanet Web Proxy Server 3.6 Administrator's Guide.

   • HTTP caching behavior—Select whether you want your proxy server to cache HTTP documents. If so, specify the refresh and expiration policies. For more information on caching HTTP, see the iPlanet Web Proxy Server 3.6 Administrator's Guide.

   • FTP caching behavior—Select whether you want your proxy server to cache FTP documents. If so, specify the FTP refresh policy. For more information on caching FTP, see the iPlanet Web Proxy Server 3.6 Administrator's Guide.

   • Gopher caching behavior—Select whether you want your proxy server to cache Gopher documents. If so, specify the Gopher refresh policy. For more information on caching Gopher, see the iPlanet Web Proxy Server 3.6 Administrator's Guide.

3. Click OK.