You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-dev@james.apache.org by ad...@apache.org on 2016/02/05 11:11:11 UTC
svn commit: r1728624 [1/2] - in /james/site/trunk/www/server/3:
config-cassandra.html config-elasticsearch.html config-events.html
config-guice.html config-quota.html quick-start-cassandra.html
Author: aduprat
Date: Fri Feb 5 10:11:10 2016
New Revision: 1728624
URL: http://svn.apache.org/viewvc?rev=1728624&view=rev
Log:
Update site with latest changes (add new files)
Added:
james/site/trunk/www/server/3/config-cassandra.html
james/site/trunk/www/server/3/config-elasticsearch.html
james/site/trunk/www/server/3/config-events.html
james/site/trunk/www/server/3/config-guice.html
james/site/trunk/www/server/3/config-quota.html
james/site/trunk/www/server/3/quick-start-cassandra.html
Added: james/site/trunk/www/server/3/config-cassandra.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/server/3/config-cassandra.html?rev=1728624&view=auto
==============================================================================
--- james/site/trunk/www/server/3/config-cassandra.html (added)
+++ james/site/trunk/www/server/3/config-cassandra.html Fri Feb 5 10:11:10 2016
@@ -0,0 +1,334 @@
+<?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 2016-02-05 -->
+<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>Apache James Server 3.0 -
+ Apache James Server 3 - Cassandra Configuration</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="Date-Revision-yyyymmdd" content="20160205" />
+ <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-server-logo.gif">
+
+
+ <img src="images/logos/james-server-logo.gif" alt="Apache James Server 3.0" />
+ </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: 2016-02-05</span>
+ </div>
+ <div class="xright"> <a href="../../index.html" title="Home">Home</a>
+ |
+ <a href="../index.html" title="Server">Server</a>
+ |
+ <a href="../../hupa/index.html" title="Hupa">Hupa</a>
+ |
+ <a href="../../protocols/index.html" title="Protocols">Protocols</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>Overview</h5>
+ <ul>
+ <li class="none">
+ <a href="index.html" title="Introduction">Introduction</a>
+ </li>
+ <li class="none">
+ <a href="release-notes.html" title="Release Notes">Release Notes</a>
+ </li>
+ </ul>
+ <h5>Features</h5>
+ <ul>
+ <li class="none">
+ <a href="feature-mailetcontainer.html" title="Mailet Container">Mailet Container</a>
+ </li>
+ <li class="none">
+ <a href="feature-queue-priority.html" title="Queue Priority">Queue Priority</a>
+ </li>
+ <li class="none">
+ <a href="feature-persistence.html" title="Persistence">Persistence</a>
+ </li>
+ <li class="none">
+ <a href="feature-protocols.html" title="Protocols">Protocols</a>
+ </li>
+ <li class="none">
+ <a href="feature-smtp-hooks.html" title="SMTP Hooks">SMTP Hooks</a>
+ </li>
+ <li class="none">
+ <a href="feature-performance.html" title="Performance">Performance</a>
+ </li>
+ <li class="none">
+ <a href="feature-security.html" title="Security">Security</a>
+ </li>
+ </ul>
+ <h5>User Manual</h5>
+ <ul>
+ <li class="none">
+ <a href="quick-start.html" title="1. Quick Start">1. Quick Start</a>
+ </li>
+ <li class="none">
+ <a href="install.html" title="2. Install James">2. Install James</a>
+ </li>
+ <li class="collapsed">
+ <a href="config.html" title="3. Configure James">3. Configure James</a>
+ </li>
+ <li class="collapsed">
+ <a href="manage.html" title="4. Manage">4. Manage</a>
+ </li>
+ <li class="collapsed">
+ <a href="monitor.html" title="5. Monitor">5. Monitor</a>
+ </li>
+ <li class="collapsed">
+ <a href="upgrade.html" title="6. Upgrade">6. Upgrade</a>
+ </li>
+ </ul>
+ <h5>Developers Corner</h5>
+ <ul>
+ <li class="none">
+ <a href="dev.html" title="Architecture">Architecture</a>
+ </li>
+ <li class="none">
+ <a href="dev-build.html" title="Build from source">Build from source</a>
+ </li>
+ <li class="none">
+ <a href="dev-database-schema.html" title="Database Schema">Database Schema</a>
+ </li>
+ <li class="collapsed">
+ <a href="dev-extend.html" title="Develop Extensions">Develop Extensions</a>
+ </li>
+ <li class="collapsed">
+ <a href="dev-provided.html" title="Provided Extensions">Provided Extensions</a>
+ </li>
+ </ul>
+ <h5>References</h5>
+ <ul>
+ <li class="none">
+ <a href="apidocs/index.html" title="Javadoc">Javadoc</a>
+ </li>
+ <li class="none">
+ <a href="https://issues.apache.org/jira/browse/JAMES" title="Issue Tracker">Issue Tracker</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>
+ </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>Cassandra Configuration<a name="Cassandra_Configuration"></a></h2>
+
+
+<p>Consult <a class="externalLink" href="http://svn.apache.org/repos/asf/james/server/trunk/app/src/main/resources/cassandra-template.properties">cassandra-template.properties</a> to get some examples and hints.</p>
+
+
+<dl>
+
+<dt><b>cassandra.ip</b></dt>
+
+<dd>Is the IP (or host) of the Cassandra used. (cluster is not yet supported)</dd>
+
+<dt><b>cassandra.port</b></dt>
+
+<dd>Is the port used to connect to Cassandra.</dd>
+
+<dt><b>cassandra.keyspace</b></dt>
+
+<dd>Is the name of the keyspace used by James.</dd>
+
+<dt><b>cassandra.replication.factor</b></dt>
+
+<dd>Is the replication factor. (should be 1, as cluster is not yet supported)</dd>
+ </dl>
+
+
+<p>If you want more explanation about Cassandra configuration, you should visit the dedicated <a class="externalLink" href="http://docs.datastax.com/en/cassandra/2.1/cassandra/gettingStartedCassandraIntro.html">documentation</a>.</p>
+
+ </div>
+
+
+
+
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">Copyright © 2002-2016
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: james/site/trunk/www/server/3/config-elasticsearch.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/server/3/config-elasticsearch.html?rev=1728624&view=auto
==============================================================================
--- james/site/trunk/www/server/3/config-elasticsearch.html (added)
+++ james/site/trunk/www/server/3/config-elasticsearch.html Fri Feb 5 10:11:10 2016
@@ -0,0 +1,326 @@
+<?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 2016-02-05 -->
+<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>Apache James Server 3.0 -
+ Apache James Server 3 - ElasticSearch Configuration</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="Date-Revision-yyyymmdd" content="20160205" />
+ <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-server-logo.gif">
+
+
+ <img src="images/logos/james-server-logo.gif" alt="Apache James Server 3.0" />
+ </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: 2016-02-05</span>
+ </div>
+ <div class="xright"> <a href="../../index.html" title="Home">Home</a>
+ |
+ <a href="../index.html" title="Server">Server</a>
+ |
+ <a href="../../hupa/index.html" title="Hupa">Hupa</a>
+ |
+ <a href="../../protocols/index.html" title="Protocols">Protocols</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>Overview</h5>
+ <ul>
+ <li class="none">
+ <a href="index.html" title="Introduction">Introduction</a>
+ </li>
+ <li class="none">
+ <a href="release-notes.html" title="Release Notes">Release Notes</a>
+ </li>
+ </ul>
+ <h5>Features</h5>
+ <ul>
+ <li class="none">
+ <a href="feature-mailetcontainer.html" title="Mailet Container">Mailet Container</a>
+ </li>
+ <li class="none">
+ <a href="feature-queue-priority.html" title="Queue Priority">Queue Priority</a>
+ </li>
+ <li class="none">
+ <a href="feature-persistence.html" title="Persistence">Persistence</a>
+ </li>
+ <li class="none">
+ <a href="feature-protocols.html" title="Protocols">Protocols</a>
+ </li>
+ <li class="none">
+ <a href="feature-smtp-hooks.html" title="SMTP Hooks">SMTP Hooks</a>
+ </li>
+ <li class="none">
+ <a href="feature-performance.html" title="Performance">Performance</a>
+ </li>
+ <li class="none">
+ <a href="feature-security.html" title="Security">Security</a>
+ </li>
+ </ul>
+ <h5>User Manual</h5>
+ <ul>
+ <li class="none">
+ <a href="quick-start.html" title="1. Quick Start">1. Quick Start</a>
+ </li>
+ <li class="none">
+ <a href="install.html" title="2. Install James">2. Install James</a>
+ </li>
+ <li class="collapsed">
+ <a href="config.html" title="3. Configure James">3. Configure James</a>
+ </li>
+ <li class="collapsed">
+ <a href="manage.html" title="4. Manage">4. Manage</a>
+ </li>
+ <li class="collapsed">
+ <a href="monitor.html" title="5. Monitor">5. Monitor</a>
+ </li>
+ <li class="collapsed">
+ <a href="upgrade.html" title="6. Upgrade">6. Upgrade</a>
+ </li>
+ </ul>
+ <h5>Developers Corner</h5>
+ <ul>
+ <li class="none">
+ <a href="dev.html" title="Architecture">Architecture</a>
+ </li>
+ <li class="none">
+ <a href="dev-build.html" title="Build from source">Build from source</a>
+ </li>
+ <li class="none">
+ <a href="dev-database-schema.html" title="Database Schema">Database Schema</a>
+ </li>
+ <li class="collapsed">
+ <a href="dev-extend.html" title="Develop Extensions">Develop Extensions</a>
+ </li>
+ <li class="collapsed">
+ <a href="dev-provided.html" title="Provided Extensions">Provided Extensions</a>
+ </li>
+ </ul>
+ <h5>References</h5>
+ <ul>
+ <li class="none">
+ <a href="apidocs/index.html" title="Javadoc">Javadoc</a>
+ </li>
+ <li class="none">
+ <a href="https://issues.apache.org/jira/browse/JAMES" title="Issue Tracker">Issue Tracker</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>
+ </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>ElasticSearch Configuration<a name="ElasticSearch_Configuration"></a></h2>
+
+
+<p>Consult <a class="externalLink" href="http://svn.apache.org/repos/asf/james/server/trunk/app/src/main/resources/elasticsearch-template.properties">elasticsearch-template.properties</a> to get some examples and hints.</p>
+
+
+<dl>
+
+<dt><b>elasticsearch.clusterName</b></dt>
+
+<dd>Is the name of the cluster used by James.</dd>
+
+<dt><b>elasticsearch.masterHost</b></dt>
+
+<dd>Is the IP (or host) of the ElasticSearch master</dd>
+ </dl>
+
+
+<p>If you want more explanation about ElasticSearch configuration, you should visit the dedicated <a class="externalLink" href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html">documentation</a>.</p>
+
+ </div>
+
+
+
+
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">Copyright © 2002-2016
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: james/site/trunk/www/server/3/config-events.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/server/3/config-events.html?rev=1728624&view=auto
==============================================================================
--- james/site/trunk/www/server/3/config-events.html (added)
+++ james/site/trunk/www/server/3/config-events.html Fri Feb 5 10:11:10 2016
@@ -0,0 +1,482 @@
+<?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 2016-02-05 -->
+<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>Apache James Server 3.0 -
+ Apache James Server 3 - Quota Configuration</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="Date-Revision-yyyymmdd" content="20160205" />
+ <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-server-logo.gif">
+
+
+ <img src="images/logos/james-server-logo.gif" alt="Apache James Server 3.0" />
+ </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: 2016-02-05</span>
+ </div>
+ <div class="xright"> <a href="../../index.html" title="Home">Home</a>
+ |
+ <a href="../index.html" title="Server">Server</a>
+ |
+ <a href="../../hupa/index.html" title="Hupa">Hupa</a>
+ |
+ <a href="../../protocols/index.html" title="Protocols">Protocols</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>Overview</h5>
+ <ul>
+ <li class="none">
+ <a href="index.html" title="Introduction">Introduction</a>
+ </li>
+ <li class="none">
+ <a href="release-notes.html" title="Release Notes">Release Notes</a>
+ </li>
+ </ul>
+ <h5>Features</h5>
+ <ul>
+ <li class="none">
+ <a href="feature-mailetcontainer.html" title="Mailet Container">Mailet Container</a>
+ </li>
+ <li class="none">
+ <a href="feature-queue-priority.html" title="Queue Priority">Queue Priority</a>
+ </li>
+ <li class="none">
+ <a href="feature-persistence.html" title="Persistence">Persistence</a>
+ </li>
+ <li class="none">
+ <a href="feature-protocols.html" title="Protocols">Protocols</a>
+ </li>
+ <li class="none">
+ <a href="feature-smtp-hooks.html" title="SMTP Hooks">SMTP Hooks</a>
+ </li>
+ <li class="none">
+ <a href="feature-performance.html" title="Performance">Performance</a>
+ </li>
+ <li class="none">
+ <a href="feature-security.html" title="Security">Security</a>
+ </li>
+ </ul>
+ <h5>User Manual</h5>
+ <ul>
+ <li class="none">
+ <a href="quick-start.html" title="1. Quick Start">1. Quick Start</a>
+ </li>
+ <li class="none">
+ <a href="install.html" title="2. Install James">2. Install James</a>
+ </li>
+ <li class="collapsed">
+ <a href="config.html" title="3. Configure James">3. Configure James</a>
+ </li>
+ <li class="collapsed">
+ <a href="manage.html" title="4. Manage">4. Manage</a>
+ </li>
+ <li class="collapsed">
+ <a href="monitor.html" title="5. Monitor">5. Monitor</a>
+ </li>
+ <li class="collapsed">
+ <a href="upgrade.html" title="6. Upgrade">6. Upgrade</a>
+ </li>
+ </ul>
+ <h5>Developers Corner</h5>
+ <ul>
+ <li class="none">
+ <a href="dev.html" title="Architecture">Architecture</a>
+ </li>
+ <li class="none">
+ <a href="dev-build.html" title="Build from source">Build from source</a>
+ </li>
+ <li class="none">
+ <a href="dev-database-schema.html" title="Database Schema">Database Schema</a>
+ </li>
+ <li class="collapsed">
+ <a href="dev-extend.html" title="Develop Extensions">Develop Extensions</a>
+ </li>
+ <li class="collapsed">
+ <a href="dev-provided.html" title="Provided Extensions">Provided Extensions</a>
+ </li>
+ </ul>
+ <h5>References</h5>
+ <ul>
+ <li class="none">
+ <a href="apidocs/index.html" title="Javadoc">Javadoc</a>
+ </li>
+ <li class="none">
+ <a href="https://issues.apache.org/jira/browse/JAMES" title="Issue Tracker">Issue Tracker</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>
+ </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>Events System Configuration<a name="Events_System_Configuration"></a></h2>
+
+
+<p>Consult <a class="externalLink" href="http://svn.apache.org/repos/asf/james/server/trunk/app/src/main/resources/events-template.xml">events-template.xml</a> in SVN to get some examples and hints.</p>
+
+
+<p>Use this configuration to define the type of Event System you want.</p>
+
+
+<p>
+ James relies on an event system. Each operations performed on the mailbox will trigger related events. Some software
+ components (MailboxListeners) can register themselves on this event system to be called when an event is fired.
+ </p>
+
+
+<p>
+ Here are typical use cases for Mailbox Listeners (non exhaustive list) :
+ </p>
+<ul>
+
+<li>Message search indexation, for instance in Lucene or ElasticSearch</li>
+
+<li>Local cache invalidation (caching mailbox project)</li>
+
+<li>Quota calculation</li>
+
+<li>IMAP IDLE feature : live notification of actions performed on a mailbox, allowing publish subscribe on mailboxes events</li>
+
+<li>Message Sequence Number consistence</li>
+ </ul>
+ The Mailbox Listeners can be classified in two categories :
+
+<ul>
+
+<li>Mailbox registered : The mailbox listener is only notified on events affecting this mailbox. IDLE is a good example of this.</li>
+
+<li>Global Listeners : This event listener is triggered upon each events.</li>
+ </ul>
+ Note that Global Listeners can also be classified in two categories :
+
+<ul>
+
+<li>Those which needs to be triggered only once in your cluster. For instance ElasticSearch indexing is an example of this.</li>
+
+<li>Those which needs to be triggered on each servers. For instance, each Lucene indexer needs to be triggered on each server
+ for the search feature to stay consistent.</li>
+ </ul>
+
+
+
+<p>
+ The default implementation is a synchronous in memory event system. The performance are really good, as their is no need to serialize
+ events, and no network overhead. However, this event system is limited to one computer and you might want a distributed systems.
+ </p>
+
+
+<p>
+ Other implementations, distributed environment friendly are available.
+ </p>
+
+
+<p>
+ The simplest one is broadcast based. Each James servers listen the same message queue, and each James server will be notified upon events.
+ Here are the pros and cons of this implementations :
+ </p>
+<ul>
+ Pros:
+
+<li>It supports every type of listener described above</li>
+
+<li>It allows you to scale your James infrastructure without changing your middlewares. You just need a message queue</li>
+ Cons :
+
+<li>Your scalability is limited as each servers is notified on all events</li>
+
+<li>Network overhead on event transmissions</li>
+
+<li>Event serialization and deserialization</li>
+ </ul>
+ To use this implementation, you need two other components (that will be discussed) : a publishing system and an event serializer
+
+
+
+<p>
+ The other mode is based on registrations.
+ Each server reads messages from a dedicated message queue, and other servers send messages addressed to this sever on this message queue.
+ Registrations are performed on an eternal data-store supporting document deletion after a fixed amount of time.
+ These registrations are periodically refreshed. This data-store is then triggered on event generation, that, if needed are serialized and
+ send to the given queues.
+ The pros and cons of this implementations are :
+ </p>
+<ul>
+ Pros :
+
+<li>Linear scalability</li>
+
+<li>A server receives only events concerning him</li>
+ Cons :
+
+<li>Possible event serialization costs</li>
+
+<li>Registration and registration refresh costs</li>
+
+<li>Need to find interested servers on event delivery</li>
+
+<li>Network overhead on event transmissions</li>
+ </ul>
+
+
+
+<div class="section">
+<h2>Failure modes<a name="Failure_modes"></a></h2>
+
+
+<ul>
+ Default implementation :
+
+<li>The default implementation might not deliver some events on server stop.</li>
+ </ul>
+
+
+<ul>
+ Broadcast implementation :
+
+<li>The broadcast implementation might not deliver some events on server stop.</li>
+
+<li>The broadcast implementation is tight to limitation of the underlying publisher.</li>
+ </ul>
+
+
+<ul>
+ Registered implementation :
+
+<li>The registered implementation might not deliver some events on server stop.</li>
+
+<li>The registered implementation is tight to limitation of the underlying publisher, and underlying registration system.</li>
+ </ul>
+
+
+<div class="section">
+<h2>Publisher<a name="Publisher"></a></h2>
+
+
+<p>
+ Available implementation is Kafka based. Kafka ensure at least one delivery. This means some messages might be
+ delivered two times. You need to compile and run James using Java 8 in order to use the Kafka messaging system.
+ </p>
+
+
+<div class="section">
+<h2>Event serializer<a name="Event_serializer"></a></h2>
+
+
+<p>There are two types of event serialization systems :
+ </p>
+<ul>
+
+<li>Json : events are converted to JSON</li>
+
+<li>Message Pack : a binary representation of JSON. 2 times smaller in average but two times longer to compute. It allows you to trade
+ bandwidth and data readability against CPU time.</li>
+ </ul>
+
+
+
+<div class="section">
+<h2>Registration systems<a name="Registration_systems"></a></h2>
+
+
+<p>
+ Available implementation is based on Cassandra. It is used on an AP fashion, enforcing availability instead of consistency. Some
+ messages might get delivered to no more registered servers. This is just extra work. Worst, messages might not be delivered to
+ recently registered servers. But we make sure that we have the more up to date version of the registrations we can, and will not time out in
+ the face of network partitions, nor enforce some default behaviour.
+ </p>
+
+ </div>
+
+
+
+
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">Copyright © 2002-2016
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: james/site/trunk/www/server/3/config-guice.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/server/3/config-guice.html?rev=1728624&view=auto
==============================================================================
--- james/site/trunk/www/server/3/config-guice.html (added)
+++ james/site/trunk/www/server/3/config-guice.html Fri Feb 5 10:11:10 2016
@@ -0,0 +1,415 @@
+<?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 2016-02-05 -->
+<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>Apache James Server 3.0 -
+ Apache James Server 3 - Guice configuration</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="Date-Revision-yyyymmdd" content="20160205" />
+ <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-server-logo.gif">
+
+
+ <img src="images/logos/james-server-logo.gif" alt="Apache James Server 3.0" />
+ </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: 2016-02-05</span>
+ </div>
+ <div class="xright"> <a href="../../index.html" title="Home">Home</a>
+ |
+ <a href="../index.html" title="Server">Server</a>
+ |
+ <a href="../../hupa/index.html" title="Hupa">Hupa</a>
+ |
+ <a href="../../protocols/index.html" title="Protocols">Protocols</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>Overview</h5>
+ <ul>
+ <li class="none">
+ <a href="index.html" title="Introduction">Introduction</a>
+ </li>
+ <li class="none">
+ <a href="release-notes.html" title="Release Notes">Release Notes</a>
+ </li>
+ </ul>
+ <h5>Features</h5>
+ <ul>
+ <li class="none">
+ <a href="feature-mailetcontainer.html" title="Mailet Container">Mailet Container</a>
+ </li>
+ <li class="none">
+ <a href="feature-queue-priority.html" title="Queue Priority">Queue Priority</a>
+ </li>
+ <li class="none">
+ <a href="feature-persistence.html" title="Persistence">Persistence</a>
+ </li>
+ <li class="none">
+ <a href="feature-protocols.html" title="Protocols">Protocols</a>
+ </li>
+ <li class="none">
+ <a href="feature-smtp-hooks.html" title="SMTP Hooks">SMTP Hooks</a>
+ </li>
+ <li class="none">
+ <a href="feature-performance.html" title="Performance">Performance</a>
+ </li>
+ <li class="none">
+ <a href="feature-security.html" title="Security">Security</a>
+ </li>
+ </ul>
+ <h5>User Manual</h5>
+ <ul>
+ <li class="none">
+ <a href="quick-start.html" title="1. Quick Start">1. Quick Start</a>
+ </li>
+ <li class="none">
+ <a href="install.html" title="2. Install James">2. Install James</a>
+ </li>
+ <li class="collapsed">
+ <a href="config.html" title="3. Configure James">3. Configure James</a>
+ </li>
+ <li class="collapsed">
+ <a href="manage.html" title="4. Manage">4. Manage</a>
+ </li>
+ <li class="collapsed">
+ <a href="monitor.html" title="5. Monitor">5. Monitor</a>
+ </li>
+ <li class="collapsed">
+ <a href="upgrade.html" title="6. Upgrade">6. Upgrade</a>
+ </li>
+ </ul>
+ <h5>Developers Corner</h5>
+ <ul>
+ <li class="none">
+ <a href="dev.html" title="Architecture">Architecture</a>
+ </li>
+ <li class="none">
+ <a href="dev-build.html" title="Build from source">Build from source</a>
+ </li>
+ <li class="none">
+ <a href="dev-database-schema.html" title="Database Schema">Database Schema</a>
+ </li>
+ <li class="collapsed">
+ <a href="dev-extend.html" title="Develop Extensions">Develop Extensions</a>
+ </li>
+ <li class="collapsed">
+ <a href="dev-provided.html" title="Provided Extensions">Provided Extensions</a>
+ </li>
+ </ul>
+ <h5>References</h5>
+ <ul>
+ <li class="none">
+ <a href="apidocs/index.html" title="Javadoc">Javadoc</a>
+ </li>
+ <li class="none">
+ <a href="https://issues.apache.org/jira/browse/JAMES" title="Issue Tracker">Issue Tracker</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>
+ </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>Guice configure Apache James Server<a name="Guice_configure_Apache_James_Server"></a></h2>
+
+
+<p>Such configuration is only developed for Cassandra backend.</p>
+
+<p>You are encouraged to contribute by developing a new backend guice module.
+ Have a look to the <i>james-server-cassandra-guice</i> artifact.
+ </p>
+
+
+<p>We provide a sample-configuration folder with needed files to run James.
+ You can start by copying it and modify these files according to your needs.</p>
+
+
+<p>You can/must configure James for the following:</p>
+
+
+<table border="0" class="bodyTable">
+
+
+<tr class="a">
+
+<th>Config File Sample</th>
+
+<th>Config Area</th>
+
+<th>Config Comment</th>
+ </tr>
+
+
+<tr class="b">
+
+<td><a class="externalLink" href="http://svn.apache.org/repos/asf/james/server/trunk/app/src/main/resources/cassandra-template.properties">cassandra-template.properties</a></td>
+
+<td><a href="config-cassandra.html">Cassandra Configuration</a></td>
+
+<td></td>
+ </tr>
+
+<tr class="a">
+
+<td><a class="externalLink" href="http://svn.apache.org/repos/asf/james/server/trunk/app/src/main/resources/dnsservice-template.xml">dnsservice.xml</a></td>
+
+<td><a href="config-dnsservice.html">DNS Service Configuration</a></td>
+
+<td></td>
+ </tr>
+
+<tr class="b">
+
+<td><a class="externalLink" href="http://svn.apache.org/repos/asf/james/server/trunk/app/src/main/resources/elasticsearch-template.properties">elasticsearch-template.properties</a></td>
+
+<td><a href="config-elasticsearch.html">ElasticSearch Configuration</a></td>
+
+<td></td>
+ </tr>
+
+<tr class="a">
+
+<td><a class="externalLink" href="http://svn.apache.org/repos/asf/james/server/trunk/app/src/main/resources/imapserver-template.xml">imapserver.xml</a></td>
+
+<td><a href="config-imap4.html">IMAP4 Configuration</a></td>
+
+<td></td>
+ </tr>
+
+<tr class="b">
+
+<td><a class="externalLink" href="http://svn.apache.org/repos/asf/james/server/trunk/app/src/main/resources/lmtpserver-template.xml">lmtpserver.xml</a></td>
+
+<td><a href="config-smtp-lmtp.html">LMTP Configuration</a></td>
+
+<td></td>
+ </tr>
+
+<tr class="a">
+
+<td><a class="externalLink" href="http://svn.apache.org/repos/asf/james/server/trunk/app/src/main/resources/mailetcontainer-template.xml">mailetcontainer.xml</a></td>
+
+<td><a href="config-mailetcontainer.html">Mailet Container Configuration</a></td>
+
+<td></td>
+ </tr>
+
+<tr class="b">
+
+<td><a class="externalLink" href="http://svn.apache.org/repos/asf/james/server/trunk/app/src/main/resources/pop3server-template.xml">pop3server.xml</a></td>
+
+<td><a href="config-pop3.html">POP3 Configuration</a></td>
+
+<td></td>
+ </tr>
+
+<tr class="a">
+
+<td><a class="externalLink" href="http://svn.apache.org/repos/asf/james/server/trunk/app/src/main/resources/smtpserver-template.xml">smtpserver.xml</a></td>
+
+<td><a href="config-smtp-lmtp.html">SMTP Configuration</a></td>
+
+<td></td>
+ </tr>
+
+ </table>
+
+
+<p>See also more specific configurations related to <a href="config-ssl-tls.html">TLS</a>,
+ <a href="config-sieve.html">Sieve</a> and
+ <a href="config-antispam.html">Antispam</a>.</p>
+
+ </div>
+
+
+
+
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">Copyright © 2002-2016
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: james/site/trunk/www/server/3/config-quota.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/server/3/config-quota.html?rev=1728624&view=auto
==============================================================================
--- james/site/trunk/www/server/3/config-quota.html (added)
+++ james/site/trunk/www/server/3/config-quota.html Fri Feb 5 10:11:10 2016
@@ -0,0 +1,394 @@
+<?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 2016-02-05 -->
+<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>Apache James Server 3.0 -
+ Apache James Server 3 - Quota Configuration</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="Date-Revision-yyyymmdd" content="20160205" />
+ <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-server-logo.gif">
+
+
+ <img src="images/logos/james-server-logo.gif" alt="Apache James Server 3.0" />
+ </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: 2016-02-05</span>
+ </div>
+ <div class="xright"> <a href="../../index.html" title="Home">Home</a>
+ |
+ <a href="../index.html" title="Server">Server</a>
+ |
+ <a href="../../hupa/index.html" title="Hupa">Hupa</a>
+ |
+ <a href="../../protocols/index.html" title="Protocols">Protocols</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>Overview</h5>
+ <ul>
+ <li class="none">
+ <a href="index.html" title="Introduction">Introduction</a>
+ </li>
+ <li class="none">
+ <a href="release-notes.html" title="Release Notes">Release Notes</a>
+ </li>
+ </ul>
+ <h5>Features</h5>
+ <ul>
+ <li class="none">
+ <a href="feature-mailetcontainer.html" title="Mailet Container">Mailet Container</a>
+ </li>
+ <li class="none">
+ <a href="feature-queue-priority.html" title="Queue Priority">Queue Priority</a>
+ </li>
+ <li class="none">
+ <a href="feature-persistence.html" title="Persistence">Persistence</a>
+ </li>
+ <li class="none">
+ <a href="feature-protocols.html" title="Protocols">Protocols</a>
+ </li>
+ <li class="none">
+ <a href="feature-smtp-hooks.html" title="SMTP Hooks">SMTP Hooks</a>
+ </li>
+ <li class="none">
+ <a href="feature-performance.html" title="Performance">Performance</a>
+ </li>
+ <li class="none">
+ <a href="feature-security.html" title="Security">Security</a>
+ </li>
+ </ul>
+ <h5>User Manual</h5>
+ <ul>
+ <li class="none">
+ <a href="quick-start.html" title="1. Quick Start">1. Quick Start</a>
+ </li>
+ <li class="none">
+ <a href="install.html" title="2. Install James">2. Install James</a>
+ </li>
+ <li class="collapsed">
+ <a href="config.html" title="3. Configure James">3. Configure James</a>
+ </li>
+ <li class="collapsed">
+ <a href="manage.html" title="4. Manage">4. Manage</a>
+ </li>
+ <li class="collapsed">
+ <a href="monitor.html" title="5. Monitor">5. Monitor</a>
+ </li>
+ <li class="collapsed">
+ <a href="upgrade.html" title="6. Upgrade">6. Upgrade</a>
+ </li>
+ </ul>
+ <h5>Developers Corner</h5>
+ <ul>
+ <li class="none">
+ <a href="dev.html" title="Architecture">Architecture</a>
+ </li>
+ <li class="none">
+ <a href="dev-build.html" title="Build from source">Build from source</a>
+ </li>
+ <li class="none">
+ <a href="dev-database-schema.html" title="Database Schema">Database Schema</a>
+ </li>
+ <li class="collapsed">
+ <a href="dev-extend.html" title="Develop Extensions">Develop Extensions</a>
+ </li>
+ <li class="collapsed">
+ <a href="dev-provided.html" title="Provided Extensions">Provided Extensions</a>
+ </li>
+ </ul>
+ <h5>References</h5>
+ <ul>
+ <li class="none">
+ <a href="apidocs/index.html" title="Javadoc">Javadoc</a>
+ </li>
+ <li class="none">
+ <a href="https://issues.apache.org/jira/browse/JAMES" title="Issue Tracker">Issue Tracker</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>
+ </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>Quota Configuration<a name="Quota_Configuration"></a></h2>
+
+
+<p>Consult <a class="externalLink" href="http://svn.apache.org/repos/asf/james/server/trunk/app/src/main/resources/quota-template.xml">quota-template.xml</a> in SVN to get some examples and hints.</p>
+
+
+<p>Use this configuration to define the type of quota storage used to persist the quotas.</p>
+
+
+<p>This allow you to configure the behaviour of your James server in regard of the RFC 2087 Quotas.</p>
+
+
+<p><a class="externalLink" href="https://tools.ietf.org/html/rfc2087">RFC 2087</a> introduces Quotas. A quota is related to a resource. In James, resources are MESSAGE (message count) and
+ STORAGE (size occupied by the messages in bytes). A quota is composed of two values. The first one is the maximum value
+ related to the value. The second one is the current value of the resource. Quota are handled for a Quota Root, a (potentially
+ configurable group of mailboxes.</p>
+
+
+<p>
+ The goal of RFC-2087 and related James implementation is to forbid users to exceed a given value for available resources.
+ </p>
+
+
+<p>
+ James' implementation is split in different components, and each one of them gets its own responsibility :
+
+ </p>
+<ul>
+
+<li>Quota Root Resolver : This component is responsible of the correspondence between mailboxes and QUOTA ROOT. A default implementation is
+ available and simply group mailboxes in QUOTA ROOT on the base of the owner name.</li>
+
+<li>Quota Manager : This component retrieves quota associated with a QUOTA ROOT. A store implementation is available and relies on other components.
+ A fake implementation is available in order to add no overhead.</li>
+
+<li>Max Quota Manager : This component retrieves maximum values associated with quotas and gives a way to potentially
+ (depending on the implementation) update these per QUOTA ROOT maximum values. Three implementation are available for now. A NoQuotaManager implementation
+ is read only and returns UNLIMITED maximum values. FixedMaxQuotaManager returns one and only one value for all user. You can configure these maximum values
+ threw the configuration files. A InMemoryPerUserMaxQuotaManager allows you to configure quota for each QUOTA ROOT. Note that it needs to be done threw
+ configuration to be persistent. And finally a Cassandra implementation allows to store maximum quota values in Cassandra.</li>
+
+<li>Current Quota Manager : This component can be omitted if you are running a fake QUOTA manager. inmemory implementation is an event updated cache on
+ top of a Quota calculator (that fetches every e-mail metadata of every mailboxes belonging to the QUOTA ROOT: it is expensive). A cassandra implementation
+ is also available.</li>
+
+<li>Quota Updater : This components allows to update current quota values. A fake implementation is available. A real, event base solution also exists.</li>
+ </ul>
+
+
+
+<p>
+ To choose the implementation you want for the given components you want simply have a look to the <a class="externalLink" href="http://svn.apache.org/repos/asf/james/server/trunk/app/src/main/resources/quota-template.xml">quota-template.xml</a> file.
+ </p>
+
+
+<p>
+ Quota integration consists of :
+
+ </p>
+<ul>
+
+<li>Checks in the message manager. An operation that will bring the QUOTA ROOT over quota will be dropped. APPEND and COPY operations are concerned.</li>
+
+<li>A matcher is available (IsOverQuota) to better respond to client sending e-mail via SMTP to an over quota mailbox (and prevent the e-mail from being
+ stored in MailRepositories). This matcher just performs a call to the Quota Manager, and is efficient.</li>
+
+<li>A user can consult his Quotas using RFC 2087 IMAP commands. Note that SETQUOTA command is disabled. No quota configuration can be done threw IMAP.</li>
+
+<li>CLI authorises an admin to consult and manage ones quotas.</li>
+ </ul>
+
+
+
+<p>
+ The administration of QUOTAs can be done :
+
+ </p>
+<ul>
+
+<li>Threw configuration file. Note that this is required to persist a change made to the inmemory or fixed Max Quota
+ Manager. It needs a James reboot to take effect. Finally, using configuration file for setting maximum quota values
+ will override CLI set values. Avoid this option this persistent Max Quota Manager (for instance Cassandra)</li>
+
+<li>Threw the CLI : offers immediate configuration changes on quota maximum values. Note that if you are using either a
+ fixed or inmemory Max QUota Manager, your changes need to be done to the XML configuration to be persisted.</li>
+ </ul>
+
+
+ </div>
+
+
+
+
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">Copyright © 2002-2016
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>