**************************************************************************
* Copyright 1995, 1998 Perforce Software.
*
* This file is part of WebKeeper, a perforce client apache module.
*
* License is hereby granted to use this software and distribute it
* freely, as long as this copyright notice is retained and modifications
* are clearly marked.
*
* ALL WARRANTIES ARE HEREBY DISCLAIMED.
*
* Last updated: December 24, 1998
*
* $Id: //guest/eric_scouten/webkeeper/README.WEBKEEP#1 $
*
**************************************************************************
PERFORCE SOFTWARE WEBKEEPER NOTES
Warning:
This is a demo, not a product.
WHAT YOU HAVE
This directory contains the generic componentry to build an Apache
Web Server with a Perforce WebKeeper module. This directory includes:
Jamfile a description file for 'jam'
README.WEBKEEP this file
mod_webkeep.c the WebKeeper Apache module, C half
mod_webkeep2.cc the WebKeeper Apache module, C++ half
mod_webkeep.h glue between the C and C++ halves
You will also need a Perforce header file and link libraries and
for your platform. They can be found at:
ftp.perforce.com/pub/perforce/r??.?/bin.*/p4api.tar
If you want to build the Apache server with jam, a make(1) alternative
program, it is available from http://www.perforce.com/jam.html. If
you wish to use plain old make(1), you'll need to edit the Makefile
and modules.c.
TO BUILD THE APACHE SERVER
1) Unpack the Perforce libraries.
% cd /path/to/apache/src
% mkdir perforce
% cd perforce
% tar xvf /path/to/p4api.tar
Note that there are source files in the p4api.tar ball
that are not related to webkeeper.
2) Move these files into the Apache directory
% mv Jamfile mod_webkeep.* /path/to/apache/src
3a) If using make(1), fix up Makefile and config.c, then build.
Include perforce/libclient.a, perforce/librcp.a, and
perforce/libsupp.a on the link line.
% cd /path/to/apache/src
% vi Makefile config.c
% make
3b) If using jam, just build.
% jam
TO USE WEBKEEPER
1) Do the necessary steps to get a Perforce server running. See
the admin section of the Perforce manual.
2) Edit the Apache srm.conf file. These are the directives:
WebKeepPort host:port
Gives the address of the Perforce server.
Default is $P4PORT or host 'perforce', port 1666.
WebKeepUser username
Gives the Perforce user name.
Default is $P4USER or $USERNAME.
WebKeepPasswd password
Gives the user's password.
No default.
WebKeepClient clientname
Gives the Perforce client name.
Default is $P4CLIENT or hostname.
WebKeepAlias uri perforcePath
If the URI begins with uri, strips the intial uri,
replaces it with perforcePath, and then treats the
URI as a WebKeeper request.
For example:
WebKeepAlias /$ //depot/index.html
WebKeepAlias / //depot
Maps the URI / to //depot/index.html and the rest of the web
namespace into the corresponding Perforce namespace under //depot.
The $ is necessary to distinguish between initial substring
mactches and exact matches.
You can also use //client/ where client is the name of your
client. If you use //client/, it will map the name through your
client view. You don't have to map the whole namespace. You
could say:
WebKeepAlias /foo/ //depot/
To map only files under /foo/... to the Perforce namespace.
You can have multiple alias lines.
Notes:
Directory indexing is still not yet supported.