Diff for /bookie/www/setup.html between versions 1.8 and 1.9

version 1.8, 2001/03/26 08:02:09 version 1.9, 2002/05/16 04:29:59
Line 1 Line 1
Setup instructions for Bookie:Setup instructions for compiling and running Bookie:
   
 <p>  <p>
 If you're just browsing or don't need to edit files directly, you can look  If you're just browsing or don't need to edit files directly, you can look
 at Bookie through the <a  at Bookie through the <a
 href="http://www.mozdev.org/source/browse/bookie/">web interface</a>.  href="http://www.mozdev.org/source/browse/bookie/">web interface</a>.
   
<p>If you want to contribute to Bookie or compile it, then you should grab a<p>
 If you want to contribute to Bookie or compile it, then you should grab a
 CVS <a href="http://www.cvshome.com">client</a> and set up a workspace for bookie.  CVS <a href="http://www.cvshome.com">client</a> and set up a workspace for bookie.
   </p>
   
<p>You download bookie by doing this (you only need to login once, the password<p>
is guest).You download bookie by doing this (you only need to login once, the password
 is guest).  Please use the prune option when checking out and updating, since
 the CVS tree has a lot of dead branches in it.
 </p>
   
 <pre>  <pre>
  cvs -d :pserver:guest@mozdev.org:/cvs login   cvs -d :pserver:guest@mozdev.org:/cvs login
 cvs -d :pserver:guest@mozdev.org:/cvs co bookie cvs -d :pserver:guest@mozdev.org:/cvs co bookie -P
 </pre>  </pre>
   
<p>You need to have a database set up with a database schema.  Look in<p>
./sql/solid for an example schema.  The java client is in <code>/clients/swing</code>.  There is an
 <a href="http://jakarta.apache.org/ant">ant</a> script that should compile
 everything.  The client depends on Jena, Apache XML-RPC, Log4J and Xerces.
 All the libraries should be available in lib.  The client's main class is
 <code>com.tersesystems.bookie.client.Client</code>.
 </p>
   
<p>The database needs data in order to work.  I wrote /scripts/import.pl<p>
which takes in my bookmarks.html file from Netscape and pumps it into theThe java server is in <code>/server</code>.  Again, the
database.  The script relies on <code>HTML::Filter</code> and<a href="http://jakarta.apache.org/ant">ant</a> script that should compile
<code>HTML::TokeParser</code>, which you may need to download fromeverything.  The server currently depends on JTidy, Marquee XML-RPC, 
ActivePerl or CPAN.Jisp, Servlet 2.2, Log4J, and Xerces, which are all available in lib.  The
 server's main class is <code>com.tersesystems.bookie.service.xmlrpc.BookieServlet</code>.
 </p>
   
<p> You can start the server from the root directory with: <p>
   The server will create four files on initialization in the current directory:
   <ul>
     <li>profile.db - a database of profile information.</li>
     <li>profile.idx - an index of profile.db</li>
     <li>bookmarks.db - a database of bookmarks information.</li>
     <li>bookmarks.idx - an index of bookmarks.db</li>
   </ul>
   These databases contain all the information needed for the server to work.  Deleting
   these files will cause the server to start off fresh.  
 </p>
   
<blockquote><p>
<code>java bookie.xmlrpc.BookieServer -Dbookie.logging=./scripts/logging.properties  The server also starts up with a large amount of debugging information.  You can
-Dbookie.database=./scripts/database.properties</code><br>  override the default configuration by specifying the log4j configuration file on
</blockquote>  the command line with <code>-Dlog4j.configuration=minimal.txt</code> where the 
   file <code>minimal.txt</code> contains the following:
 </p>
   
<p>There's an Ant script in ./scripts/ which handles compilation and testing.<pre>
     # Set root logger level to INFO and its only appender to A1.
     log4j.rootLogger=INFO, A1
       
     # A1 is set to be a ConsoleAppender. 
     log4j.appender.A1=org.apache.log4j.ConsoleAppender
       
     # A1 uses PatternLayout.
     log4j.appender.A1.layout=org.apache.log4j.PatternLayout
     log4j.appender.A1.layout.ConversionPattern=%-4r [%t] %-5p %c %x - %m%n
 </pre>
   
<p>Right now, the only way you get useful data is with the test class<p>
<code>ClientTest</code>, which reads in the RDF to a memory model and writes  The server does not attempt to limit multiple logins on the same account
out the answer to some queries (like 'what children does the root node  from different servers.  However, care should be taken with this feature,
have?').  More is on the way.  as there is no facility to distribute messages between clients that a 
   branch has been deleted.  
 </p>
   
 <p>  <p>
Will.  No caching or pre-loading of bookmarks is performed on the server, but
   performance seems okay for now (and if anything seems bound on the XML 
   processing and IO overhead).  Database operations are not transactional.
 </p>

Removed from v.1.8  
changed lines
  Added in v.1.9


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>