TransferCM README
-----------------

OVERVIEW

  TransferCM is a web content management system, enabling
  administrators to add and organize pages, update content, manage
  files, and manage users for multiple sites.

PREREQUISITES

  We're assuming you have:

    1. a working application server

    2. a working database, accepting TCP/IP connections, with a known
       username and password

    3. an appropriate JDBC driver for your database in your JVM's
       classpath

  We've tested this software on these operating systems:

    * Debian Linux 3.0
    * Windows Server 2000
    * Windows Server 2003

  with this JVM:

    * Java 2 SDK 1.4.x

  and these databases:

    * PostgreSQL 7.4
    * MySQL 4.0
    * SQL Server 2000

  and this app server:

    * Jakarta Tomcat 4.1.x

  IMPORTANT:

    To support image thumbnailing, UNIX installations should
    run a "headless" JVM by passing the java.awt.headless=true parameter
    to the JVM.

    There are several ways to do this; one way is to set the CATALINA_OPTS
    environment variable:

      CATALINA_OPTS="-Djava.awt.headless=true"

INSTALLATION

  Between Tomcat, Apache and mod_jk, you've got a lot of choices about how to
  configure your server.  The instructions below describe a basic set to get you
  started.  See PLATFORM NOTES below for more information on other platforms.

  1. Stop Tomcat if its running.

  2. Install TransferCM as the ROOT webapp:

    # cd $CATALINA_HOME/webapps
    # mv ROOT ROOT.bak
    # unzip ~/transfercm-1.2.zip
    # mv transfercm-1.2 ROOT

    IMPORTANT:

      During normal operation, files will be created and updated under
      ROOT.  Make sure the user running your application server has write
      permission on this directory and its contents.

  3. Create a database for TransferCM and apply the schema:

    # createdb -E LATIN1 transfercm
    # psql transfercm<ROOT/WEB-INF/db/transfer-schema.sql

  4. Create and update db.properties with settings appropriate for your
     database:

    # cd ROOT/WEB-INF
    # cp db.properties.sample db.properties
    # vi db.properties

  5. Create and update mail.properties with settings appropriate for your
     mail server:

    # cp mail.properties.sample mail.properties
    # vi mail.properties

  6. Start Tomcat.

  7. Initialize the database by browsing to:

    http://YOURHOST:8080/approot/init.jsp

  8. Login to TransferCM by browsing to:

    http://YOURHOST:8080/home.do

  9. Download and install the demo site.  Find the download where you found
     this software.

PLATFORM NOTES

  MySQL

    1.  Create the database as follows:

      # mysqladmin create transfercm
      # mysql transfercm<ROOT/WEB-INF/db/transfer-schema.sql

  SQL Server

    1.  SQL Server uses a different data type for time stamps.   Be
        sure to use transfer-schema-sqlserver.sql when setting up the
        database.

  Apache with mod_jk

    Apache can be configured to work with Tomcat using mod_jk.  You
    can then take advantage of Apache's configuration options or integrate
    other Apache modules (i.e., mod_php).

    The details of this configuration are not discussed here, however
    here is a sample VirtualHost configuration for a TransferCM application
    assuming a jk worker named "local":

      <VirtualHost YOUR_IP:80>
        ServerName   YOUR_HOSTNAME
        ServerAdmin  webmaster@methodhead.com
        DocumentRoot /var/webapps/YOUR_HOSTNAME/ROOT
        ErrorLog     /var/log/apache/YOUR_HOSTNAME-error.log
        CustomLog    /var/log/apache/YOUR_HOSTNAME-access.log common

        JkMount /* local

        <Directory /var/webapps/YOUR_HOSTNAME/ROOT/plugins/InlineSpellChecker>
          Options ExecCGI
          AddHandler cgi-script .cgi
        </Directory>
      </VirtualHost>