venice-main-classic/INSTALL

INSTALLATION INSTRUCTIONS
-------------------------

Software requirements:
    You must install the following software on your system:

    * Java 2 SDK version 1.2.2.  Venice is normally run with the Blackdown
      JDK port, available at http://www.blackdown.org.  Version 1.3.0 is
      being tested, and will likely be required sometime in the future.
    * Java API for XML Parsing (JAXP) version 1.0.1, available from
      http://java.sun.com.
    * Java Secure Socket Extension (JSSE) version 1.0.2, available from
      http://java.sun.com.  (Venice does not (yet) require this, but Apache
      Tomcat does.)
    * JavaMail API version 1.2, available from http://java.sun.com.
    * JavaBeans Activation Framework (JAF) version 1.0.1, available from 
      http://java.sun.com.  (Required by JavaMail.)
    * Apache Jakarta LOG4J library 1.0.x, available from
      http://jakarta.apache.org.
    * MySQL 3.23.x (get the most recent 3.23 version), available from
      http://www.mysql.com.
    * The MM.MySQL JDBC drivers version 2.0.3, available from XXXX.
    * Apache Jakarta Ant, version 1.2, available from
      http://jakarta.apache.org.
    * Apache Jakarta Servlet API, version 3.2, available from
      http://jakarta.apache.org.
    * Apache Tomcat version 3.2.1, available from http://jakarta.apache.org.

    It is recommended that you install JAXP, JSSE, JavaMail, JAF, and LOG4J
    by copying or symbolically linking their JAR files to the <jdk>/jre/lib/ext
    directory, to avoid creating a huge CLASSPATH variable.  The JDK /bin
    subdirectory should be in your PATH, naturally.

    You should have access to a mail server that can relay e-mail messages
    from the host on which Tomcat will be running.  (If it's the same host,
    so much the better.)

Setting Up:
    After extracting the source from CVS, you will need to choose your
    deployment directory.  This will need to be specified as the "deploy.home"
    property in the build.xml file.  In addition, the three main Venice
    configuration files (logging-config.xml, render-config.xml, and
    venice-config.xml) are all copied to the WEB-INF subdirectory of the
    deployment directory, and three parameters in web.xml point to them, so
    those parameters will have to be modified.

    Also modify the three configuration files to suit your system layout.
    Each file is reasonably commented, so you should be able to figure it out
    based on your directory location and your Tomcat configuration.

    The database.sql file's "grant privileges" section may also need to be
    modified to suit your tastes.  Make sure though, that the Venice database
    username and password match those specified in venice-config.xml, or
    nothing will work.

    Finally, in the setup directory, the files context-add.xml and
    tomcat.policy.add contain snippets to be added to your Tomcat server.xml
    and tomcat.policy files, respectively.  These also need to be modified
    as necessary.  (Yes, I know the policy should not be granting AllPermission
    to the entire server application.  This will be fixed later, once I know
    exactly what permissions are required.)

    Create the Venice database by using the command:

    mysql -u root -p < setup/database.sql

    and type your MySQL root password when prompted.  If your database gets
    horked, this command will reset it to its "pristine" state as well.

    Now start Tomcat in the usual way, and point your Web browser at the
    URL "http://<servername>:<port>/venice/top".  If all goes well, you will
    see the Venice "top level" page pop up in your browser.  (It'll take a
    minute or so the first time, as the classes all get loaded and some of
    the JSPs compile for the first time.)