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

version 1.9, 2002/05/16 04:29:59 version 1.14, 2003/04/14 07:42:47
Line 1 Line 1
 Setup instructions for compiling and running Bookie:  Setup instructions for compiling and running Bookie:
<p>If you're just browsing or don't need to edit files directly, you
<p>can look at Bookie through the <a
If you're just browsing or don't need to edit files directly, you can look href="http://www.mozdev.org/source/browse/bookie/">web interface</a>. </p>
at Bookie through the <a<p>If you want to contribute to Bookie or compile it, then you should
href="http://www.mozdev.org/source/browse/bookie/">web interface</a>.grab a CVS <a href="http://www.cvshome.com">client</a> and set up a
workspace for bookie.</p>
<p><p>You download bookie by doing this (you only need to login once, the
If you want to contribute to Bookie or compile it, then you should grab apassword is guest).  Please use the prune option when checking out and
CVS <a href="http://www.cvshome.com">client</a> and set up a workspace for bookie.updating, since the CVS tree has a lot of dead branches in it.</p>
 <code> cvs -d :pserver:guest@mozdev.org:/cvs login <br>
 </code> <code>cvs -d :pserver:guest@mozdev.org:/cvs co bookie -dP<br>
 </code>
 <p>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.&nbsp; The client's main class is <code>com.tersesystems.bookie.client.Client</code>.<br>
 </p>
 <p>The java server is in <code>/server</code>.  Again, the <a
  href="http://jakarta.apache.org/ant">ant</a> script that should compile
 everything.  The server's main class is <code>com.tersesystems.bookie.service.xmlrpc.BookieServlet</code>.</p>
 <p> The server will create four files on initialization in the current
 directory: </p>
 <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> </p>
 <p> Bookmarks are cached on the server, but since bookmarks are unique
 to   each client this isn't that much of a win.  Performance seems okay
 for now    (and if anything seems bound on the XML    processing and IO
 overhead).  Database operations are not transactional.<br>
 </p>  </p>
<p>Please e-mail me at <a href="mailto:will_sargent@yahoo.com">will_sargent@yahoo.com</a>
<p>if you have any problems.<br>
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> 
 cvs -d :pserver:guest@mozdev.org:/cvs login 
 cvs -d :pserver:guest@mozdev.org:/cvs co bookie -P 
</pre> 
 
<p> 
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 java server is in <code>/server</code>.  Again, the 
<a href="http://jakarta.apache.org/ant">ant</a> script that should compile 
everything.  The server currently depends on JTidy, Marquee XML-RPC,  
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> 
  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> 
 
<p> 
  The server also starts up with a large amount of debugging information.  You can 
  override the default configuration by specifying the log4j configuration file on 
  the command line with <code>-Dlog4j.configuration=minimal.txt</code> where the  
  file <code>minimal.txt</code> contains the following: 
</p> 
 
<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> 
  The server does not attempt to limit multiple logins on the same account 
  from different servers.  However, care should be taken with this feature, 
  as there is no facility to distribute messages between clients that a  
  branch has been deleted.   
</p> 
 
<p> 
  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>  </p>

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


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