Cofax logo

Welcome to the web site 
AboutTechnologyDownloadCofax in ActionContactsDevelopmentDocumentationSite map
> Home > Documentation > Developer Setup /

Developer Setup

Note that these instructions are geared towards a Windows development environment. They can be modified to suit your needs..


> Install MySQL

Cofax is designed for database independence. It can be ported far easier to new database platforms in comparison to other CMS products. We use MySQL as our reference implementation.

  • Run [MySQL INstall Directory]\bin\winmysqladmin.exe
  • Confirm that you can connect to the database.


> Edit Development Environment Variables

Edit se.bat (in your Cofax home) and set TOMCAT_HOME to the directory you installed Tomcat into, set MYSQL_HOME to the directory you installed MySQL into, and ANT_HOME to the directory you installed Ant into.


> How to Join the Cofax Team

As is open source tradition: We welcome anyone checking out the latest code from CVS, emailing us patches, posting bugs, and sharing in the forums. But if you wish to contribute code to CVS, or help us in any other capacity on a regular basis, please join our team. We want and need your help!


> Install the Eclipse IDE

We use Eclipse as our standard IDE.

  • Download Eclipse from a mirror site.
  • Extract it into the directory you intend to run it from.
  • Run and shutdown Eclipse one time so that it can initialize.
  • Create a root workspace directory where you intend to manage your projects and checkout files from CVS into.
  • Change its Windows shortcut to launch Eclipse using this directory by include a parameter on the end of it's target: -data [CVS work directory]. I.E.: D:\usr\local\eclipse\eclipse.exe -data d:\workspace.
  • Run Eclipse and change to the Resource Perspective.
  • Change to the CVS Repository Perspective.
  • Add a new CVS Repository location: If you are a Cofax team member:, Repository Path=/cvsroot/cofax, User=Your sourceforge user name, Password=Your Sourceforge password, Connection Type=extssh and leave everything else as is. It will connect on saving. If not right click and choose Refresh View. If you are not a Cofax team member:, Repository Path=/cvsroot/cofax, User=anonymous, Password=leave blank, Connection Type=pserver and leave everything else as is. It will connect on saving. If not right click and choose Refresh View.
  • Open the HEAD node. Choose the Cofax folder. Right click and choose Check Out As...
  • Choose "Check out as project in the workspace" and take the default name of "cofax". Click the Finish button.
  • Change to the Java Perspective. You should have the cofax project navigatable in the Package Explorer and be able to browse the src, apps, and lib trees.
  • As you edit Java classes under src, Eclipse will recompile your changes instantly and flag errors for you. It will also notify you of bad Java practices such as unncessary imports or refering to static members in a non-static fashion.


> Create developer environment

This directory structure will be used in the following steps.

  • Create d:\usr
  • Create d:\usr\bin
  • Create d:\usr\home
  • Create d:\usr\local
  • Create d:\home
  • Create d:\home\projects
  • Add d:\usr\bin to your PATH env variable.
  • Create a HOME env variable and point d:\home


    > Install Apache Ant

    This tool we use to compile and build Cofax.

  • Install to d:\usr\local\ant.
  • Set ANT_HOME env variable to equal install directory.
  • Add "d:\usr\local\ant\bin" to PATH env variable.
  • Test ant from a command prompt.


    > Install latest Sun JDK

  • Set JAVA_HOME env variable to equal the install directory. i.e. JAVA_HOME=c:\jdk1.4\
  • Add c:\jdk1.3\bin to PATH env variable.
  • Test javac and java from a command prompt.


    > Install Jakarta Tomcat

    Cofax will run on most servlet containers. We've been very satisfied with Tomcat in most situations.

  • Install to d:\usr\local\tomcat
  • Set TOMCAT_HOME env variable to this directory
  • Run d:\usr\local\tomcat\bin\startup.bat from a command prompt.
  • Go to http://localhost:8080/ and run examples.
  • Run d:\usr\local\tomcat\bin\shutdown.bat from a command prompt.


    Powered by Cofax - Please see for more information.

    Valid HTML 4.01!    Valid CSS!