[Archive-access-cvs] archive-access/projects/wayback/xdocs faq.fml,1.1,1.2

[Brad <bra...@us...>]

Update of /cvsroot/archive-access/archive-access/projects/wayback/xdocs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv12039/xdocs

Modified Files:
	faq.fml 
Log Message:
FEATURE: added basic "what is" answer, added question and answer, "how to install"

Index: faq.fml
===================================================================
RCS file: /cvsroot/archive-access/archive-access/projects/wayback/xdocs/faq.fml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** faq.fml	20 Oct 2005 01:30:37 -0000	1.1
--- faq.fml	26 Oct 2005 01:16:47 -0000	1.2
***************
*** 11,15 ****
        <answer>
          <p>
!         Fill in..
          </p>
        </answer>
--- 11,79 ----
        <answer>
          <p>
!         The project is designed to replace the current Wayback Machine with an
!         all Java solution that is flexible enough to provide an easy-to-use 
!         solution for the single-machine at-home user, as well as scaling up
!         to hundreds of machines for a full historical collection.
!         </p>
!         <p>
!         Primarily it is a few interfaces, and some core classes that utilize 
!         those interfaces to provide the Wayback service. Presently only 
!         trivial implementations of those interfaces have been developed,
!         but we hope that these interfaces will allow a high degree of
!         flexibility and experimentation.
!         </p>
!       </answer>
!     </faq>
!     <faq id="install">
!       <question>
!             How can I install and use this?
!       </question>
!       <answer>
!         <p>
!         The project output is a .WAR file, so it can be used with any servlet
!         container (but it has only been tested on Tomcat on Linux.)
!         </p>
!         <p>
!         Once it is unpacked, there are 5 modifications that can
!         be made to the web.xml file:
!         <table>
!         	<tr>
!         		<td>parameter</td>
!         		<td>description</td>
!         		<td>default</td>
!         	</tr>
!         	<tr>
!         		<td>arcpath</td>
!         		<td>directory where ARC are found</td>
!         		<td><b>/tmp/wayback/arcs</b></td>
!         	</tr>
!         	<tr>
!         		<td>resourceindex.indexpath</td>
!         		<td>directory where index should be stored</td>
!         		<td><b>/tmp/wayback/index</b></td>
!         	</tr>
!         	<tr>
!         		<td>resourceindex.dbname</td>
!         		<td>Name of index within directory</td>
!         		<td><b>DB1</b></td>
!         	</tr>
!         	<tr>
!         		<td>indexpipeline.workpath</td>
!         		<td>directory where temporary files and processing state is stored</td>
!         		<td><b>/tmp/wayback/pipeline</b></td>
!         	</tr>
!         	<tr>
!         		<td>indexpipeline.runpipeline</td>
!         		<td>if set to '1', then new ARC files will be indexed</td>
!         		<td><b>1</b></td>
!         	</tr>
!         </table>
!         </p>
!         <p>
!         	All directories MUST exist before the servlet is initialized. After 
!         	these configurations are set, and the servlet container is running,
!         	the service can be accessed at http://localhost:8080/wayback/. 
!         	Of course, you might be running on a different port, machine, or
!         	ContextPath, so you might need to vary the URL.
          </p>
        </answer>