Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<h1>Prequisites</h1>

<ul>
	<li>Check out Cargo from <a class="confluence-link" href="/display/CARGO/SVN" data-linked-resource-id="8857" data-linked-resource-type="page" data-linked-resource-default-alias="SVN" data-base-url="http://docs.codehaus.org">SVN</a> into a <code>CARGOHOME</code> directory (wherever you want on your machine).</li>
	<li>In case your SVN client needs to go through a proxy, have a look at <a href="http://subversion.tigris.org/faq.html#proxy">What if I'm behind a proxy?</a></li>
	<li>Install <a href="http://maven.apache.org">Maven 2</a>. Verify your installation works by typing &quot;<code>mvn --version</code>&quot; at a command prompt.
	<ul>
		<li>CARGO requires Maven 2.0.5 or greater to run</li>
		<li>CARGO requires Maven 2.1 or greater to compile; in particular the <code>core/samples</code> builds require that version of Maven</li>
	</ul>
	</li>
</ul>

<table class="wysiwyg-macro" data-macro-name="info" data-macro-parameters="title=Maven 3 support" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2luZm86dGl0bGU9TWF2ZW4gMyBzdXBwb3J0fQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body">
<p>CARGO 1.0.x's Maven 2 plugins do work very well with Maven 3, but CARGO 1.0.x requires Maven 2 for its build process. Starting from CARGO 1.1.x, CARGO also builds on Maven 3, see <a href="https://jira.codehaus.org/browse/CARGO-789">CARGO-789: Make build work with Maven 3.0</a>.</p></td></tr></table>

<h1>Building</h1>

<table class="wysiwyg-macro" data-macro-name="info" data-macro-parameters="title=First time build" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2luZm86dGl0bGU9Rmlyc3QgdGltZSBidWlsZH0&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body">
<p>The Cargo build contains functional tests. Those tests are run on different containers. The first time you build Cargo it will download those container distributions which will take some time (the containers are installed into <code>core/samples/java/installs</code>). If you want to tell Cargo to run only on some specific container, see below.</p></td></tr></table>

<ul>
	<li>Go to <code>CARGOHOME</code> and type &quot;<code>mvn install</code>&quot;. This will build the full Cargo project.</li>
	<li>If you wish to clean all build-generated files, cd to <code>CARGOHOME</code> and type &quot;<code>mvn clean</code>&quot;.</li>
</ul>

<h3>Selecting containers</h3>

<p>The default list of containers to run on depends a property cargo.containers defined in CARGOHOME/core/samples/pom.xml. It can also be supplied at the commandline by using profiles (-P&lt;containerId&gt;).</p>

<p>For example if you only want to run on Tomcat 5.x you'd write: <code>mvn -Ptomcat5x clean install</code></p>

<p>There are also some multi-container profiles, for example <code>mvn -Pall-downloadable clean install</code> will build CARGO and test the CARGO samples with all downloadable containers (Jetty's many versions, Tomcat's many versions, etc.)</p>

<ul>
	<li>Type <code>mvn -o</code> to work offline. This improves the build speed as Maven 2 does not check for updates on the remote repository for SNAPSHOTs.</li>
</ul>

<h3>Proxy settings</h3>

<p>If you need to build cargo from behind a proxy, proceed as follows:</p>
<ul>
	<li>edit the <code>.m2/settings.xml</code> file from your home directory (C:/Documents and Settings/<em>username</em> on Windows),</li>
	<li>comment out the &lt;proxy&gt; element and fill in the proxy server settings accordingly.</li>
</ul>