Author: norman Date: Wed Aug 23 10:28:38 2006 New Revision: 434092 URL: http://svn.apache.org/viewvc?rev=434092&view=rev Log: Add upgrade documentation
Added: james/site/trunk/www/server/upgrade_instructions_2_3.html Removed: james/site/trunk/www/server/documentation_2_3.html Added: james/site/trunk/www/server/upgrade_instructions_2_3.html URL: http://svn.apache.org/viewvc/james/site/trunk/www/server/upgrade_instructions_2_3.html?rev=434092&view=auto ============================================================================== --- james/site/trunk/www/server/upgrade_instructions_2_3.html (added) +++ james/site/trunk/www/server/upgrade_instructions_2_3.html Wed Aug 23 10:28:38 2006 @@ -0,0 +1,319 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + + + + + + + + + + +<html> + <head> + <title>James Server - + James 2.3 - Upgrading</title> + <style type="text/css" media="all"> + @import url("./css/maven-base.css"); + @import url("./css/maven-theme.css"); + @import url("./css/site.css"); + </style> + <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> + </head> + <body class="composite"> + <div id="banner"> + <a href="http://james.apache.org/index.html" id="bannerLeft"> + + <img src="images/james-server-logo.gif" alt="" /> + + </a> + <a href="http://www.apache.org/index.html" id="bannerRight"> + + <img src="images/asf-logo-reduced.gif" alt="" /> + + </a> + <div class="clear"> + <hr/> + </div> + </div> + <div id="breadcrumbs"> + + + + + + + + <div class="xleft"> + Last Published: 08/23/2006 + </div> + <div class="xright"> <a href="http://james.apache.org/index.html">JAMES Project</a> + | + <a href="">Server</a> + | + <a href="http://james.apache.org/jspf/index.html">jSPF</a> + | + <a href="http://james.apache.org/mime4j/index.html">Mime4J</a> + | + <a href="http://james.apache.org/jsieve/index.html">JSieve</a> + | + <a href="http://james.apache.org/postage/index.html">Postage</a> + + + + + + + + </div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="leftColumn"> + <div id="navcolumn"> + + + + + + + + <h5>James</h5> + <ul> + + <li class="none"> + <a href="index.html">Overview</a> + </li> + + <li class="none"> + <a href="FAQ.html">James FAQ</a> + </li> + + <li class="none"> + <a href="mail.html">Mailing Lists</a> + </li> + + <li class="none"> + <a href="http://wiki.apache.org/james">Wiki</a> + </li> + </ul> + <h5>Documentation</h5> + <ul> + + <li class="none"> + <a href="documentation_2_1.html">James</a> + </li> + + <li class="none"> + <a href="design_objectives.html">Design</a> + </li> + + <li class="none"> + <a href="document_archive.html">Document Archive</a> + </li> + </ul> + <h5>Documentation 2.3</h5> + <ul> + + <li class="none"> + <a href="documentation_2_3.html">James</a> + </li> + + <li class="none"> + <a href="design_objectives_2_3.html">Design</a> + </li> + + <li class="none"> + <a href="apidocs/index.html">James Javadocs</a> + </li> + + <li class="none"> + <a href="rfclist.html">Useful RFCs</a> + </li> + </ul> + <h5>Project</h5> + <ul> + + <li class="none"> + <a href="http://issues.apache.org/jira/browse/JAMES">Bug Database</a> + </li> + + <li class="none"> + <a href="http://svn.apache.org/viewvc/james/server/">Source Code</a> + </li> + + <li class="none"> + <a href="changelog.html">Changelog</a> + </li> + + <li class="none"> + <a href="todo.html">TODO</a> + </li> + </ul> + <h5>Project Documentation</h5> + <ul> + + + + + + + + + + + + + + + + <li class="collapsed"> + <a href="project-info.html">Project Information</a> + </li> + + + + + + + + + + + + <li class="collapsed"> + <a href="project-reports.html">Project Reports</a> + </li> + </ul> + <a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"> + <img alt="Built by Maven" src="./images/logos/maven-feather.png"></img> + </a> + + + + + + + + </div> + </div> + <div id="bodyColumn"> + <div id="contentBox"> + + + + +<a name="Upgrading Comments"></a><div class="section"><h2>Upgrading Comments</h2> +<p>James upgrading involves a number of steps, each of which is described in some detail in the +following sections. But as this sequence of steps has confused some users in the past, additional +comments seem warranted.</p> +<p>It is important to realize that the James configuration files are not unpacked from the James +distribution until the first time James is started. This is a consequence of the design of the +Avalon Phoenix container used to run James. Once James has been started, the distribution will +be unpacked. The server should be stopped, the configuration files edited, and the server restarted.</p> +<p>So the Upgrading sequence is: <b>1) Start, 2) Stop, 3) Move 4) Edit, 5) Restart</b>.</p> +</div> +<a name="Copy mailboxes and users"></a><div class="section"><h2>Copy mailboxes and users</h2> +<a name="Copy mailboxes and users"></a><div class="section"><h3>Copy mailboxes and users</h3> +<p>Remove the apps/james/var directory and copy the apps/james/var directory of the old james +installation in this place.</p> +</div> +</div> +<a name="Copy and modify config.xml"></a><div class="section"><h2>Copy and modify config.xml</h2> +<a name="Remove the fetchpop block"></a><div class="section"><h3>Remove the fetchpop block</h3> +<p>It's necessary to remove the fetchpop block in config.xml because fetchpop was removed in 2.3.</p> +</div> +<a name="Move mailet and matcher packages config"></a><div class="section"><h3>Move mailet and matcher packages config</h3> +<p>Move <mailetpackages> and <matcherpackages> outside of the <spoolmanager> block.</p> +</div> +<a name="Add necessary mailets"></a><div class="section"><h3>Add necessary mailets</h3> +<p>Add the following line as the first mailet of the "root" processor:</p> +<div class="source"><pre> +<mailet match="All" class="PostmasterAlias"/> +</pre></div> +<p>This was hardcoded in 2.2.0 and previous. Now we made it configurable.</p> +</div> +<a name="Move the spoolrepository config"></a><div class="section"><h3>Move the spoolrepository config</h3> +<p>Move the spoolrepository out of the mailstore. Its also necessary to change the config syntax. For example:</p> +<div class="source"><pre> +<spoolRepository> + <repository destinationURL="db://maildb/spool/spool" type="SPOOL"/> +</spoolRepository> +</pre></div> +Must converted to +<div class="source"><pre> +<spoolrepository destinationURL="db://maildb/spool/spool" type="SPOOL"/> +</pre></div> + +</div> +<a name="Move the objectstore"></a><div class="section"><h3>Move the objectstore</h3> +<p>Move the objectstore config into the mailstore config.</p> +</div> +<a name="Add SSL to server-sockets"></a><div class="section"><h3>Add SSL to server-sockets</h3> +<p> To be able to use SSL you need to add this SSL config to the server-sockets block:</p> +<div class="source"><pre> +<!-- +<factory name="ssl" class="org.apache.avalon.cornerstone.blocks.sockets.TLSServerSocketFactory"> + <ssl-factory> + <keystore> + <file>conf/keystore/</file> + <password>secret</password> + <key-password>keysecret</key-password> + <type>JKS</type> + <protocol>TLS</protocol> + <algorithm>SunX509</algorithm> + <authenticate-client>false</authenticate-client> + </keystore> + </ssl-factory> +</factory> +--> +</pre></div> +</div> +</div> +<a name="Modify costum mailets if necessary"></a><div class="section"><h2>Modify costum mailets if necessary</h2> +<p> Please note the following things that were changed. So maybe it's necessary for you to change some stuff in your mailets. </p> +<a name="Avalon updates"></a><div class="section"><h3>Avalon updates</h3> +<ul> +<li>avalon Component has been replaced by avalon Service</li> +<li>avalon Composable has been replaced by avalon Serviceable</li> +<li>avalon ComponentManager has been replaced by avalon ServiceManager</li> +</ul> +</div> +<a name="Cornerstone updates"></a><div class="section"><h3>Cornerstone updates</h3> +<ul> +<li>MailStore interface has been removed: mailets looking up the MailStore should now lookup +a Store (org.apache.avalon.cornerstone.services.store.Store)</li> +</ul> +</div> +</div> +<a name="Start James"></a><div class="section"><h2>Start James</h2> + Now you should be able to start james without problems. +</div> + + + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright">© + 2002-2006 + + Apache Software Foundation + + + + + + + + </div> + <div class="clear"> + <hr/> + </div> + </div> + </body> +</html>