                    Installation instructions for WebCit
                    ------------------------------------

1. Before you can use WebCit, you must have a Citadel/UX Server up and running.
In order to utilize the graphics features of WebCit, you must be using
Citadel/UX v5.00 or above.  You also must have a working webserver.  WebCit
is designed to work with the Apache webserver, but others should work as well
as long as they support cgi-bins and can act as HTTP proxy servers.

2. Edit the Makefile.
 
   There are some directory names to select here.  Make sure you fully understand
how these three directories work, because it's easy to mess up.  Here's the
rundown:
 
   -> The main webcit directory (WEBCIT).  This directory contains the binaries
for two programs called "webcit" and "session".  It must be defined as a cgi-bin
directory (for example, using the ScriptAlias directive in Apache).
 
   -> The dynamic content directory (DYNAMIC).  This directory will hold images
spooled from the server.  It must be defined as an ordinary Alias.  You may wish
to locate this in a place such as /var/webcit-dynamic or something similar.
 
   -> The static content directory (STATIC).  This directory contains pre-supplied
content that does not change, such as the Java classes for real-time chat.  It
must be defined as an ordinary Alias.
 
   You must select directories from which to serve these three directories, as
well as webserver aliases for those directories.
 
   Edit your webserver configuration to reflect these directory names.  The
WebCit directory should be a ScriptAlias; the image and chat client directories
should be normal aliases.  As an example, here's how mine are defined:

WEBCIT_PATH=/appl/newcit/webcit
WEBCIT_URL=/webcit

DYNAMIC_PATH=/var/webcit-dynamic
DYNAMIC_URL=/webcit-dynamic

STATIC_PATH=/appl/newcit/webcit/static
STATIC_URL=/webcit-static
 
   And here are the appropriate lines from srm.conf in my Apache configuration:

ScriptAlias /webcit/ /appl/newcit/webcit/
Alias /webcit-dynamic/ /var/webcit-dynamic/
Alias /webcit-static/ /appl/newcit/webcit/static/
 
   In this example, the directory /appl/newcit/webcit contains the binaries,
/var/webcit-dynamic contains spooled stuff, and /appl/newcit/webcit/static
contains some of the static content.
 
   The next configuration you must make to your webserver is to enable HTTP
proxy requests.  Newer versions of the Apache webserver can do this.  WebCit
uses the proxy to do the dirty work of decoding URL's and translating multiple
protocols when it must fetch a remote file somewhere on the Internet (such as
graphics files being specified by remote users).  It is strongly recommended
that you use the proxy service on the local webserver; however, if you cannot
do this for some reason, or if you have another proxy somewhere that you feel
would perform this function better, you can specify a different host and port
by redefining HTTP_PROXY_HOST and HTTP_PROXY_PORT in the Makefile.
 
   When done configuring these, remember to create the dynamic content directory
you selected!  Also remember to restart httpd to make your changes take effect.


3. Run make in the main source directory.

4. If you wish, you can also recompile the chat client.  You probably don't
need to do this, because the binaries are included in the distribution, and Java
binaries are universal.
 
5. Set up links on your web site to start WebCit.  Use URL's like this:
 
  http://www.yoursite.org/webcit/session   (default host and port)
 
  http://www.yoursite.org/webcit/session?host=other.host.org&port=504  (remote)
 
 
 
 Please refer to FAQ.txt if you have any problems. 
