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