blob: 1d25233d0ae31cfd3842c777c6c6c421623375a8 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you 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.
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- Generated by Apache Maven Doxia at Jun 7, 2012 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>
Building Hupa</title>
<style type="text/css" media="all">
@import url("./css/james.css");
@import url("./css/maven-base.css");
@import url("./css/maven-theme.css");
@import url("./css/site.css");
@import url("./js/jquery/css/custom-theme/jquery-ui-1.8.5.custom.css");
@import url("./js/jquery/css/print.css");
@import url("./js/fancybox/jquery.fancybox-1.3.4.css");
</style>
<script type="text/javascript" src="./js/jquery/js/jquery-1.4.2.min.js"></script>
<script type="text/javascript" src="./js/jquery/js/jquery-ui-1.8.5.custom.min.js"></script>
<script type="text/javascript" src="./js/fancybox/jquery.fancybox-1.3.4.js"></script>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta name="author" content="James Hupa Project Team" />
<meta name="Date-Revision-yyyymmdd" content="20120607" />
<meta http-equiv="Content-Language" content="en" />
<link title="DOAP" rel="meta" type="application/rdf+xml" href="http://james.apache.org//doap_james-project.rdf"/>
<!-- Google Analytics -->
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-1384591-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script').item(0); s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body class="composite">
<div id="banner">
<a href="index.html" id="bannerLeft" title="james-hupa-logo.gif">
<img src="images/logos/james-hupa-logo.gif" alt="James Hupa" />
</a>
<a href="http://www.apache.org/index.html" id="bannerRight">
<img src="images/logos/asf-logo-reduced.gif" alt="The Apache Software Foundation" />
</a>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
<div class="xleft">
<span id="publishDate">Last Published: 2012-06-07</span>
</div>
<div class="xright"> <a href="../index.html" title="Home">Home</a>
|
<a href="../server/index.html" title="Server">Server</a>
|
<a href="index.html" title="Hupa">Hupa</a>
|
<a href="../protocols/index.html" title="Protocols">Protocols</a>
|
<a href="../imap/index.html" title="IMAP">IMAP</a>
|
<a href="../mailet/index.html" title="Mailets">Mailets</a>
|
<a href="../mailbox/index.html" title="Mailbox">Mailbox</a>
|
<a href="../mime4j/index.html" title="Mime4J">Mime4J</a>
|
<a href="../jsieve/index.html" title="jSieve">jSieve</a>
|
<a href="../jspf/index.html" title="jSPF">jSPF</a>
|
<a href="../jdkim/index.html" title="jDKIM">jDKIM</a>
|
<a href="../mpt/index.html" title="MPT">MPT</a>
|
<a href="../postage/index.html" title="Postage">Postage</a>
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
<h5>Hupa</h5>
<ul>
<li class="none">
<a href="index.html" title="Overview">Overview</a>
</li>
<li class="none">
<a href="screenshots.html" title="Screenshots">Screenshots</a>
</li>
<li class="none">
<a href="configuration.html" title="Configuration">Configuration</a>
</li>
<li class="none">
<a href="faq.html" title="FAQs">FAQs</a>
</li>
</ul>
<h5>Get Involved</h5>
<ul>
<li class="none">
<a href="environment.html" title="Setup">Setup</a>
</li>
<li class="none">
<strong>Building</strong>
</li>
</ul>
<h5>Project</h5>
<ul>
<li class="none">
<a href="https://issues.apache.org/jira/browse/HUPA" title="Issue Tracker">Issue Tracker</a>
</li>
<li class="none">
<a href="source-repository.html" title="Source Code">Source Code</a>
</li>
<li class="none">
<a href="javadoc.html" title="Javadoc">Javadoc</a>
</li>
<li class="none">
<a href="team-list.html" title="Who We Are">Who We Are</a>
</li>
<li class="none">
<a href="license.html" title="License">License</a>
</li>
</ul>
<h5>About James</h5>
<ul>
<li class="none">
<a href="../index.html" title="Overview">Overview</a>
</li>
<li class="none">
<a href="../newsarchive.html" title="News">News</a>
</li>
<li class="none">
<a href="../mail.html" title="Mailing Lists">Mailing Lists</a>
</li>
<li class="none">
<a href="../contribute.html" title="Contributing">Contributing</a>
</li>
<li class="none">
<a href="../guidelines.html" title="Guidelines">Guidelines</a>
</li>
<li class="none">
<a href="http://wiki.apache.org/james" title="Wiki">Wiki</a>
</li>
<li class="none">
<a href="../team-list.html" title="Who We Are">Who We Are</a>
</li>
<li class="none">
<a href="../license.html" title="License">License</a>
</li>
</ul>
<h5>Download</h5>
<ul>
<li class="none">
<a href="../download.cgi" title="Releases">Releases</a>
</li>
<li class="none">
<a href="https://repository.apache.org/content/repositories/snapshots/org/apache/james/" title=""></a>
</li>
</ul>
<h5>Apache Software Foundation</h5>
<ul>
<li>
<strong>
<a title="ASF" href="http://www.apache.org/">ASF</a>
</strong>
</li>
<li>
<a title="Get Involved" href="http://www.apache.org/foundation/getinvolved.html">Get Involved</a>
</li>
<li>
<a title="FAQ" href="http://www.apache.org/foundation/faq.html">FAQ</a>
</li>
<li>
<a title="License" href="http://www.apache.org/licenses/" >License</a>
</li>
<li>
<a title="Sponsorship" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
</li>
<li>
<a title="Thanks" href="http://www.apache.org/foundation/thanks.html">Thanks</a>
</li>
<li>
<a title="Security" href="http://www.apache.org/security/">Security</a>
</li>
</ul>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
</a>
</div>
</div>
<div id="bodyColumn">
<div id="contentBox">
<!-- Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with this
work for additional information regarding copyright ownership. The ASF
licenses this file to you 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. -->
<div class="section"><h2>Building Hupa for the first time<a name="Building_Hupa_for_the_first_time"></a></h2>
<p>
Because Hupa uses maven as its build tool, the management of
dependencies is rather simple. You can either run
<tt>mvn clean package</tt>
from the command line, or use the built-in m2eclipse plugin.
</p>
<div class="section"><h3>Setting up m2eclipse to build Hupa<a name="Setting_up_m2eclipse_to_build_Hupa"></a></h3>
<p>
m2eclipse provides you with the ability to create different run
configurations for maven. So you can run
<b>what</b>
you want,
<b>when</b>
you want, by a single mouse-click. <br />To configure the 'm2 run
configuration', please do a right click on the project name and select
Run As -&gt; Run Configurations ...
</p>
<p>
In the Following Dialog left-click Maven Build, then click on New on
the top. On the dialogs main content area provide the run
configuration now. In the Name field type
<tt>hupa clean package</tt>
. Uder the Base Directory should be written
<tt>${workspace_loc:/hupa-trunk}</tt>
(if your project is only named hupa, then it would be
${workspace_loc:/hupa}).
<br /><br />
<img src="images/dev/run-configurations-main.jpg" alt="" />
<br /><br />
Underneath you should check Update Snaphots
and on the Refresh Tab you
should check Refresh Resources upon
Completion and The Project
Containing the selected Resource.
<br /><br />
<img src="images/dev/run-configurations-refresh.jpg" alt="" />
<br /><br />
After all is set, click Apply and then click Run. It will take a hile
to download all the dependencies. Once it is finished, it will refresh
eclipse, and we are on the final step to start it up the first time.
</p>
</div>
</div>
<div class="section"><h2>Setting up the Google Plugin<a name="Setting_up_the_Google_Plugin"></a></h2>
<p>
Because Hupa uses the google web toolkit (GWT) it is necessary to
adjust
the output directory of the project. If you don't do that, the Stand alone
google
browser will not be able to pick up the compiled classes. So, to
change
it do a right-click on your project choos Run As -&gt; Web Application. <br />But
beware you will get an error! We do this only because the plugin sets
almost everything up for us. After we get the error right-click on the
project again, and choose Run As -&gt; Run Configurations... then expand
the Web Application Node, go to the Arguments tab and add
<tt>-Dhupa.config.file=${project_loc}/server/src/main/webapp/WEB-INF/conf/config.properties
</tt>
to the VM Arguments Textbox. Click on Apply and close the dialog.
<br /> After
that go into the Package Explorer
View and expand server -&gt; src -&gt; main
-&gt; webapp -&gt; WEB-INF -&gt; conf and
double click on config.properties.
Adjust these settings to your liking.
googlemail is setup by default.<br />
Last thing to setup is the projects output path. Do a right-click on the
project and choose Build Path -&gt; Configure Build Path... Under the
Source tab put &lt;your_project_name&gt;/war/WEB-INF/classes in the
output directory textbox.
</p>
</div>
<div class="section"><h2>Starting Hupa<a name="Starting_Hupa"></a></h2>
<p>
So we are finally there. We can run Hupa for the first time. <br /> Do a
right-click
on the project choose Run As -&gt; Run Configurations... -&gt;
Hupa.html and
click on run.
</p>
</div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
<div class="xright">Copyright &#169; 2009-2012
<a href="http://www.apache.org/">The Apache Software Foundation</a>.
All Rights Reserved.
</div>
<div class="clear">
<hr/>
</div>
</div>
</body>
</html>