head	1.10;
access;
symbols
	TIGRIS_1_1_0RC2:1.3
	TIGRIS_1_1_0RC1:1.3
	TIGRIS_1_1:1.3.0.12
	TIGRIS_1_0_8:1.3
	TIGRIS_1_0_8RC3:1.3
	TIGRIS_1_0_8RC2:1.3
	TIGRIS_1_0_8RC1:1.3
	TIGRIS_1_0_7:1.3
	TIGRIS_1_0_7RC3:1.3
	TIGRIS_1_0_7RC2:1.3
	TIGRIS_1_0_7RC1:1.3
	TIGRIS_1_0_6:1.3
	TIGRIS_1_0_6RC5:1.3
	TIGRIS_1_0_6RC4:1.3
	TIGRIS_1_0_6RC3:1.3
	TIGRIS_1_0_6RC2:1.3
	TIGRIS_1_0_6RC1:1.3
	TIGRIS_1_0_5:1.3
	TIGRIS_1_0_5RC6:1.3
	TIGRIS_1_0_5RC5:1.3
	TIGRIS_1_0_5RC4:1.3
	TIGRIS_1_0_5RC3:1.3
	TIGRIS_1_0_5RC2:1.3
	TIGRIS_1_0_5RC1:1.3
	TIGRIS_1_0_4:1.3
	TIGRIS_1_0_3:1.3
	TIGRIS_1_0_2:1.3
	TIGRIS_1_0_1:1.3
	TIGRIS_1_0:1.3.0.14
	TIGRIS_1_0_0:1.3
	TIGRIS_1_0_0_RC1:1.3.0.10
	dlr:1.1.1
	TIGRIS_0_9_2_4:1.3
	TIGRIS_0_9_2_3:1.3
	HELM_PEER_PORT_BRANCH:1.1.1.1
	TURBINE_PEER:1.3
	TIGRIS_0_9_2_1:1.3
	TIGRIS_0_9_2:1.3.0.8
	TIGRIS_0_9_0:1.3.0.6
	TIGRIS_0_8_4:1.3.0.4
	TIGRIS_NOV_12_2000:1.3
	OLDHELM:1.3.0.2
	TIGRIS_NOV_11_2000:1.3
	TIGRIS_SEP_13_2000:1.2.0.2
	TIGRIS_BASELINE:1.3;
locks; strict;
comment	@# @;


1.10
date	2001.08.01.04.01.59;	author jrobbins;	state Exp;
branches;
next	1.9;

1.9
date	2001.08.01.03.54.41;	author jrobbins;	state Exp;
branches;
next	1.8;

1.8
date	2001.08.01.03.48.47;	author jrobbins;	state Exp;
branches;
next	1.7;

1.7
date	2001.07.24.17.08.17;	author leonardr;	state Exp;
branches;
next	1.6;

1.6
date	2001.07.24.17.07.08;	author leonardr;	state Exp;
branches;
next	1.5;

1.5
date	2001.07.24.17.06.15;	author leonardr;	state Exp;
branches;
next	1.4;

1.4
date	2001.07.24.17.04.13;	author leonardr;	state Exp;
branches;
next	1.3;

1.3
date	2000.09.20.03.13.18;	author brian;	state Exp;
branches;
next	1.2;

1.2
date	2000.06.27.20.30.08;	author jrobbins;	state Exp;
branches;
next	1.1;

1.1
date	2000.06.27.06.34.57;	author jrobbins;	state Exp;
branches
	1.1.1.1;
next	;

1.1.1.1
date	2001.02.21.00.37.04;	author dlr;	state Exp;
branches;
next	;


desc
@@


1.10
log
@more consistently added info on where the components store data
@
text
@<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
<head>
 <title>Tigris Component Descriptions</title>
</head>

<body>

<h1>Tigris Component Descriptions</h1>

<p>Colm McCartan &lt;colmm at owl dot co dot uk&gt;<br>
Jason Robbins &lt;jrobbins at collab dot net&gt;<br>
July 31, 2001<br>
<small>$Id: component-descriptions.html,v 1.9 2001/08/01 03:54:41 jrobbins Exp $</small>


<h2>Abstract</h2>

<P>This document gives descriptions of each component in the Tigris
suite of tools. A list of each component is provided, with links to
that component's project home page and to a description of how the
component interacts with the Tigris system.
      
<p>See also the (out-of-date) <A HREF="dependencies.html">dependency</A>
page.

   <TABLE BORDER="1" WIDTH="90%">
    <TR>
     <TD colspan="3"><b>Components Below the Sandbox</b></TD>
    </TR>
    <TR>
     <TD WIDTH="100"><A HREF="http://www.apache.org/">Apache</a></TD>
     <TD WIDTH="100"><A HREF="#Apache">more info</A></TD>
     <TD WIDTH="68%">Web server</TD>
    </TR>
    <TR>
     <TD WIDTH="100"><A HREF="http://java.apache.org">Jserv</a></TD>
     <TD WIDTH="100"><A HREF="#Jserv">more info</A></TD>
     <TD WIDTH="68%">Invokes Java servlets</TD>
    </TR>
    <TR>
     <TD WIDTH="100"><a href="http://www.cvshome.org">CVS</a> (To be obsoleted/augmented by <a href="http://subversion.tigris.org/">Subversion</a>)</TD>
     <TD WIDTH="100"><A HREF="#CVS">more info</A></TD>
     <TD WIDTH="68%">Manages files under version control</TD>
    </TR>
    <TR>
     <TD WIDTH="100"><a href="http://www.qmail.org">Qmail</a></TD>
     <TD WIDTH="100"><A HREF="#Qmail">more info</A></TD>
     <TD WIDTH="68%">Email message delivery</TD>
    </TR>
    <TR>
     <TD WIDTH="100"><a href="http://www.ezmlm.org">Ezmlm</a></TD>
     <TD WIDTH="100"><a href="#Ezmlm">more info</A></TD>
     <TD WIDTH="68%">Mailing list management</TD>
    </TR>
    <TR>
     <TD WIDTH="100"><A HREF="http://www.webmacro.org/">WebMacro</a> (Obsolete in 1.2)</TD>
     <TD WIDTH="100"><a href="#WebMacro">more info</A></TD>
     <TD WIDTH="68%">template-based content generation</TD>
    </TR>
    <TR>
     <TD WIDTH="100"><A HREF="http://jakarta.apache.org/velocity/">Velocity</a></TD>
     <TD WIDTH="100"><a href="#Velocity">more info</A></TD>
     <TD WIDTH="68%">template-based content generation</TD>
    </TR>
    <TR>
     <TD WIDTH="100"><a href="http://jakarta.apache.org/turbine/">Turbine</a></TD>
     <TD WIDTH="100"><A HREF="#Turbine">more info</A></TD>
     <TD WIDTH="68%">framework for secure servlet development</TD>
    </TR>
    <TR>
     <TD WIDTH="100"><a href="http://www.mysql.com/">MySQL</a></TD>
     <TD WIDTH="100"><A HREF="#MySQL">more info</A></TD>
     <TD WIDTH="68%">SQL database</TD>
    </TR>
    <TR>
     <TD colspan="3"><b>Components in the Sandbox</b></TD>
    </TR>
    <TR>
     <TD WIDTH="100"><A HREF="http://stud.fh-heilbronn.de/~zeller/cgi/cvsweb.cgi/">CVSWeb</a></TD>
     <TD WIDTH="100"><a href="#CVSWeb">more info</A></TD>
     <TD WIDTH="68%">Web-based access to CVS archives</TD>
    </TR>
    <TR>
     <TD WIDTH="100"><A HREF="http://anzu.tigris.org/">Anzu</a></TD>
     <TD WIDTH="100"><A HREF="#Anzu">more info</A></TD>
     <TD WIDTH="68%">Mailing list Configuration tool</TD>
    </TR>
    <TR>
     <TD WIDTH="100"><A HREF="http://eyebrowse.tigris.org/">Eyebrowse</a></TD>
     <TD WIDTH="100"><a href="#Eyebrowse">more info</A></TD>
     <TD WIDTH="68%">servlet-based mailing list archive browsing</TD>
    </TR>
    <TR>
     <TD WIDTH="100"><A HREF="http://joist.tigris.org/">Joist</a>(Obsolete in 1.2)</TD>
     <TD WIDTH="100"><a href="#Joist">more info</A></TD>
     <TD WIDTH="68%">framework for secure servlet development</TD>
    </TR>
    <TR>
     <TD WIDTH="100"><A HREF="http://helm.tigris.org/">Helm</a></TD>
     <TD WIDTH="100"><a href="#Helm">more info</A></TD>
     <TD WIDTH="68%">servlets for adminstration of Tigris installations</TD>
    </TR>
    <TR>
     <TD WIDTH="100"><A HREF="http://nidaba.tigris.org/">Nidaba</a></TD>
     <TD WIDTH="100"><a href="#Nidaba">more info</A></TD>
     <TD WIDTH="68%">servlets for document sharing</TD>
    </TR>
    <TR>
     <TD WIDTH="100"><A HREF="http://sunsite.berkeley.edu/SWISH-E/">Swish-E</a></TD>
     <TD WIDTH="100"><a href="#Swish-E">more info</A></TD>
     <TD WIDTH="68%">site-wide search</TD>
    </TR>
    <TR>
     <TD WIDTH="100"><A HREF="http://issuezilla.tigris.org/">IssueZilla</a> (To be obsoleted by <a href="http://scarab.tigris.org/">Scarab</a>)</TD>
     <TD WIDTH="100"><a href="#IssueZilla">more info</A></TD>
     <TD WIDTH="68%">web-based bug/issue tracking system based upon <A HREF="http://www.mozilla.org/projects/bugzilla/">BugZilla</A></TD>
    </TR>
   </TABLE>

<P><A NAME="Apache"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Apache</FONT></STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
   <P>Apache serves web pages and invokes modules such as mod_jserv.</P>

   <P>Apache is started by '$SANDBOX/scripts/sandboxctl start'</P>

   <P>Config files:</P>
   <UL>
    <LI>$SANDBOX/conf/httpd.conf
     <ul>
       <li>$SANDBOX/conf/httpd.conf.d (a directory of fragments contributed by each sandbox component, combined by reconfigure.pl)
     </ul>
    </UL>
   </UL>
   <P>Stores data in:</P>
   <UL>
    <LI>Does not store data itself
   </UL>
   <P>Log files:</P>
   <UL>
    <LI>$SANDBOX/logs/access_log
    <LI>$SANDBOX/logs/error_log
    <LI>$SANDBOX/logs/rewrite_log
   </UL>
   <P>Unix process: httpd</P>
   <P>Unix User: httpd</P>
  </TD>
 </TR>
</TABLE>
</P>

<P><A NAME="Jserv"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG> Tigris Component: Jserv</STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
   <P>Jserv invokes java code for servlets based on the URL requested.</P>

   <P>Jserv is started by apache a specified in $SANDBOX/conf/httpd.conf</P>

   <P>Jserv is configured by </P>
   <UL>
    <LI>$SANDBOX/conf/jserv.conf
    <LI>$SANDBOX/conf/jserv.properties
    <LI>$SANDBOX/conf/zone.properties
    <UL>
     <LI>$SANDBOX/conf/registry.servlets (built up via makefiles in sadnboxed components)
     <UL>
      <LI>$SANDBOX/conf/servlets.joist (copied by Makefile from joist/conf)
      <LI>$SANDBOX/conf/servlets.helm (copied by Makefile from helm/conf)
     </UL>
    </UL>
   </UL>
   <P>Stores data in:</P>
   <UL>
    <LI>Does not store data itself
   </UL>
   <P>Log files:</P>
   <UL>
    <LI>$SANDBOX/logs/mod_jserv.log
    <LI>$SANDBOX/logs/jserv.log
   </UL>
   <P>Unix process: httpd and JVM</P>
   <P>Unix User: httpd</P>
  </TD>
 </TR>
</TABLE>
</P>

<P><A NAME="CVS"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: CVS</FONT></STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
   <P><BR>
   CVS manages files that are under version control.</P>

   <P>CVS is invoked via an init script /etc/init.d/Tigris-cvs-pserver. This launches the customised Tigris-cvs-pserver binary using the supervise tool.  Supervise runs the file /var/tcpserver/tigris-cvs-perver/run which runs tcpd which runs tigris-vc (via a link labled "cvs").  The tcpd utillity makes cvs check the /etc/hosts.allow and hosts.deny file on every network access.  The exectuable "tigris-vc" is run via a link named "cvs" so that error message will say "cvs" when they print argv(0).</P>

   <P>CVS is configured by</P>
   <UL>
    <LI>$SANDBOX/data/helm/cvs/repository/CVSROOT/*
    <LI>Notable files in CVSROOT include:
    <UL>
     <LI>loginfo: commands to execute when files are checked in
     <LI>cvswrappers: used mainly to indicate which file extensions should be binary
     <LI>config: info needed to connect to MySQL to check permissions
    </UL>
   </UL>
   <P>CVS invokes the log_accum script to send an email message when a commit is done, this is configured in loginfo.</P>
   <P>In 1.2, CVS loginfo also invokes the publish.pl script to publish web content for each project.</P>

   <P>Customizations:</P>
   <UL>
    <LI>We have customized CVS with a source code patch that is found
    in $SANDBOX/helm/cvspatches.  This version of CVS calls pcheck.pl
    to check permissions in the tigris database.  In 1.2 it does this
    by making xml-rpc calls to helm in the JVM.  This should be borne
    in mind when using any CVS documentation relating to
    authentication.
   </UL>
   <P>Stores data in:</P>
   <UL>
    <LI>Repository files: $sandbox/data/helm/cvs/repository (symlinked from /cvs)
    <LI>Lock files: $sandbox/data/helm/cvs/locks
   </UL>
   <P>Log files:</P>
   <UL>
    <LI>$SANDBOX/data/helm/cvs/repository/CVSROOT/history logs successful transactions
   </UL>
   <P>Unix processes: tcpserver, tcpd, tigris-vc (as "cvs"), pcheck.pl</P>
   <P>Unix User: tigrisc</P>
  </TD>
 </TR>
</TABLE>
</P>

<P><A NAME="Qmail"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Qmail</FONT></STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
   <P>Qmail delivers mail.  The nice thing about qmail is that it processes incoming mail with lots of little config
   files that it finds based on the email address. The anzu system manages the various domains hosted on a Tigris machine and routes mails to the appropriate qmail config files, as well as integrating with ezmlm.</P>

   <P>Qmail is run out of tcpserver when mail comes in. Mail messages are routed through $SANDBOX/site/perl/anzu-deliver.pl for some pre-processing (e.g. trapping mail for system aliases)</P>

   <P>Qmail is configured via:</P>
   <UL>
    <LI>/var/qmail/control/rcpthosts list all domains for which mail is accepted
    <LI>/var/qmail/control/virtualdomains lists rules to map domains to local addresses
    <LI>/var/qmail/alias/.qmail-* contains qmail config files to forward mail addressed to special addresses like root
    <LI>$SANDBOX/data/anzu/domains/$FQDN/projects/$PROJECT/addresses/ stores dot-qmail files for mail sent to users @@$PROJECT$FQDN
   </UL>
   <P>Stores data in:</P>
   <UL>
    <LI>/var/qmail/queue for messages in the process of being delivered
   </UL>
   <P>Log files:</P>
   <UL>
    <LI>/var/qmail/queue/*
    <LI>/var/log/maillog
   </UL>
   <P>Unix processes: qmail-*</P>
   <P>Unix User: qmail*</P>
  </TD>
 </TR>
</TABLE>
</P>

<P><A NAME="Ezmlm"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG> Tigris Component: Ezmlm</STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
   <P><BR>
   Ezmlm is a mailing list manager.  Each mailing list actually contains several lists of addresses: subscribers,
   moderators, people explicitly allowed to post, people explicitly prevented from posting. </P>

   <P>Ezmlm provides dozens of commands.  They are invoked via .qmail config files.</P>

   <P>Ezmlm is configured via:</P>
   <UL>
    <LI>$SANDBOX/conf/anzu/ezmlmrc file contains templates for all ezmlm mailing list config files
    <LI>$SANDBOX/data/anzu/domains/$FQDN/projects/$PROJECT/ directory contains a set of directories and config files for ecah $PROJECT
   </UL>
   <P>Stores data in:</P>
   <UL>
    <LI>$sandbox/data/anzu/domain/$FQDN/project/$PROJECT/addresses/$LISTNAME/archive
    <LI>$sandbox/data/anzu/domain/$FQDN/project/$PROJECT/addresses/$LISTNAME/subscribers
    <LI>$sandbox/data/anzu/domain/$FQDN/project/$PROJECT/addresses/$LISTNAME/mod
   </UL>
   <P>Log files:</P>
   <UL>
    <LI>Mailing list subscriptions and unsubscriptions are logged under $SANDBOX/data/anzu/domains/$FQDN/projects/$PROJECT/ in various Log files
   </UL>
   <P>Unix processes: many ezmlm-* commands</P>
   <P>Unix User: tigrisq</P>
  </TD>
 </TR>
</TABLE>
</P>

<P><A NAME="WebMacro"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: WebMacro</FONT></STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
   <P><BR>
   WebMacro is a java library used to generate web pages from templates with embedded expressions. In Tigris 1.2 it is obsoleted by Velocity.</P>

   <P>WebMacro is invoked by calls to its methods from our base java servlet classes in Joist and Helm.</P>

   <P>WebMacro is configured by:</P>
   <UL>
    <LI>$SANDBOX/conf/WebMacro.properties
   </UL>
   <P>Stores data in:</P>
   <UL>
    <LI>Does not store data itself
   </UL>
   <P>Log files:</P>
   <UL>
    <LI>$SANDBOX/logs/webmacro.log
   </UL>
   <P>Unix processes: servlet JVM</P>
   <P>Unix User: httpd</P>
  </TD>
 </TR>
</TABLE>
</P>

<P><A NAME="Velocity"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Velocity</FONT></STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
   <P><BR>

   Velocity is a Java framework used to generate content from
   templates with embedded expressions (it is similar to WebMacro but
   has an improved parser and less restrictive license). It has strong
   linkages with the Turbine framework, making it ideal for deploying
   servlet content in a secure environment.  It is envisaged that all
   of the Tigris site will be ported to using Velocity rather than
   WebMacro.</P>

   <P>In version 1.0.x, Velocity is used mostly to wrap the integration with
   the Peers Object Mapping tool to give database-independent access
   to helm's security data. Velocity template (.vm) files are
   interpreted and delivered by Apache's servlet container.</P>

   <P>Velocity is configured by:</P>
   <UL>
    <LI>$SANDBOX/conf/TurbineResources.properties
   </UL>
   <P>Stores data in:</P>
   <UL>
    <LI>Does not store data itself
   </UL>
   <P>Log files:</P>
   <UL>
    <LI>$SANDBOX/logs/debug/velocity.log
   </UL>
   <P>Unix processes: servlet JVM</P>
   <P>Unix User: httpd</P>
  </TD>
 </TR>
</TABLE>
</P>

<P><A NAME="Turbine"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Turbine</FONT></STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
   <P><BR>
   Turbine is a java framework for deploying secure web applications.

   <P>Turbine is configured by:</P>
   <UL>
    <LI>$SANDBOX/conf/TurbineResources.properties
   </UL>
   <P>Stores data in:</P>
   <UL>
    <LI>Does not store data itself
   </UL>
   <P>Log files:</P>
   <UL>
    <LI>$SANDBOX/logs/debug/turbine.log
   </UL>
   <P>Unix processes: servlet JVM</P>
   <P>Unix User: httpd</P>
  </TD>
 </TR>
</TABLE>
</P>

<P><A NAME="MySQL"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: MySQL</FONT></STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0"><BR>
   <P>MySQL is a popular open source relational DBMS.</P>
   <BR>
   <P>Stores data in:</P>
   <UL>
    <LI>/var/lib/mysql/
   </UL>
   <P>Log files:</P>
   <UL>
    <LI>normally none, but it can be turned on
   </UL>
   <P>Unix processes: safe-mysql, mysqld</P>
   <P>Unix User: mysql</P>
  </TD>
 </TR>
</TABLE>


<!-- sandbox level -->

<P><A NAME="CVSWeb"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: CVSWeb</FONT></STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
   <P>CVSWeb allows the user to browse CVS managed files and their previous versions.  It also displays log entries
   and it can show a diff of any two versions of a file.</P>

   <P>CVSWeb is a set of CGI scripts invoked via apache.</P>

   <P>CVSWeb is configured with:</P>
   <UL>
    <LI>$SANDBOX/cvsweb/src-browse.conf (apache .conf file)
    <LI>$SANDBOX/cvsweb/cvsweb.conf (cvsweb's own config language)
   </UL>
   <P>No log files.
  </TD>
 </TR>
</TABLE>
</P>


<P><A NAME="Anzu"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Anzu</FONT></STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">

   <P>Anzu gets mail from qmail and route it to be processed by the
   correct ezmlm config files.  Anzu also runs its own java server to
   get RMI calls from helm mailing list config servlets and make
   changes to ezmlm config files.</P>

   <P>The Anzu delivery script is invoked by qmail on each incoming
   email message. The Anzu server is started by sandboxctl at the same
   time the main servlet JVM is started.</P>

   <P>Qmail is configured via:</P>
   <UL>
    <LI>/var/qmail/control/rcpthosts list all domains for which mail is accepted
    <LI>/var/qmail/control/virtualdomains lists rules to map domains to local addresses
    <LI>/var/qmail/alias/.qmail-* contains qmail config files to forward mail addressed to special addresses like root
    <LI>$SANDBOX/data/anzu/domains/$FQDN/projects/$PROJECT/addresses/ stores dot-qmail files for mail sent to users @@$PROJECT$FQDN
   </UL>
   <P>Log files:</P>
   <UL>
    <LI>/var/qmail/queue/*
    <LI>/var/log/maillog
    <LI>$sandbox/log/debug/anzu.log
   </UL>
   <P>Unix processes: supervise, Anzu JVM, delivery.pl</P>
   <P>Unix User: tigrisq</P>
  </TD>
 </TR>
</TABLE>
</P>

<P><A NAME="Eyebrowse"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG> Tigris Component: Eyebrowse</STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
   <P><BR>
    Eyebrowse is a web-based mailing list archive browser.  Eyebrowse
    differs from other popular archive browsers in that it does not
    require that mailing lists be exploded into individual HTML files,
    and that the HTML rendering is done at serving time, rather than at
    the time the message is received, to allow for easy customization
    of the message display.  HTML rendering is done through the use of
    WebMacro (Velocity) templates.
   </P>
   <P>Eyebrowse servlets run in the regular servlet JVM to when HTTP
   requests for those pages come in.  Eyebrowse also has a cron task
   that runs every 5 minutes to process any new messages in the
   various mailing list mailboxes.  Processing consists of extracting
   some header information and putting it into a database table.

   <P>Eyebrowse is configured via:</P>
   <UL>
    <LI>$SANDBOX/conf/anzu/ezmlmrc file contains templates for all ezmlm mailing list config files
    <LI>$SANDBOX/data/anzu/domains/$FQDN/projects/$PROJECT/ directory contains a set of directories and config files for ecah $PROJECT
   </UL>
   <P>Eyebrowse stores data in:</P>
   <UL>
    <LI>$SANDBOX/data/eyebrowse/$FQDN/$PROJECT/0mbox: mailbox for each list
    <LI>$SANDBOX/data/eyebrowse/$FQDN/$PROJECT/index: search indexes
    <LI>Database tables eb_*
   </UL>
   <P>Log files:</P>
   <UL>
    <LI>$SANDBOX/log/debug/eyebrowse.log
   </UL>
   <P>Unix processes: call_eyebrowse, Eyebrowse JVM, servlet JVM</P>
   <P>Unix User: tigrisq</P>
  </TD>
 </TR>
</TABLE>
</P>


<P><A NAME="Joist"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Joist</FONT></STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
   <P><BR>
   Joist is a Java framework for developing secure web applications. In Tigris 1.2, its functionality has been moved into Helm and Turbine.</P>

   <P>Joist is configured by:</P>
   <UL>
    <LI>$SANDBOX/conf/servlets (interpolated by make from $SANDBOX/joist/conf/30joist.servlets)
    <LI>$SANDBOX/conf/zone.properties (interpolated by make from $SANDBOX/joist/conf/30joist.zone.properties)

   </UL>
   <P>Log files:</P>
   <UL>
    <LI>$SANDBOX/logs/debug/webmacro.log (in earlier versions)
    <LI>$SANDBOX/logs/debug/turbine.log (in later versions)
   </UL>
   <P>Unix processes: servlet JVM</P>
   <P>Unix User: httpd</P>
   <P>
  </TD>
 </TR>
</TABLE>
</P>


<P><A NAME="Helm"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Helm</FONT></STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
   <P>Helm is a set of Java servlets subclassed from the Turbine
   framework.  The goal of Helm is to provide administrative functions
   for a machine running Tigris: for example, setting up and
   administrating user accounts, projects, and groupings of both. It also
   contains permission administration servlets.
   </p>

   <P>Helm is configured by:</P>
   <UL>
    <LI>$SANDBOX/conf/servlets (interpolated by make from $SANDBOX/helm/conf/40helm.servlets)
    <LI>$SANDBOX/conf/httpd.conf (interpolated by make from  $SANDBOX/helm/conf/helm.httpd.conf*)
    <LI>$SANDBOX/conf/zone.properties (interpolated by make from  $SANDBOX/helm/conf/40helm.zone.properties)
    <LI>and per-servlet .properties files in $SANDBOX/site/java/org/tigris/helm/.../*.properties (put there by make in $SANDBOX/helm/java)
    <LI>Webmacro/Velocity templates in $SANDBOX/site/templates/$BRAND/org/tigris/helm/.../*.[wv]m (put there by make in $SANDBOX/helm/templates)
   </UL>
   <P>Database tables:</P>
   <UL>
    <LI>HELM_ACTION
    <LI>HELM_AUDIT_LOG_ENTRY
    <LI>HELM_CLUSTER_EVENT
    <LI>HELM_DOMAIN
    <LI>HELM_INVITATION
    <LI>HELM_MAILINGLIST
    <LI>HELM_NEWSITEM
    <LI>HELM_PROJECT
    <LI>HELM_PROJECTDOCUMENT
    <LI>HELM_PROJECTDOWNLOAD
    <LI>HELM_PROJECTSECTION
    <LI>HELM_PROJECT_DOCUMENT_SECTION
    <LI>HELM_PROJECT_PROJECTGROUP
    <LI>HELM_RESOURCE
    <LI>HELM_ROLE
    <LI>HELM_ROLE_ACTION_RESOURCE
    <LI>HELM_TASK
    <LI>HELM_USER
    <LI>HELM_USER_PROJECT_INTEREST
    <LI>HELM_USER_ROLE_PROJECT
    <LI>HELM_USER_USERGROUP
    <LI>HELM_VC_MAP
    <LI>HELM_VC_VIEW
   </UL>
   <P>Log files:</P>
   <UL>
    <LI>$SANDBOX/logs/webmacro.log or $SANDBOX/logs/velocity.log
    <LI>$SANDBOX/logs/turbine.log
    <LI>$SANDBOX/logs/HelmPerlScripts.log
   </UL>
   <P>Unix processes: servlet JVM</P>
   <P>Unix User: httpd</P>
  </TD>
 </TR>
</TABLE>
</P>

<P><A NAME="Nidaba"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Nidaba</FONT></STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
   <P>Nidaba is a set of servlets for managing project working
   documents.  Nidaba is a sandbox component that builds on Helm.
   Writes .htaccess files with config info for mod_auth_mda to guard
   access to managed files.
   </p>

   <P>Nidaba is configured by:</P>
   <UL>
    <LI>$SANDBOX/conf/servlets (interpolated by make from $SANDBOX/helm/conf/60nidaba.servlets)
    <LI>$SANDBOX/conf/httpd.conf (interpolated by make from  $SANDBOX/helm/conf/helm.httpd.conf*)
    <LI>$SANDBOX/conf/zone.properties (interpolated by make from  $SANDBOX/helm/conf/60nidaba.zone.properties)
    <LI>and per-servlet .properties files in $SANDBOX/site/java/org/tigris/nidaba/.../*.properties (put there by make in $SANDBOX/nidaba/java)
    <LI>Webmacro/Velocity templates in $SANDBOX/site/templates/$BRAND/org/tigris/nidaba/.../*.[wv]m (put there by make in $SANDBOX/nidaba/templates)
   </UL>
   <P>Database tables:</P>
   <UL>
    <LI>NIDABA_PROJECTDOCUMENT
    <LI>NIDABA_PROJECTSECTION
    <LI>NIDABA_DOCUMENT_SECTION
   </UL>
   <P>Stores data in:</P>
   <UL>
    <LI>$SANDBOX/data/nidaba/$DOCUMENT_ID/filename
   </UL>
   <P>Log files:</P>
   <UL>
    <LI>$SANDBOX/logs/webmacro.log or $SANDBOX/logs/velocity.log
    <LI>$SANDBOX/logs/turbine.log
   </UL>
   <P>Unix processes: servlet JVM</P>
   <P>Unix User: httpd</P>
  </TD>
 </TR>
</TABLE>
</P>

<P><A NAME="Swish-E"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG> Tigris Component: Swish-E</STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
   <P>Swish-Enhanced is an open-source indexing and search engine developed initially at Berkeley</P>

   <P>Swish-E is configured by:</P>
   <UL>
    <LI>The contents of $SANDBOX/search/swish.conf
   </UL>

   <P>No log files.
   <P>Unix processes: makeit, swish-e</P>
   <P>Unix User: root?</P>
  </TD>
 </TR>
</TABLE>
</P>

<P><A NAME="IssueZilla"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: IssueZilla</FONT></STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
   <P>IssueZilla is a customisation of the popular bug tracking system developed by the mozilla.org community, Bugzilla.</P>

   <P>Issuezilla consists of a set of CGI and perl libraries invoked
   via Apache. IssueZilla has a slightly tidier appearance than
   BugZilla, cleaner code, and some small alterations of the data
   model to allow different types of issue to be registered, rather
   than simply bugs of differing severity. IssueZilla databases have
   user accounts and permissions derived from Helm user accounts and
   permissions, allowing for centralized administration.</P>

   <P>An issues database is created for each project, category, or
   project group, with the tables shown below.

   <P>IssueZilla is configured by:</P>
   <UL>
    <LI>$SANDBOX/conf/httpd.conf (interpolated by make from $SANDBOX/issuezilla/issue-track.conf)
   </UL>
   <P>Database tables:</P>
   <UL>
    <LI>attachments
    <LI>cc
    <LI>components
    <LI>dependencies
    <LI>fielddefs
    <LI>groups
    <LI>issues
    <LI>issues_activity
    <LI>keyworddefs
    <LI>keywords
    <LI>logincookies
    <LI>longdescs
    <LI>milestones
    <LI>namedqueries
    <LI>profiles
    <LI>profiles_activity
    <LI>shadowlog
    <LI>subcomponents
    <LI>versions
    <LI>votes
    <LI>watch
   </UL>
   <P></P>

   <P>No log files.
   <P>Unix processes: perl CGI</P>
   <P>Unix User: httpd</P>

  </TD>
 </TR>
</TABLE>
</P>


</BODY>

</HTML>


@


1.9
log
@reorganized to separate out sandbox components
@
text
@d14 1
a14 1
<small>$Id: component-descriptions.html,v 1.8 2001/08/01 03:48:47 jrobbins Exp $</small>
d29 1
a29 1
     <TD colspan="3">Components Below the Sandbox</TD>
d77 1
a77 1
     <TD colspan="3">Components in the Sandbox</TD>
d140 4
d181 4
d231 5
d266 4
d275 2
d300 6
d333 4
d374 4
d403 4
d427 1
a427 1
   <P>Data files:</P>
d431 4
d648 4
a651 1
   <P>Nidaba is a set of servlets for managing project working documents.  Nidaba is a sandbox component that builds on Helm.
@


1.8
log
@added detail about unix processes, unix users, and location of data file storage
added nidaba and anzu
@
text
@d14 1
a14 1
<small>$Id: component-descriptions.html,v 1.7 2001/07/24 17:08:17 leonardr Exp $</small>
d29 3
a46 5
     <TD WIDTH="100"><A HREF="http://stud.fh-heilbronn.de/~zeller/cgi/cvsweb.cgi/">CVSWeb</a></TD>
     <TD WIDTH="100"><a href="#CVSWeb">more info</A></TD>
     <TD WIDTH="68%">Web-based access to CVS archives</TD>
    </TR>
    <TR>
a51 5
     <TD WIDTH="100"><A HREF="http://anzu.tigris.org/">Anzu</a></TD>
     <TD WIDTH="100"><A HREF="#Anzu">more info</A></TD>
     <TD WIDTH="68%">Mailing list Configuration tool</TD>
    </TR>
    <TR>
a56 5
     <TD WIDTH="100"><A HREF="http://eyebrowse.tigris.org/">Eyebrowse</a></TD>
     <TD WIDTH="100"><a href="#Eyebrowse">more info</A></TD>
     <TD WIDTH="68%">servlet-based mailing list archive browsing</TD>
    </TR>
    <TR>
d67 2
a68 2
     <TD WIDTH="100"><A HREF="http://joist.tigris.org/">Joist</a>(Obsolete in 1.2)</TD>
     <TD WIDTH="100"><a href="#Joist">more info</A></TD>
d72 25
a96 2
     <TD WIDTH="100"><a href="http://jakarta.apache.org/turbine/">Turbine</a></TD>
     <TD WIDTH="100"><A HREF="#Turbine">more info</A></TD>
a118 5
    <TR>
     <TD WIDTH="100"><a href="http://www.mysql.com/">MySQL</a></TD>
     <TD WIDTH="100"><A HREF="#MySQL">more info</A></TD>
     <TD WIDTH="68%">SQL database</TD>
    </TR>
a233 23
<P><A NAME="CVSWeb"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: CVSWeb</FONT></STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
   <P>CVSWeb allows the user to browse CVS managed files and their previous versions.  It also displays log entries
   and it can show a diff of any two versions of a file.</P>

   <P>CVSWeb is a set of CGI scripts invoked via apache.</P>

   <P>CVSWeb is configured with:</P>
   <UL>
    <LI>$SANDBOX/cvsweb/src-browse.conf (apache .conf file)
    <LI>$SANDBOX/cvsweb/cvsweb.conf (cvsweb's own config language)
   </UL>
   <P>No log files.
  </TD>
 </TR>
</TABLE>
</P>

a262 37
<P><A NAME="Anzu"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Anzu</FONT></STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">

   <P>Anzu gets mail from qmail and route it to be processed by the
   correct ezmlm config files.  Anzu also runs its own java server to
   get RMI calls from helm mailing list config servlets and make
   changes to ezmlm config files.</P>

   <P>The Anzu delivery script is invoked by qmail on each incoming
   email message. The Anzu server is started by sandboxctl at the same
   time the main servlet JVM is started.</P>

   <P>Qmail is configured via:</P>
   <UL>
    <LI>/var/qmail/control/rcpthosts list all domains for which mail is accepted
    <LI>/var/qmail/control/virtualdomains lists rules to map domains to local addresses
    <LI>/var/qmail/alias/.qmail-* contains qmail config files to forward mail addressed to special addresses like root
    <LI>$SANDBOX/data/anzu/domains/$FQDN/projects/$PROJECT/addresses/ stores dot-qmail files for mail sent to users @@$PROJECT$FQDN
   </UL>
   <P>Log files:</P>
   <UL>
    <LI>/var/qmail/queue/*
    <LI>/var/log/maillog
    <LI>$sandbox/log/debug/anzu.log
   </UL>
   <P>Unix processes: supervise, Anzu JVM, delivery.pl</P>
   <P>Unix User: tigrisq</P>
  </TD>
 </TR>
</TABLE>
</P>

a291 45
<P><A NAME="Eyebrowse"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG> Tigris Component: Eyebrowse</STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
   <P><BR>
    Eyebrowse is a web-based mailing list archive browser.  Eyebrowse
    differs from other popular archive browsers in that it does not
    require that mailing lists be exploded into individual HTML files,
    and that the HTML rendering is done at serving time, rather than at
    the time the message is received, to allow for easy customization
    of the message display.  HTML rendering is done through the use of
    WebMacro (Velocity) templates.
   </P>
   <P>Eyebrowse servlets run in the regular servlet JVM to when HTTP
   requests for those pages come in.  Eyebrowse also has a cron task
   that runs every 5 minutes to process any new messages in the
   various mailing list mailboxes.  Processing consists of extracting
   some header information and putting it into a database table.

   <P>Eyebrowse is configured via:</P>
   <UL>
    <LI>$SANDBOX/conf/anzu/ezmlmrc file contains templates for all ezmlm mailing list config files
    <LI>$SANDBOX/data/anzu/domains/$FQDN/projects/$PROJECT/ directory contains a set of directories and config files for ecah $PROJECT
   </UL>
   <P>Eyebrowse stores data in:</P>
   <UL>
    <LI>$SANDBOX/data/eyebrowse/$FQDN/$PROJECT/0mbox: mailbox for each list
    <LI>$SANDBOX/data/eyebrowse/$FQDN/$PROJECT/index: search indexes
    <LI>Database tables eb_*
   </UL>
   <P>Log files:</P>
   <UL>
    <LI>$SANDBOX/log/debug/eyebrowse.log
   </UL>
   <P>Unix processes: call_eyebrowse, Eyebrowse JVM, servlet JVM</P>
   <P>Unix User: tigrisq</P>
  </TD>
 </TR>
</TABLE>
</P>


d356 1
a356 1
<P><A NAME="Joist"></A>
d359 1
a359 1
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Joist</FONT></STRONG></TD>
d364 1
a364 1
   Joist is a Java framework for developing secure web applications. In Tigris 1.2, its functionality has been moved into Helm and Turbine.</P>
d366 1
a366 1
   <P>Joist is configured by:</P>
d368 1
a368 3
    <LI>$SANDBOX/conf/servlets (interpolated by make from $SANDBOX/joist/conf/30joist.servlets)
    <LI>$SANDBOX/conf/zone.properties (interpolated by make from $SANDBOX/joist/conf/30joist.zone.properties)

d372 1
a372 2
    <LI>$SANDBOX/logs/debug/webmacro.log (in earlier versions)
    <LI>$SANDBOX/logs/debug/turbine.log (in later versions)
a375 1
   <P>
d381 129
a509 1
<P><A NAME="Turbine"></A>
d512 1
a512 1
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Turbine</FONT></STRONG></TD>
d517 1
a517 1
   Turbine is a java framework for deploying secure web applications.
d519 1
a519 1
   <P>Turbine is configured by:</P>
d521 3
a523 1
    <LI>$SANDBOX/conf/TurbineResources.properties
d527 2
a528 1
    <LI>$SANDBOX/logs/debug/turbine.log
d532 1
a719 19

<P><A NAME="MySQL"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
 <TR>
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: MySQL</FONT></STRONG></TD>
 </TR>
 <TR>
  <TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0"><BR>
   <P>MySQL is a popular open source relational DBMS.</P>
   <BR>
   <P>Data files:</P>
   <UL>
    <LI>/var/lib/mysql/
   </UL>
   <P>Unix processes: safe-mysql, mysqld</P>
   <P>Unix User: mysql</P>
  </TD>
 </TR>
</TABLE>
@


1.7
log
@Standardized font color.
@
text
@d13 2
a14 2
July 24, 2001<br>
<small>$Id: component-descriptions.html,v 1.6 2001/07/24 17:07:08 leonardr Exp $</small>
d54 5
d94 5
d126 1
a126 1
   <P>Apache's config files are rooted at $SANDBOX/conf/httpd.conf and from there the following files are included (i.e. interpolated at build time):</P>
d128 4
a131 10
    <LI>$SANDBOX/conf/jserv.conf
    <LI>$SANDBOX/conf/registry.httpd.conf (this file is automatically generated by Makefiles in each sandboxed component
    to build)
    <UL>
     <LI>$SANDBOX/conf/aliases.conf
     <LI>$SANDBOX/helm/conf/helm-webmodules.conf
     <LI>$SANDBOX/issuezilla/issue-track.conf
     <LI>$SANDBOX/cvsweb/src-browse.conf
     <LI>$SANDBOX/search/swish.conf
     <LI>$SANDBOX/helm/conf/helm-main.conf
d140 2
d176 2
a177 1
   <P>
d193 1
a193 1
   <P>CVS is invoked via an init script /etc/init.d/Tigris-cvs-pserver. This launches the customised Tigris-cvs-pserver binary using the supervise tool - note that this binary has been altered so that its authentication system checks the helm user setup. This should be borne in mind when using any CVS documentation relating to authentication.</P>
d206 1
d210 6
a215 1
    <LI>We have customized CVS with a source code patch that is found in $SANDBOX/helm/cvspatches
d221 2
a222 1
   <P>
d261 1
a261 1
   <P>Qmail is run out of tcpserver when mail comes in. Mails are routed through $SANDBOX/site/perl/anzu-deliver.pl for some pre-processing (e.g. trapping mail for system aliases)</P>
d280 37
d339 2
d362 5
a366 1

d373 6
d383 2
d411 2
a412 1
   <P>
d435 1
a435 1
   <P>Velocity is currently used mostly to wrap the integration with
d446 1
a446 1
    <LI>$SANDBOX/logs/debug/turbine.log
d448 2
a449 1
   <P>
d471 7
a477 1
   <P>No log files.</P>
d502 2
a503 1
   <P>
d564 42
a605 1
   <P>
d626 2
d684 3
d705 2
@


1.6
log
@Corrected copy-and-paste mistake.
@
text
@d14 1
a14 1
<small>$Id: component-descriptions.html,v 1.5 2001/07/24 17:06:15 leonardr Exp $</small>
d144 1
a144 1
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="red" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Jserv</FONT></STRONG></TD>
d269 1
a269 1
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="red" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Ezmlm</FONT></STRONG></TD>
d296 1
a296 1
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="red" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Eyebrowse</FONT></STRONG></TD>
d499 1
a499 1
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="red" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Swish-E</FONT></STRONG></TD>
@


1.5
log
@Corrected bad(?) html.
@
text
@d14 1
a14 1
<small>$Id: component-descriptions.html,v 1.4 2001/07/24 17:04:13 leonardr Exp $</small>
d391 1
a391 1
  <TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: WebMacro</FONT></STRONG></TD>
@


1.4
log
@Committing changes made by Colm McCartan to bring the component description document up to date.
@
text
@d14 1
a14 1
<small>$Id: actions.html,v 1.2 2001/07/11 17:38:15 leonardr Exp $</small>
d19 4
a22 4
<P>This document gives descriptions of each component in the
implementation of the Tigris suite of tools. A list of each component
is provided, with links to that component's project home page and to a
description of how the component interacts with the Tigris system.
a26 5
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">

   <P>
   <CENTER>
   <P>
a103 6

</CENTER>
  </TD>
 </TR>
</TABLE>
</P>
@


1.3
log
@
Obtained from:
Submitted by:
Reviewed by:

Moved from org.helm to org.tigris.helm
Moved from org/helm to org/tigris/helm

perl -pi.bak -e, how I love thee

note: this update was done POST-CVS-REPOSITORY surgury.  In order to
get this right, you may need to remove the directories

$CVSROOT/helm/java/org/helm
$CVSROOT/helm/data/htdoc/look/www/org/helm
$CVSROOT/helm/templates/org/helm

before doing the "CVS update" call, since those directories don't
exist anymore and CVS will try to create lockfiles for you in them,
giving you an error.
@
text
@d1 108
a108 94
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>

<HEAD>
	<META HTTP-EQUIV="Content-Type" CONTENT="text/html;CHARSET=iso-8859-1">
<META NAME="VPSiteProject" CONTENT="file:///D|/jr/cvs/tigris/helm/www/docs/Project.vpp">

	<META NAME="GENERATOR" Content="Visual Page 2.0 for Windows">
	<TITLE>untitled</TITLE>
</HEAD>

<BODY>

<P>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
	<TR>
		<TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component Descriptions</FONT></STRONG></TD>
	</TR>
	<TR>
		<TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
			<P>This document gives descriptions of each component in the implementation of tigris. Each description says a
			little about how that component is configured and works with the others.  See also the <A HREF="dependencies.html">depenency</A>
			page. The table below also indicates where developers can find out more about that component.</P>

			<P>
			<CENTER>
			<P>
			<TABLE BORDER="1" WIDTH="90%">
				<TR>
					<TD WIDTH="100">Apache</TD>
					<TD WIDTH="100"><A HREF="http://www.apache.org/">more info</A></TD>
					<TD WIDTH="68%">Web server</TD>
				</TR>
				<TR>
					<TD WIDTH="100">JServ</TD>
					<TD WIDTH="100"><A HREF="http://java.apache.org">more info</A></TD>
					<TD WIDTH="68%">invokes java servlets</TD>
				</TR>
				<TR>
					<TD WIDTH="100">CVS</TD>
					<TD WIDTH="100"><A HREF="http://www.cyclic.com">more info</A></TD>
					<TD WIDTH="68%">manages files under version control (soon to be <A HREF="http://subversion.tigris.org/">subversion</A>)</TD>
				</TR>
				<TR>
					<TD WIDTH="100">cvsweb</TD>
					<TD WIDTH="100"><A HREF="http://stud.fh-heilbronn.de/~zeller/cgi/cvsweb.cgi/">more info</A></TD>
					<TD WIDTH="68%">web-based access to cvs archives</TD>
				</TR>
				<TR>
					<TD WIDTH="100">Qmail</TD>
					<TD WIDTH="100"><A HREF="http://www.qmail.org">more info</A></TD>
					<TD WIDTH="68%">email messge delivery</TD>
				</TR>
				<TR>
					<TD WIDTH="100">Ezmlm</TD>
					<TD WIDTH="100"><A HREF="http://www.ezmlm.org">more info</A></TD>
					<TD WIDTH="68%">mailing list managerment</TD>
				</TR>
				<TR>
					<TD WIDTH="100">MHonarc</TD>
					<TD WIDTH="100"><A HREF="http://www.mhonarc.org/">more info</A></TD>
					<TD WIDTH="68%">web-based mailing list archive (soon to be <A HREF="http://eyebrowse.tigris.org/">eyebrowse</A>)</TD>
				</TR>
				<TR>
					<TD WIDTH="100">WebMacro</TD>
					<TD WIDTH="100"><A HREF="http://www.webmacro.org/">more info</A></TD>
					<TD WIDTH="68%">servlet framework for template-based web page generation</TD>
				</TR>
				<TR>
					<TD WIDTH="100">Joist</TD>
					<TD WIDTH="100"><A HREF="http://joist.tigris.org/">more info</A></TD>
					<TD WIDTH="68%">servlet framework for membership-based web sites</TD>
				</TR>
				<TR>
					<TD WIDTH="100">Helm</TD>
					<TD WIDTH="100"><A HREF="http://helm.tigris.org/">more info</A></TD>
					<TD WIDTH="68%">servlets for adminstration of tigris machines</TD>
				</TR>
				<TR>
					<TD WIDTH="100">Swish-e</TD>
					<TD WIDTH="100"><A HREF="http://sunsite.berkeley.edu/SWISH-E/">more info</A></TD>
					<TD WIDTH="68%">site-wide search</TD>
				</TR>
				<TR>
					<TD WIDTH="100">Bugzilla</TD>
					<TD WIDTH="100"><A HREF="http://stud.fh-heilbronn.de/~zeller/cgi/cvsweb.cgi/">more info</A></TD>
					<TD WIDTH="68%">web-based bug/issue tracking (soon to be <A HREF="http://scarab.tigris.org/">scarab</A>)</TD>
				</TR>
				<TR>
					<TD WIDTH="100">MySQL</TD>
					<TD WIDTH="100"><A HREF="http://www.mysql.com/">more info</A></TD>
					<TD WIDTH="68%">SQL database</TD>
				</TR>
			</TABLE>
d111 2
a112 2
		</TD>
	</TR>
d118 31
a148 33
	<TR>
		<TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Apache</FONT></STRONG></TD>
	</TR>
	<TR>
		<TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
			<P>Apache serves web page and invokes modules such as mod_jserv.</P>

			<P>Apache is started by '$SANDBOX/scripts/sandboxctl start'</P>

			<P>Apache's config files are rooted at $SANDBOX/conf/httpd.conf and from there the following files are included:</P>
			<UL>
				<LI>$SANDBOX/conf/jserv.conf
				<LI>$SANDBOX/conf/registry.httpd.conf (this file is automatically generated by Makefiles in each sandboxed component
				to build)
				<UL>
					<LI>$SANDBOX/conf/aliases.conf
					<LI>$SANDBOX/bugzilla/bug-track.conf
					<LI>$SANDBOX/cvsweb/src-browse.conf
					<LI>$SANDBOX/search/search.conf
					<LI>$SANDBOX/conf/httpd.conf.helm
					<UL>
						<LI>This file includes other files, see <A HREF="#helm">Helm</A> component discription
					</UL>
				</UL>
			</UL>
			<P>Log files:</P>
			<UL>
				<LI>$SANDBOX/logs/access_log
				<LI>$SANDBOX/logs/error_log
				<LI>$SANDBOX/logs/rewrite_log
			</UL>
		</TD>
	</TR>
d154 30
a183 30
	<TR>
		<TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Jserv</FONT></STRONG></TD>
	</TR>
	<TR>
		<TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
			<P>Jserv invokes java code for servlets based on the URL requested.</P>

			<P>Jserve is started by apache a specified in $SANDBOX/conf/httpd.conf</P>

			<P>Jserve is configured by </P>
			<UL>
				<LI>$SANDBOX/conf/jserv.conf
				<LI>$SANDBOX/conf/jserv.properties
				<LI>$SANDBOX/conf/zone.properties
				<UL>
					<LI>$SANDBOX/conf/registry.servlets (built up via makefiles in sadnboxed components)
					<UL>
						<LI>$SANDBOX/conf/servlets.joist (copied by Makefile from joist/conf)
						<LI>$SANDBOX/conf/servlets.helm (copied by Makefile from helm/conf)
					</UL>
				</UL>
			</UL>
			<P>Log files:</P>
			<UL>
				<LI>$SANDBOX/logs/mod_jserv.log
				<LI>$SANDBOX/logs/jserv.log
			</UL>
			<P>
		</TD>
	</TR>
d189 33
a221 34
	<TR>
		<TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: CVS</FONT></STRONG></TD>
	</TR>
	<TR>
		<TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
			<P><BR>
			CVS manages files that are under version control.</P>

			<P>CVS is invoked via a line in /etc/inetd.conf</P>

			<P>CVS is configured by</P>
			<UL>
				<LI>/etc/inetd.conf
				<LI>$SANDBOX/tigrisq/repository/CVSROOT/*
				<LI>Notable files in CVSROOT include:
				<UL>
					<LI>loginfo: commands to execute when files are checked in
					<LI>cvswrappers: used mainly to indicate which file extensions should be binary
					<LI>config: info needed to connect to MySQL to check permissions
				</UL>
			</UL>
			<P>CVS invokes the log_accum script to send an email message when a commit is done, this is configured in loginfo.</P>

			<P>Customizations:</P>
			<UL>
				<LI>We have customized CVS with a source code patch that is found in $SANDBOX/helm/cvspatch
			</UL>
			<P>Log files:</P>
			<UL>
				<LI>$SANDBOX/tigrisc/repository/CVSROOT/history logs successful transactions
			</UL>
			<P>
		</TD>
	</TR>
d227 18
a244 18
	<TR>
		<TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: CVSWeb</FONT></STRONG></TD>
	</TR>
	<TR>
		<TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
			<P>CVSWeb allows the user to browse CVS managed files and their previous versions.  It also displays log entries
			and it can show a diff of any two versions of a file.</P>

			<P>CVSWeb is a set of CGI scripts invoked via apache.</P>

			<P>CVSWeb is configured with:</P>
			<UL>
				<LI>$SANDBOX/cvsweb/src-browse.conf (apache .conf file)
				<LI>$SANDBOX/cvsweb/cvsweb.conf (cvsweb's own config language)
			</UL>
			<P>No log files.
		</TD>
	</TR>
d250 24
a273 27
	<TR>
		<TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Qmail</FONT></STRONG></TD>
	</TR>
	<TR>
		<TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
			<P>Qmail delivers mail.  The nice thing about qmail is that it processes incoming mail with lots of little config
			files that it finds based on the email address. The first part of the address is considered to be the user name.
			 Then qmail looks in that user's home directory. Then qmail looks for a file named .qmail-blah-blah-blah to match
			the other parts of the incoming mail's recipient name.</P>

			<P>Qmail is run out of tcpserver when mail comes in.</P>

			<P>Qmail is configured via:</P>
			<UL>
				<LI>/var/qmail/control/rcpthosts list all domains for which mail is accepted
				<LI>/var/qmail/control/virtualdomains lists rules to map domsins to local addresses
				<LI>/var/qmail/alias/.qmail-* contains qmail config files to forward mail addressed to special addresses like root
				<LI>$SANDBOX/tigrisq/.qmail-user forwards mail sent to user@@domain
				<LI>$SANDBOX/tigrisq/.qmail-project-user forwards mail sent to user@@project.domain
				<LI>$SANDBOX/tigrisq/.qmail-project-list processes mail sent to list@@project.domain 
			</UL>
			<P>Log files:</P>
			<UL>
				<LI>/var/logs/qmail/*
			</UL>
		</TD>
	</TR>
d279 22
a300 22
	<TR>
		<TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Ezmlm</FONT></STRONG></TD>
	</TR>
	<TR>
		<TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
			<P><BR>
			Ezmlm is a mailing list manager.  Each mailing list actually contains several lists of addresses: subscribers,
			moderators, people explicitly allowed to post, people explicitly prevented from posting. </P>

			<P>Ezmlm provides dozens of commands.  They are invoked via .qmail config files.</P>

			<P>Ezmlm is configured via:</P>
			<UL>
				<LI>$SANDBOX/tigrisq/ezmlmrc file contains templates for all ezmlm mailing list config files
				<LI>$SANDBOX/tigrisq/project-list directory of all information for the given list
			</UL>
			<P>Log files:</P>
			<UL>
				<LI>Mailing list subscriptions and unsubscriptions are logged in $SANDBOX/tigrisq/project-list/Log
			</UL>
		</TD>
	</TR>
d304 29
a332 27
<P><A NAME="Mhonarc"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
	<TR>
		<TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: MHonarc</FONT></STRONG></TD>
	</TR>
	<TR>
		<TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
			<P>MHonarc is a mailnig list archiver.  It has a script called webnewmail that takes an email message as input
			and writes an HTML version of that file as well as index.html and threads.html.  MHonarc is meant to work with
			MH (go UCI!), but it is flexible enough to work with qmail as well.</P>

			<P>The webnewmail script is invoked from $SANDBOX/tigrisq/.qmail-archive-default whenever an email message is sent
			to a mailing list that has a subscription of the form archive-project-list@@domain.</P>

			<P>MHonarc is configured by:</P>
			<UL>
				<LI>$SANDBOX/helm/conf/tigris-mailarchive.mrc (mhonarc's own config language)
				<LI>This should probably be put somewhere better if we keep mhonarc
			</UL>
			<P>Customizations:</P>
			<UL>
				<LI>We have customized MHonarc by changing its source code to make spam-proof email addresses displayed more in
				a more pleasing way, and to make more headers hidden
			</UL>
			<P>No log files.
		</TD>
	</TR>
d336 1
d339 57
a395 25
	<TR>
		<TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: WebMacro</FONT></STRONG></TD>
	</TR>
	<TR>
		<TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
			<P><BR>
			WebMacro is a java library used to generate web pages from templates with embedded expressions.</P>

			<P>WebMacro is invoked by calls to its methods from our java servlets in Joist and Helm.</P>

			<P>WebMacro is configured by:</P>
			<UL>
				<LI>$SANDBOX/conf/WebMacro.properties
			</UL>
			<P>Customizations:</P>
			<UL>
				<LI>We have customized WebMacro to ????
			</UL>
			<P>Log files:</P>
			<UL>
				<LI>$SANDBOX/logs/webmacro-*.log
			</UL>
			<P>
		</TD>
	</TR>
d401 18
a418 36
	<TR>
		<TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Joist</FONT></STRONG></TD>
	</TR>
	<TR>
		<TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
			<P>Joist is a set of java classes used to (1) manage user accounts, roles, and permissions, and (2) serve web pages
			with consistent branding.</P>

			<P>Joist servlets are invoked directly via Jserv. Joist abstract classes provide code that is used from Helm servlets.</P>

			<P>Joist is configured by:</P>
			<UL>
				<LI>$SANDBOX/conf/servlets.joist (put there by make in $SANDBOX/joist/conf)
				<LI>and per-servlet .properties files in $SANDBOX/site/java/org/joist/.../*.properties (put there by make in $SANDBOX/joist/java)
				<LI>webmacro templates in $SANDBOX/site/templates/$BRAND/org/joist/.../*.wm (put there by make in $SANDBOX/joist/templates)
			</UL>
			<P>Database Tables:</P>
			<UL>
				<LI>DeletedUser
				<LI>Message
				<LI>Permission
				<LI>PermissionExtent
				<LI>Role
				<LI>RolePermission
				<LI>User
				<LI>UserRole
				<LI>Database is defined in $SANDBOX/joist/servlets.joist
			</UL>
			<P>Log files:</P>
			<UL>
				<LI>$SANDBOX/logs/webmacro-*.log
				<LI>$SANDBOX/logs/traffic.log.*
			</UL>
			<P>
		</TD>
	</TR>
d422 25
d449 131
a579 81
	<TR>
		<TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Helm</FONT></STRONG></TD>
	</TR>
	<TR>
		<TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
			<P>Helm is a set of java servlets subclassed from the Joist framework.  The goal of Helm is to provide administrative
			functions for a machine running tigris, for example, setting up new users, new projects, new mailing lists, or
			reconfiguring any of these.</P>

			<P>Helm is configured by:</P>
			<UL>
				<LI>$SANDBOX/conf/servlets.helm (put there by make in $SANDBOX/helm/conf)
				<LI>$SANDBOX/conf/httpd.conf.helm (put there by make in $SANDBOX/helm/conf)
				<LI>$SANDBOX/conf/zone.properties.helm (put there by make in $SANDBOX/helm/conf)
				<LI>and per-servlet .properties files in $SANDBOX/site/java/org/tigris/helm/.../*.properties (put there by make in $SANDBOX/helm/java)
				<LI>webmacro templates in $SANDBOX/site/templates/$BRAND/org/tigris/helm/.../*.wm (put there by make in $SANDBOX/helm/templates)
			</UL>
			<P>Database tables:</P>
			<UL>
				<LI>domain_config
				<LI>domain_privs 
				<LI>domain_projects
				<LI>domain_users
				<LI>module_privs
				<LI>module_website
				<LI>project_mlists
				<LI>project_modules
				<LI>project_privs
			</UL>
			<P>Log files:</P>
			<UL>
				<LI>$SANDBOX/logs/webmacro-*.log
			</UL>
			<P>
		</TD>
	</TR>
</TABLE>
</P>

<P><A NAME="Bugzilla"></A>
<TABLE BORDER="0" CELLPADDING="2" WIDTH="98%" BGCOLOR="white">
	<TR>
		<TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: Bugzilla</FONT></STRONG></TD>
	</TR>
	<TR>
		<TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0">
			<P>Bugzilla is feature-rich a bug tracking system developed by the mozilla.org community.</P>

			<P>Bugzilla consists of a set of CGI and perl libraries invoked via apache.</P>

			<P>Bugzilla is configured by:</P>
			<UL>
				<LI>The contents of several database tables (which ones?)
				<LI>The contents of $SANDBOX/bugzilla/data/*
			</UL>
			<P>Database tables:</P>
			<UL>
				<LI>attachments
				<LI>bugs
				<LI>bugs_activity
				<LI>cc
				<LI>components
				<LI>dependencies
				<LI>domain_config
				<LI>groups
				<LI>logincookies
				<LI>products
				<LI>profiles
				<LI>versions         
			</UL>
			<P>Customizations:</P>
			<UL>
				<LI>We have customized Bugzilla to set its colors and fonts by changing some parts of its source code
				<LI>We have changed the way that passwords are generated
				<LI>We have made other security related changes (what exactly?)
			</UL>
			<P></P>

			<P>No log files.
		</TD>
	</TR>
d585 13
a597 9
	<TR>
		<TD WIDTH="100%" BGCOLOR="#CCCC99"><STRONG><FONT COLOR="#000033" FACE="Arial, Helvetica, sans-serif"> Tigris Component: MySQL</FONT></STRONG></TD>
	</TR>
	<TR>
		<TD WIDTH="100%" HEIGHT="100" BGCOLOR="#F0F0F0"><BR>
			<BR>
<BR>
No log files.</TD>
	</TR>
d603 3
a605 1
</HTML>@


1.2
log
@added more detail
@
text
@d413 2
a414 2
				<LI>and per-servlet .properties files in $SANDBOX/site/java/org/helm/.../*.properties (put there by make in $SANDBOX/helm/java)
				<LI>webmacro templates in $SANDBOX/site/templates/$BRAND/org/helm/.../*.wm (put there by make in $SANDBOX/helm/templates)
@


1.1
log
@added new documents and details
@
text
@d348 1
a348 1
				<LI>$SANDBOX/logs/webmacroXXXXXXX.log
d363 12
a374 2
			<P><BR>
			Log files:</P>
d376 9
a384 1
				<LI>$SANDBOX/logs/webmacroXXXXXXX.log
d386 6
d404 5
a408 2
			<P><BR>
			Log files:</P>
d410 5
a414 1
				<LI>$SANDBOX/logs/webmacroXXXXXXX.log
d416 17
d453 15
@


1.1.1.1
log
@Replacing the HEAD with the HELM_PEER_PORT_BRANCH.
@
text
@d348 1
a348 1
				<LI>$SANDBOX/logs/webmacro-*.log
d363 2
a364 12
			<P>Joist is a set of java classes used to (1) manage user accounts, roles, and permissions, and (2) serve web pages
			with consistent branding.</P>

			<P>Joist servlets are invoked directly via Jserv. Joist abstract classes provide code that is used from Helm servlets.</P>

			<P>Joist is configured by:</P>
			<UL>
				<LI>$SANDBOX/conf/servlets.joist (put there by make in $SANDBOX/joist/conf)
				<LI>and per-servlet .properties files in $SANDBOX/site/java/org/joist/.../*.properties (put there by make in $SANDBOX/joist/java)
				<LI>webmacro templates in $SANDBOX/site/templates/$BRAND/org/joist/.../*.wm (put there by make in $SANDBOX/joist/templates)
			</UL>
			<P>Database Tables:</P>
d366 1
a366 9
				<LI>DeletedUser
				<LI>Message
				<LI>Permission
				<LI>PermissionExtent
				<LI>Role
				<LI>RolePermission
				<LI>User
				<LI>UserRole
				<LI>Database is defined in $SANDBOX/joist/servlets.joist
a367 6
			<P>Log files:</P>
			<UL>
				<LI>$SANDBOX/logs/webmacro-*.log
				<LI>$SANDBOX/logs/traffic.log.*
			</UL>
			<P>
d380 2
a381 5
			<P>Helm is a set of java servlets subclassed from the Joist framework.  The goal of Helm is to provide administrative
			functions for a machine running tigris, for example, setting up new users, new projects, new mailing lists, or
			reconfiguring any of these.</P>

			<P>Helm is configured by:</P>
d383 1
a383 5
				<LI>$SANDBOX/conf/servlets.helm (put there by make in $SANDBOX/helm/conf)
				<LI>$SANDBOX/conf/httpd.conf.helm (put there by make in $SANDBOX/helm/conf)
				<LI>$SANDBOX/conf/zone.properties.helm (put there by make in $SANDBOX/helm/conf)
				<LI>and per-servlet .properties files in $SANDBOX/site/java/org/tigris/helm/.../*.properties (put there by make in $SANDBOX/helm/java)
				<LI>webmacro templates in $SANDBOX/site/templates/$BRAND/org/tigris/helm/.../*.wm (put there by make in $SANDBOX/helm/templates)
a384 17
			<P>Database tables:</P>
			<UL>
				<LI>domain_config
				<LI>domain_privs 
				<LI>domain_projects
				<LI>domain_users
				<LI>module_privs
				<LI>module_website
				<LI>project_mlists
				<LI>project_modules
				<LI>project_privs
			</UL>
			<P>Log files:</P>
			<UL>
				<LI>$SANDBOX/logs/webmacro-*.log
			</UL>
			<P>
a404 15
			</UL>
			<P>Database tables:</P>
			<UL>
				<LI>attachments
				<LI>bugs
				<LI>bugs_activity
				<LI>cc
				<LI>components
				<LI>dependencies
				<LI>domain_config
				<LI>groups
				<LI>logincookies
				<LI>products
				<LI>profiles
				<LI>versions         
@


