#    Copyright (c) 1998 University of Southern California.
#    All rights reserved.                                            
#                                                                   
#    Redistribution and use in source and binary forms are permitted
#    provided that the above copyright notice and this paragraph are
#    duplicated in all such forms and that any documentation, advertising
#    materials, and other materials related to such distribution and use
#    acknowledge that the software was developed by the University of
#    Southern California, Information Sciences Institute.  The name of the
#    University may not be used to endorse or promote products derived from
#    this software without specific prior written permission.
#    
#    THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
#    WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
#    MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

INSTALLING THE LSAM PROXY
=========================
LSAM Authors: Lars Eggert, Amy S. Hughes, Joe Touch, Stephen Suryaputra
$Revision: 1.18 $ ($Date: 1998/08/27 00:15:27 $)
More Information: http://www.isi.edu/lsam/


Retrieving the Source Code
--------------------------
The source code can be obtained from
http://www.isi.edu/lsam/proxy/1.0/lsam-proxy-1.0.tar.gz

Note that this code was written and tested on FreeBSD 2.2.6. Changes may
be required to make it run on other Unix systems.

Decompress the file:

	% gunzip lsam-proxy-1.0.tar.gz
	% tar -xvf lsam-proxy-1.0.tar

This will create the directory lsam-proxy-1.0 in your current directory.

Your directory structure should look like this:

	lsam-proxy-1.0
		afdp
		apache


Building the LSAM proxy 
-----------------------
There is an installation script provided which makes all the necessary
configuration changes and compiles the server.

Change to the apache root directory and run LSAM-installscript:

	% cd lsam-proxy-1.0/apache
	% LSAM-installscript

You will be prompted for information regarding the location of the
source code for the apache and afdp source code, as well as the perl5
binary. You will also be asked which two ports you wish the server to
listen on. 

NOTE: priviledged ports (<1024) are not permitted, because the LSAM
proxy does not currently support running as 'root', which is required
to open these ports.


Running the LSAM proxy
----------------------
It is advised that you run only one server per working directory.  Thus, if
you wish to run a second server, you must decompress the distribution files in
a second location.

Once you have configured and compiled the server with the LSAM-installscript,
it can be run as follows:

% apache/lsam-bin/apachectl.lsam start

The apachectl.lsam script offers the same functionality as the standard
apachectl script.

Further modification to the server configuration is possible with the
CGI-scripts that have been provided.  Instructions are provided in the next
section.

NOTE: The LSAM proxy does not support running from the 'root' user at
this time.


Interacting with the LSAM proxy
-------------------------------
The LSAM group has created a series of web pages which allow you to interact
with and reconfigure your LSAM proxy server.  These can be accessed via the
following URL: http://server:port/cgi-bin/lsam/configure.pl where you replace
"server:port" with the machine name and port number where your proxy server is
running.

To gain complete access to the configuration files, you must supply the
username:password combination lsam-root:root.

If you enter username=Guest, with no password, you will be able to interact
with a demo version of the configuration pages which function like the real
pages in some ways but do not manipulate real server data.

To use the proxy's cache as your own personal cache, you should point your
browser to use your server as a proxy.

In Netscape v3.x, you can configure the browser to use your proxy as follows:
	- Select "Network Preferences" from the "Options" menu.  
	- Click on "Proxies".
	- Choose "Manual Proxy Configuration".  
	- Click on "View...".
	- Under "HTTP Proxy" enter the machine name where the server resides.
	- In the corresponding "Port:" field, enter the server's port number.  

In Netscape v4.x, the same can be accomplished as follows:  
	- Choose "Preferences" from the "Edit" menu.  
	- Toggle the triangle to display options under "Advanced".
	- Click on "Proxies".
	- Choose "Manual Proxy Configuration".  
	- Click on "View...".
	- Under "HTTP Proxy" enter the machine name where the server resides.
	- In the corresponding "Port:" field, enter the server's port number.  
	

Deactivating the LSAM proxy
---------------------------
To stop the LSAM proxy, use:

% apache/lsam-bin/apachectl.lsam stop