Read Me

To successfully compile and run tests, you need:

    * Java SDK 6.0 or better (Required for scripting capabilities and enhanded XML parsing.)
    * Latest build of ANT

To build, please type

    ant doc

and read over the Java documentation for any questions.

To run tests, type:

    ant test

And all tests should run properly; any that don't are due to the XML library
embedded in Apache's distribution of ANT.  Those packages will be tested through
a different mechanism - to be decided soon.

If you want to add a new keyfile, do:

    cd ~/bitgate
    keytool -genkey -keystore secureKeys/keystore -keypass unset1 -keyalg RSA -alias unset1
    Fill in the information, keeping the password as "unset1" for now.
        (the password is hard-coded, and will change in a later release.)

To run the server, type:

    sh runServer

The server has been tuned for a system running Java 5 or 6 with 1GB RAM.
Workable documents directory for the server are in "docroot", which should be
very minimal.

--- FIRST CONNECTIONS ON SSL ARE ALWAYS SLOW --- 
Don't be surprised if the first connection hangs for a few seconds.  It's 
because of the SSL stack that has to initialize when the first connection 
is established.

This code may be used in a commercial product, only if you add the following
information to your STARTUP CODE MESSAGE or "ABOUT THIS PROGRAM" message;
at least one of the two must apply.  And they must include the following
verbage:

    THIS CODE CONTAINS CODE WRITTEN BY BITGATE SOFTWARE, LLC. UNDER THE
    CREATIVE COMMONS SHAREALIKE LICENSE VERSION 2.5.  FOR MORE INFORMATION
    REGARDING THIS PROJECT, PLEASE SEE SOURCE CODE.

If you do not include this message in your license, you are BREAKING THE LAW
AND THE TERMS AND CONDITIONS OF THE LICENSE.