File:  [mozdev] / bookie / www / setup.html
Revision 1.14: download - view: text, annotated - select for diffs - revision graph
Mon Apr 14 07:42:47 2003 UTC (16 years, 1 month ago) by will
Branches: MAIN
CVS tags: HEAD
Make the setup page at least not have horrible errors in it.

    1: Setup instructions for compiling and running Bookie:
    2: <p>If you're just browsing or don't need to edit files directly, you
    3: can look at Bookie through the <a
    4:  href="http://www.mozdev.org/source/browse/bookie/">web interface</a>. </p>
    5: <p>If you want to contribute to Bookie or compile it, then you should
    6: grab a CVS <a href="http://www.cvshome.com">client</a> and set up a
    7: workspace for bookie.</p>
    8: <p>You download bookie by doing this (you only need to login once, the
    9: password is guest).  Please use the prune option when checking out and
   10: updating, since the CVS tree has a lot of dead branches in it.</p>
   11: <code> cvs -d :pserver:guest@mozdev.org:/cvs login <br>
   12: </code> <code>cvs -d :pserver:guest@mozdev.org:/cvs co bookie -dP<br>
   13: </code>
   14: <p>The java client is in <code>/clients/swing</code>.  There is an <a
   15:  href="http://jakarta.apache.org/ant">ant</a> script that should compile
   16: everything.&nbsp; The client's main class is <code>com.tersesystems.bookie.client.Client</code>.<br>
   17: </p>
   18: <p>The java server is in <code>/server</code>.  Again, the <a
   19:  href="http://jakarta.apache.org/ant">ant</a> script that should compile
   20: everything.  The server's main class is <code>com.tersesystems.bookie.service.xmlrpc.BookieServlet</code>.</p>
   21: <p> The server will create four files on initialization in the current
   22: directory: </p>
   23: <ul>
   24:   <li>profile.db - a database of profile information.</li>
   25:   <li>profile.idx - an index of profile.db</li>
   26:   <li>bookmarks.db - a database of bookmarks information.</li>
   27:   <li>bookmarks.idx - an index of bookmarks.db</li>
   28: </ul>
   29: These databases contain all the information needed for the server to
   30: work.  Deleting   these files will cause the server to start off fresh.
   31: <p> </p>
   32: <p> Bookmarks are cached on the server, but since bookmarks are unique
   33: to   each client this isn't that much of a win.  Performance seems okay
   34: for now    (and if anything seems bound on the XML    processing and IO
   35: overhead).  Database operations are not transactional.<br>
   36: </p>
   37: <p>Please e-mail me at <a href="mailto:will_sargent@yahoo.com">will_sargent@yahoo.com</a>
   38: if you have any problems.<br>
   39: </p>

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