blob: cde310ed718c7b805bc25be169137898636806f2 [file] [log] [blame]
<!--
Copyright 2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<title>Untitled Document</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<style type="text/css">
<!--
body, body td { font-family: Arial, Helvetica, sans-serif; font-size: 10pt}
h1 {font-size: 18pt}
h2 {font-size: 16pt}
h3 {font-size: 14pt}
h3 {font-size: 12pt}
strong {color: red;}
code {font-size: 10pt;}
.border-1 {border: solid 1px;}
-->
</style>
</head>
<body bgcolor="#FFFFFF" text="#000000">
<h1>Getting Started with Pluto</h1>
<p>It is expected that the user is familiar with the <a href="http://maven.apache.org">Apache
Maven</a> project tool.</p>
<h2>Requirements:</h2>
<ul>
<li><a href="http://maven.apache.org/start/download.html">Maven 1.0-beta-10</a>
or higher</li>
<li>Java 1.3 or higher</li>
<li>Servlet 2.3:<br>
Tomcat 4.1.18-LE w/JDK 1.4<br>
<b>or</b> <br>
Tomcat 4.1.24 w/ JDK 1.3</li>
</ul>
<h2>1. Get Maven Ready</h2>
<p>If you have not already done so, download and install Maven.</p>
<p>2. build.properties settings:</p>
<p>Please set these values in your <code>build.properties</code>
file:</p>
<table width="650" border="1" cellspacing="0" cellpadding="3">
<tr>
<th width="134">property</th>
<th width="229">example</th>
<th width="261">what is it?</th>
</tr>
<tr>
<td width="134">maven.tomcat.home</td>
<td width="229">/tomcat</td>
<td width="261">location of the Tomcat install where you want to deploy Pluto</td>
</tr>
</table>
<p>You can copy the <code>build.properties.sample</code> file and name it
<code>build.properties</code> and use this is a starting point.</p>
<h2>2. Building and deploying</h2>
<ul>
<li>change your directory to root of the Pluto project.</li>
<li>maven fullDeployment</li>
<li>This will take care of everything for you including copying shared jars,
and deploy the base Pluto portal along with the Portlet Test Suite</li>
</ul>
<h2>3. Start Tomcat</h2>
<p>Run Tomcat, go to http://localhost:8080/pluto/portal.</p>
<h2>What if I just want the Pluto container jar (like for Jetspeed 2)?</h2>
<ol>
<li>cd to /api directory</li>
<li>maven jar:install</li>
<li>cd to /container directory</li>
<li>maven jar:install</li>
</ol>
<p>This will create the container jar in /container/target and also copy into
you maven repository.</p>
<h2>What if I just want to deploy the Pluto portal without the test suite?</h2>
<ol>
<li>Follow all the steps from &quot;<i>What if I just want the Pluto container
jar (like for Jetspeed 2)?</i>&quot;</li>
<li>cd to the /portal directory.</li>
<li>maven (with no goal)</li>
</ol>
<p>This will invoke the default maven goal for the /portal sub-project, deployPlutoToTomcat.
&nbsp;This will build and deploy the Pluto portal minus the test suite into
tomcat.</p>
<h2>What if I decide I want to deploy the test suite portlets after I deploy the
Pluto portal by itself?</h2>
<ol>
<li>Follow all the steps from &quot;<i>What if I decide I want to deploy the
test suite portlets after I deploy JUST the Pluto portal?</i>&quot;</li>
<li>cd to the /testsuite directory.</li>
<li>maven (with no goal)</li>
</ol>
<p>This will invoke the default maven goal for the /testsute sub-project, deployTestsuite.
&nbsp;This willbuild and deploy the test suite portlets into your already deployed
Pluto portal.</p>
<h2>&nbsp;</h2>
</body>
</html>