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

version 1.1, 2001/01/20 23:33:37 version 1.14, 2003/04/14 07:42:47
Line 1 Line 1
 Setup instructions for Bookie.  
 If you're just browsing or don't need to edit files directly, you can look  
 at Bookie through the <a  
 href="http://www.mozdev.org/source/browse/bookie/">web interface</a>.  
 If you want to contribute to Bookie or compile it, then you should grab a  
 CVS <a href="www.cvshome.com">client</a> and set up a workspace for bookie.  
  cvs -d :pserver:guest@mozdev.org:/cvs login  
  cvs -d :pserver:guest@mozdev.org:/cvs co bookie  
 After doing this, you'll see files in the workspace.  The Java server will  
 compile, but I use a custom made tool which pretty much no-one else uses, so  
 you may want to try putting it together with ANT.  
 The Java server talks to a database on the backend.  I use <a  
 href="http://www.solidtech.com">Solid</a>, but any JDBC compliant driver  
 should work (I don't use any complicated SQL).  You can edit the JDBC  
 driver: it's defined in bookie.properties in the scripts directory.  
 The database DDL scripts are in the /sql/solid directory.  They work fine  
 for me... again, if you're using another database, you probably want to  
 tweak these.  Any additions are welcomed.  
 The database needs data in order to work.  I wrote /scripts/import.pl which  
 takes in my bookmarks.html file from Netscape and pumps it into the  
 database.  It actually relies on a couple of none standard modules which you  
 may need to download from ActivePerl or CPAN.  
 After you've started the database, and compiled the Java, you probably want  
 to add a couple of things to your classpath.  In the /lib directory, I've  
 added some JAR files which are needed by Bookie to work.  After adding those  
 files (and the JDBC driver, if it's not already included), you can start the  
 server by using /scripts/server.bat.  
 There is a very simple client available which I have been using for  
 debugging.  You can run the client by using /scripts/client.bat.  It's good  
 enough to send text to the server and get a response back, which is all I  
 really need from it.  I'm divided as to how much time I should spend on,  
 since working on the client would take time away from working on the Mozilla  
 The mozilla integration is in a sorry state.  The basic problem is that I  
 don't understand Javascript, and I only have a hazy idea of the way that  
 Mozilla organizes their network code.  As a result, I've spent much time  
 flailing around trying to get some very simple things trying to work.  
 Again, any assistance is appreciated.  
 If these directions are unclear or confusing, please e-mail me at <a href="mailto:will_sargent@yahoo.com">will_sargent@yahoo.com</a>  
   Setup instructions for compiling and running Bookie:
   <p>If you're just browsing or don't need to edit files directly, you
   can look at Bookie through the <a
    href="http://www.mozdev.org/source/browse/bookie/">web interface</a>. </p>
   <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.</p>
   <p>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>
   <code> cvs -d :pserver:guest@mozdev.org:/cvs login <br>
   </code> <code>cvs -d :pserver:guest@mozdev.org:/cvs co bookie -dP<br>
   <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>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>
     <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>
   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>Please e-mail me at <a href="mailto:will_sargent@yahoo.com">will_sargent@yahoo.com</a>
   if you have any problems.<br>

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

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