Annotation of bookie/www/setup.html, revision 1.1
1.1 ! will 1:
! 2: Setup instructions for Bookie.
! 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>.
! 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.
! 11: cvs -d :pserver:firstname.lastname@example.org:/cvs login
! 12: cvs -d :pserver:email@example.com:/cvs co bookie
! 14: After doing this, you'll see files in the workspace. The Java server will
! 15: compile, but I use a custom made tool which pretty much no-one else uses, so
! 16: you may want to try putting it together with ANT.
! 18: The Java server talks to a database on the backend. I use <a
! 19: href="http://www.solidtech.com">Solid</a>, but any JDBC compliant driver
! 20: should work (I don't use any complicated SQL). You can edit the JDBC
! 21: driver: it's defined in bookie.properties in the scripts directory.
! 23: The database DDL scripts are in the /sql/solid directory. They work fine
! 24: for me... again, if you're using another database, you probably want to
! 25: tweak these. Any additions are welcomed.
! 27: The database needs data in order to work. I wrote /scripts/import.pl which
! 28: takes in my bookmarks.html file from Netscape and pumps it into the
! 29: database. It actually relies on a couple of none standard modules which you
! 30: may need to download from ActivePerl or CPAN.
! 32: After you've started the database, and compiled the Java, you probably want
! 33: to add a couple of things to your classpath. In the /lib directory, I've
! 34: added some JAR files which are needed by Bookie to work. After adding those
! 35: files (and the JDBC driver, if it's not already included), you can start the
! 36: server by using /scripts/server.bat.
! 38: There is a very simple client available which I have been using for
! 39: debugging. You can run the client by using /scripts/client.bat. It's good
! 40: enough to send text to the server and get a response back, which is all I
! 41: really need from it. I'm divided as to how much time I should spend on,
! 42: since working on the client would take time away from working on the Mozilla
! 43: integration.
! 45: The mozilla integration is in a sorry state. The basic problem is that I
! 47: Mozilla organizes their network code. As a result, I've spent much time
! 48: flailing around trying to get some very simple things trying to work.
! 49: Again, any assistance is appreciated.
! 51: If these directions are unclear or confusing, please e-mail me at <a href="mailto:firstname.lastname@example.org">email@example.com</a>