File:  [mozdev] / bookie / www / setup.html
Revision 1.3: download - view: text, annotated - select for diffs - revision graph
Sat Jan 20 23:39:01 2001 UTC (18 years, 5 months ago) by will
Branches: MAIN
CVS tags: HEAD
Added password and note to setup.html

    1: 
    2: Setup instructions for Bookie.
    3: <p>
    4: If you're just browsing or don't need to edit files directly, you can look
    5: at Bookie through the <a
    6: href="http://www.mozdev.org/source/browse/bookie/">web interface</a>.
    7: <p>
    8: If you want to contribute to Bookie or compile it, then you should grab a
    9: CVS <a href="www.cvshome.com">client</a> and set up a workspace for bookie.
   10: <p>
   11: 
   12: You download bookie by doing this (you only need to login once, the password
   13: is guest).
   14: 
   15: <pre>
   16:  cvs -d :pserver:guest@mozdev.org:/cvs login
   17:  cvs -d :pserver:guest@mozdev.org:/cvs co bookie
   18: </pre>
   19: 
   20: Note: this only allows you read access: e-mail me if you want to add or modify files.
   21: <p>
   22: After doing this, you'll see files in the workspace.  The Java server will
   23: compile, but I use a custom made tool which pretty much no-one else uses, so
   24: you may want to try putting it together with ANT.
   25: <p>
   26: The Java server talks to a database on the backend.  I use <a
   27: href="http://www.solidtech.com">Solid</a>, but any JDBC compliant driver
   28: should work (I don't use any complicated SQL).  You can edit the JDBC
   29: driver: it's defined in bookie.properties in the scripts directory.
   30: <p>
   31: The database DDL scripts are in the /sql/solid directory.  They work fine
   32: for me... again, if you're using another database, you probably want to
   33: tweak these.  Any additions are welcomed.
   34: <p>
   35: The database needs data in order to work.  I wrote /scripts/import.pl which
   36: takes in my bookmarks.html file from Netscape and pumps it into the
   37: database.  It actually relies on a couple of none standard modules which you
   38: may need to download from ActivePerl or CPAN.
   39: <p>
   40: 
   41: After you've started the database, and compiled the Java, you probably want
   42: to add a couple of things to your classpath.  In the /lib directory, I've
   43: added some JAR files which are needed by Bookie to work.  After adding those
   44: files (and the JDBC driver, if it's not already included), you can start the
   45: server by using /scripts/server.bat.
   46: 
   47: <p>
   48: There is a very simple client available which I have been using for
   49: debugging.  You can run the client by using /scripts/client.bat.  It's good
   50: enough to send text to the server and get a response back, which is all I
   51: really need from it.  I'm divided as to how much time I should spend on,
   52: since working on the client would take time away from working on the Mozilla
   53: integration.
   54: 
   55: <p>
   56: The mozilla integration is in a sorry state.  The basic problem is that I
   57: don't understand Javascript, and I only have a hazy idea of the way that
   58: Mozilla organizes their network code.  As a result, I've spent much time
   59: flailing around trying to get some very simple things trying to work.
   60: Again, any assistance is appreciated.
   61: 
   62: <p>
   63: If these directions are unclear or confusing, please e-mail me at <a href="mailto:will_sargent@yahoo.com">will_sargent@yahoo.com</a>

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