Overview
This documents how to build the Apache Geronimo server project.
This guide is intended to cover how to build the latest server/trunk
, though other newer branches should also follow similar instructions. Server trees that use the same basic build tooling include:
server/trunk
server/branches/1.2
server/branches/2.0
Prerequisites
Java Developer Kit (JDK)
You will need a JDK 5.0+ (J2SE 1.5.0+) or compatible JDK to build Apache Geronimo. It is recommended you use SUN's implementation, or something compatible like Apples implementation. Other JDK vendors implementations may work, but use at your own risk.
Newer JDK versions (like for Java 6) probably won't work, as the server build will probably fail with a message complaining about it. Its possible to disable that check and play with a newer JDK version, but if you want the build to pass, you are better off just using a Java 5 JDK
Apache Maven 2
To execute the build process you need to have Apache Maven version 2.0.5
(or newer) installed.
To check if your installation is working and you have the required minimum version run:
mvn -version
And it should produce something like:
Maven version: 2.0.6
If you have an incompatible version the server build will probably fail with a message complaining
Subversion
To fetch the source code for the server, you will need to have a Subversion client version 1.2 (or newer, 1.4 is recommended) installed.
Windows Tip
Windows users are strongly encouraged to change the M2 local repository (the place where dependencies are downloaded) to a shorter path with no spaces, e.g. C:\.m2
.
Using a longer path may cause the build (and Geronimo itself) to behave very strangely when it hits the 260 char limit for filenames on Windows.
In order to change the m2 local repository go to %USERPROFILE%\.m2
and edit or create settings.xml
file to contain the following content:
<?xml version="1.0"?> <settings> <localRepository>C:\.m2</localRepository> </settings>
Checkout Geronimo
svn co https://svn.apache.org/repos/asf/geronimo/server/trunk server
Windows Tip
Windows users are strongly encouraged to checkout Geronimo into c:\g
.
Using a longer path may cause the build (and Geronimo itself) to behave very strangely when it hits the 260 char limit for filenames on Windows.
Preparing to build for the first time
Chances are you will need to increase the heap size for Maven. Add the following lines to ~/.mavenrc
:
The following snips only set MAVEN_OPTS
if its not already set, so that you can override these values on the command line if needed.
# Increase the heap size Maven if [ "x$MAVEN_OPTS" = "x" ]; then MAVEN_OPTS=-Xmx512m fi
If you are using the SUN JDK (or a JDK with compatible flags, like the Apple JDK), you should also increase the maximum permanent size as well as the heap:
# Increase the heap and max permanent size for Maven if [ "x$MAVEN_OPTS" = "x" ]; then MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=128m" fi
Windows Tip
Windows users should create mavenrc_pre.bat
under c:\documents and settings\<username>\mavenrc_pre.bat
or c:\mavenrc_pre.bat
depending on how the %HOME%
property is set on your system.
Variables will need to use the batch set syntax:
set <VARIABLE>=<VALUE>
Building
To build all changes incrementally:
mvn install
To perform clean builds, which are sometimes needed after some changes to the source tree:
mvn clean install
Building Stages
In some cases you may need to build Geronimo in stages, such as when building OpenEJB from source to pick up local changes. Most users will not need to do this, but its documented here for clarity.
To build modules, testsupport and maven-plugins:
mvn install -Dstage=bootstrap
To build apps, configs and assemblies:
mvn install -Dstage=assemble
As mentioned, most users will not need to build Geronimo in stages. But in some cases, when bootstrapping new versions (when no artifacts are deployed into remote repositories for the current version), then you must build the stages separately for the first build and then for all builds afterwards, the staged build is not necessary.
Testing the Assembly
Once you have build the server fully, which will produce a number of zip
and tar.gz
archives from the assembly modules, you can use the geronimo-maven-plugin
to start the server. From the project root directory run:
mvn -Ptools geronimo:start
Windows Tip
Windows users may need to specify an alternative installDirectory
to avoid long path problems:
mvn -Ptools geronimo:start -DinstallDirectory=c:\g
And to stop, either CTRL-C
or from a separate terminal, from the project root directory run:
mvn -Ptools geronimo:stop