-------
INSTALL -	INSTALL file for WWWutil package.
-------

This package is set up as a Slackware-style .tgz package for installation 
using Slackware's pkgtool utility.

Alternately, you can simply sit on the / directory and execute the command

tar -xpvzf wwwutil.tgz

That will un-tar the package into its destination directories.

install/doinst.sh

That will execute the Slackware-style install script.

rm -r install

That will delete the install-script.

-------------
REQUIREMENTS:
-------------

This package uses the QDDB database package for its database stuff,
and the Spinner webserver is its preferred/assumed webserver. The shell
scripts work with bash, I do not know if I have used any bash 
peculiarities hence I do not know whether they will work with other 
sh-type shells.

It also uses a custom addition to QDDB called "qhtml". Unfortunately we 
patched that in an older version of QDDB ; the newer QDDB we are now 
using ws a binary release as we have nto been able to put together a 
working set of all the tcl/tk extensions QDDB uses; so our qhtml is older 
and is not linked against QDDB's private copies of the tcl/tk libraries.

qhtml binary is in the qddb binary package found at
ftp://people.kayhay.com/pub/linux/packages/qddb.tgz

Sources for qhtml are linked to in the WWWutil doc tree found at
http://www.knotwork.com/WWWutil/

---------------
rsh capability:
---------------

This package uses rsh extensively to access remote systems. We do this by 
having our cgi-bin stuff execute as UID 16, GID 2  username httpd group 
daemon; which user is granted rsh capability on all the hosts that we 
monitor. This is accomplished by having a .rhosts file in httpd's home 
directory listing machines whose httpd user is allowed access without 
password. See rsh(1) for details of how that works.

-------------------------
Webserver URL-space setup
-------------------------

We use the spinner webserver; the dirs that map into web space are:

pubcgi -> http:/cgi-bin/

members -> http:/members/
membercgi -> http:/members/cgi-bin/

staff -> http:/staff/
staffcgi -> http:/staff/cgi-bin/

It is assumed that members and membercgi are restricted to users having 
valid passwords on the system; and that staff and staffcgi are restricted 
to staffpersons.

All cgi-bin stuff in staffcgi and membercgi runs as the httpd user who 
can rsh to the other systems.

----------------------
WWWutil spinner module
----------------------

WWWutil uses macros defined in a module for the spinner webserver. The 
module and macros are found in ./util/modules.

----------------
WWWutil database
----------------

The QDDB database $WWWUTIL/qdDBs/WWwutil contains headers and footers 
stored on a per-project basis. The cgi-bin programs access this database 
to get their headers and footers; so customising them is done in the 
database. You can for example do

nxqddb $WWWUTIL/qdDBs/WWWutil &

to bring up the generic GUI database interface nxqddb to edit the database.


------------
SOURCE CODE:
------------

This package is mostly scripts and such hence mostly *is* source code; 
however the source code for any binaries included herein is available at 
knotwork.com someplace among the documentation of the package. So check 
starting at

http://www.knotwork.com/info/comp/docs/WWWutil/

and/or

http://www.knotwork.com/~markm/projects/WWWutil/

it or links to it should all be there someplace.

Blessed Be. -MarkM-
