Building system from sources

How to setup build system - dependencies and core modules building.

Preparations

First of all install Java SDK, version 1.5.0 or higher.

http://java.sun.com/j2se/1.5.0/download.jsp

Be sure you have set $JAVA_HOME pointing to java installation directory and $JAVA_HOME/bin directory is in your $PATH.
Execute 'java -version' if you can see following output go to the next step:

java version "1.5.x_xx"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.x_xx-xxx)
Java HotSpot(TM) Client VM (build 1.5.x_xx-xxx, mixed mode, sharing)

To build cyklotron, you need to install Apache Maven first. We strongly recommend using the most recent stable version (1.1 Beta 1, at the time of writing). Building with older version is possible but requires tweaking configuration files, and we will not provide any support in this regard.

Set $MAVEN_HOME to point to maven directory and add $MAVEN_HOME/bin to your execution $PATH.

Execute 'maven -v' to assure you did it correctly.

Non distributable dependencies

Then you need to download some dependency jars and put it into your local maven repository. On Unix systems it is normally $HOME/.maven/repository/ Consult Maven documentation for more information.

It happens that sun provide jar archives with zip extension.

All the remaining dependencies should be dowloaded automatically by Maven. Be prepared that about 20mB of jars will be downloaded during the first build cycle.

Getting the source

All needed sources are located in following repositories:

To get them from command line for each listed module type:

cvs -z3 -d :pserver:<LOGIN>@<HOST>:<CVSROOT> co <MODULE NAME>

Invoking maven

To build all projects comprising a product (ledge, coral or cyklotron), you should enter the corresponding -reactor directory, and in case of release builds execute:

maven multiproject:install

and case of development builds execute:

maven multiproject:install-snapshot

To build a single project enter an apropriate project directory and execute an command apropriate for the project type

First time building

If you build Cyklotron for the first time you should take care of building sequence due to projects dependencies. Follow commands below to assure you do it right.

...
>cd ledge-reactor
>maven multiproject:install-snapshot
>cd ../coral-reactor
>maven multiproject:install-snapshot
>cd ../ledge-forms
>maven jar:install-snapshot
>cd ../cyklotron-reactor
>maven multiproject:install-snapshot
>cd ../cyklotron-webapp
>maven war:install

No error appeared on the screen means you've finished building Cyklotron CMS.
The web application archive 'cyklotron-webapp.war' is already waiting for you in target subdirectory.

Annoyed with repeated SNAPSHOT downloads?

First, use a http proxy if you have one near by. It really boosts performance. To configure it, add the following entries into your global build.properties file (username and password are optional, leave them out if you don't need them):

maven.proxy.host=...
maven.proxy.port=...
maven.proxy.username=...
maven.proxy.password=...

Another option is to tell maven that you are working offline. If you wan't to do it just for single run, insert -o as the first argument on the command line. If you want to set it permanently, add the following to your build.propreties file, eiter globally, or in the *-common project directories.

maven.mode.online=false