forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From brond...@apache.org
Subject svn commit: rev 30798 - forrest/trunk/src/documentation/content/xdocs/docs
Date Tue, 27 Jul 2004 20:16:43 GMT
Author: brondsem
Date: Tue Jul 27 13:16:42 2004
New Revision: 30798

Modified:
   forrest/trunk/src/documentation/content/xdocs/docs/forrestbot-web-interface.xml
Log:
add requirements; other improvements

Modified: forrest/trunk/src/documentation/content/xdocs/docs/forrestbot-web-interface.xml
==============================================================================
--- forrest/trunk/src/documentation/content/xdocs/docs/forrestbot-web-interface.xml	(original)
+++ forrest/trunk/src/documentation/content/xdocs/docs/forrestbot-web-interface.xml	Tue Jul
27 13:16:42 2004
@@ -22,13 +22,10 @@
   </header>
 
   <body>
-    <p>This webapp implements a website staging application for sites built
-    with Apache Forrest. The webapp hosts HTML for a number of managed
-    websites. The user can regenerate these sites at will. Once the user is
-    satisfied with the site, they may 'deploy' the site, making it live.</p>
-
-    <p>The forrestbot web interface requires a servlet container such as <link
-    href="http://jakarta.apache.org/tomcat/">Apache Tomcat</link>.</p>
+    <p>This webapp implements a website staging application for sites built with
+    Apache Forrest. The webapp hosts HTML for a number of managed websites. The
+    user can regenerate these sites at will. Once the user is satisfied with the
+    site, they may 'deploy' the site, making it live.</p>
 
     <section>
       <title>Build</title>
@@ -40,46 +37,68 @@
     </section>
 
     <section>
-      <title>Installation</title>
+      <title>Requirements</title>
 
-      <note>Most of this configuration is related to the <link
-      href="http://www.opensymphony.com/osuser/">OpenSymphony OSUser</link>
-      authentication layer.</note>
+      <ul>
+        <li>Forrest</li>
 
-      <ol>
-        <li>Extract the war to a temporary directory</li>
+        <li>A servlet container such as <link
+        href="http://jakarta.apache.org/tomcat">Apache Tomcat</link></li>
 
-        <li>Modify welcome.local.html</li>
+        <li>Directories for:</li>
 
-        <li>Modify osuser.xml if you want to use an authenticator other than
-        XML files</li>
+        <ul>
+          <li>forrestbot buildfiles</li>
 
-        <li>Modify projects.xml, groups.xml, and users.xml according to your
-        needs</li>
+          <li>source and working files</li>
 
-        <li>Modify settings.properties according to the server's specific
-        setup</li>
+          <li>log files</li>
 
-        <li>Repackage the war file</li>
+          <li>built websites (this is not their deployed location)</li>
+        </ul>
 
-        <li>Deploy the war file in Tomcat or some other servlet container</li>
-      </ol>
+        <li>A webserver to view the sites in the build directory</li>
+      </ul>
+
+      <p>The server does not need local access to the sites' source nor final
+      deployed location. The buildfiles configure the transfer of those
+      files.</p>
     </section>
 
     <section>
-      <title>TODO Wishlist</title>
+      <title>Installation</title>
 
-      <ul>
-        <li>seperate authorization of 'build' and 'deploy'</li>
+      <note>Most of this configuration is related to the <link
+      href="http://www.opensymphony.com/osuser/">OpenSymphony OSUser</link>
+      authentication layer.</note>
 
-        <li>log everything, not just the build</li>
+      <ol>
+        <li>Extract the war to an empty directory</li>
 
-        <li>view old log files</li>
+        <li>Modify welcome.local.html</li>
 
-        <li>ability to reload all config files on the fly</li>
+        <li>Modify WEB-INF/classes/osuser.xml if you want to use an
+        authenticator other than XML files</li>
 
-        <li>put date at top of viewlog_body page</li>
-      </ul>
+        <li>Modify projects.xml, groups.xml, and users.xml (all in
+        WEB-INF/classes) according to your needs</li>
+
+        <li>Optionally modify logging via WEB-INF/classes/log4j.properties</li>
+
+        <li>Modify WEB-INF/classes/settings.properties according to the server's
+        specific setup</li>
+
+        <li>Deploy the webapp in Tomcat or some other servlet container (you may
+        want to repackage the war file)</li>
+
+        <li>Make sure tomcat has permissions to write in forrestbot's build,
+        work, and log directories.</li>
+      </ol>
+
+      <p>Optional: set up "cron jobs" to execute forrestbot. This is completely
+      independant of the forrestbot web interface, but is often useful. A
+      suggested practice is to build the sites regularly and deploy them as
+      desired through the web interface.</p>
     </section>
 
     <section>
@@ -88,16 +107,22 @@
       <section>
         <title>The build and/or deploy commands don't seem to work</title>
 
+        <warning>The only environment variable available is FORREST_HOME, which
+        is set by forrest-home in the settings.properties file. Use a wrapper
+        script (see below) if you need other environment variables.</warning>
+
         <p>Currently forrestbot only logs the forrest part of it's execution,
         not the whole thing. And the web interface starts a forrestbot process
-        and doesn't watch it's progress directly. So look at the debugging
-        output for the command executed and the working directory used. Log
-        into the server using the login of the Tomcat server and cd to the
-        working directory and then execute the command. This will fairly
-        accurately simulate what the web interface does.</p>
+        and doesn't watch it's progress directly.</p>
 
-        <p>Also, set debug-exec=true in settings.properties and make sure
-        log4j.properties logs DEBUG. This will log all the thread output.</p>
+        <p>Set debug-exec=true in settings.properties and make sure
+        log4j.properties logs at the DEBUG level. This will log all the thread
+        output.</p>
+
+        <p>Then look at the debugging output for the command executed and the
+        working directory used. Log into the server as the use the Tomcat server
+        uses and cd to the working directory and then execute the command. This
+        will fairly accurately simulate what the web interface does.</p>
       </section>
 
       <section>
@@ -109,16 +134,13 @@
 
         <source>#!/bin/bash
 
-# remove env values set from container 
-PATH=/usr/bin
-CLASSPATH=
 # get env vars
 . /home/user/.profile
 
 # group writable for easier sharing of files with others who run forrestbot
 umask g+w
 
-# you can preprocess something
+# you can preprocess something here
 xmlfile=$2
 if [ "${xmlfile##*.}" = "xml" ]                # everything after last .
 then
@@ -138,6 +160,22 @@
 
 # you can postprocess something here</source>
       </section>
+    </section>
+
+    <section>
+      <title>TODO Wishlist</title>
+
+      <ul>
+        <li>seperate authorization of 'build' and 'deploy'</li>
+
+        <li>log everything, not just the build</li>
+
+        <li>view old log files</li>
+
+        <li>ability to reload all config files on the fly</li>
+
+        <li>put date at top of viewlog_body page</li>
+      </ul>
     </section>
   </body>
 </document>

Mime
View raw message