Build from sources

Building from sources

1 Overview

The community distribution of eXo Platform is built very frequently by the open source project members. The corresponding binaries are uploaded to the OW2 forge. Although the high frequency allows to get quick bug fixes, it might be needed sometimes to build eXo Platform from the sources. This page gives detailed instructions.

eXo Platform is built using Maven. After you have built, you should go to the Developers page, where you find hints for the use with Ecplise and Intellij.

2 Pre-requisites

• Download, install and add in your path JDK (Java Development Kit) 5.0 for AllInOne 1.6.x products.
• Download, install and add in your path JDK (Java Development Kit) 6.0 for GateIn based products.
• Download, install, add in your path Maven 2.2.1
• Download application servers you'll want to use and extract them into a directory (let's call it $APPLICATIONS_DIRECTORY).

3 Check out the source code

eXo source code is hosted in a Subversion repository at http://svn.exoplatform.org/projects. Before you proceed, you need to install a command line subversion client.

Checkout the source code into a new directory :

svn co http://svn.exoplatform.org/aliases/head exo-trunks

This will check out trunk for all project sources.

If you are interested by AllInOne suite products you can grab them here :

svn co http://svn.exoplatform.org/aliases/aio/branches/aio-1.6.x/ exo-aio-1.6.x

4 Configure

Add a system environment variable MAVEN_OPTS (it could be in a .profile startup script on Linux/MacOS operating systems or in global environment variables panel on Windows).

• Windows :

set MAVEN_OPTS=-Xshare:auto -Xms128M -Xmx1G -XX:MaxPermSize=256M

• Linux/MacOS :

export MAVEN_OPTS="-Xshare:auto -Xms128M -Xmx1G -XX:MaxPermSize=256M"

Save the attached file settings.xml to ${HOME}/.m2/settings.xml

Edit it, and change in the local-properties profile the path of the directory where you added application servers (exo.projects.directory.dependencies must be the path of $APPLICATIONS_DIRECTORY) and the name of each application server directory must be set in *.version properties (exo.projects.app.tomcat.version, exo.projects.app.jboss.version, exo.projects.app.jonas.version).

Note : If you have an existing file settings.xml you can merge them all together. You'll need at least

• the local-properties profile to define properties used to build application servers distributions of our products
• the repository http://repository.exoplatform.org/public to download our dependencies

5 Build and assemble product

To build any product, in the root directory where you checked-out the code just launch :

mvn install

This command can be launched from any subdirectory.

Maven we'll take a long long time to download required dependencies the first time. After that he'll just check one time per day if new SNAPSHOTs were built by our integration server (http://builder.exoplatform.org)

5.1 AllInOne 1.6.x products

To build a tomcat or jboss distribution, just add -Ppkg in the command line. The product we'll be in the project directories tree under packaging/pkg (ks, cs, ecm/wcm ...)

5.2 GateIn based products

To build a tomcat or jboss distribution, just add -Ptomcat-pkg or -Pjboss-pkg in the command line. The product we'll be in the project directories tree under packaging/pkg (ks, cs, ecm/wcm ...)