You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by er...@apache.org on 2011/04/12 15:48:55 UTC
svn commit: r1091410 - in /james/server/trunk/src/site/xdoc:
config-mailbox.xml config-mailetcontainer.xml
config-recipientrewritetable.xml config-users.xml
Author: eric
Date: Tue Apr 12 13:48:55 2011
New Revision: 1091410
URL: http://svn.apache.org/viewvc?rev=1091410&view=rev
Log:
User and Mailbox configuration documentation (JAMES-1219)
Modified:
james/server/trunk/src/site/xdoc/config-mailbox.xml
james/server/trunk/src/site/xdoc/config-mailetcontainer.xml
james/server/trunk/src/site/xdoc/config-recipientrewritetable.xml
james/server/trunk/src/site/xdoc/config-users.xml
Modified: james/server/trunk/src/site/xdoc/config-mailbox.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/config-mailbox.xml?rev=1091410&r1=1091409&r2=1091410&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/config-mailbox.xml (original)
+++ james/server/trunk/src/site/xdoc/config-mailbox.xml Tue Apr 12 13:48:55 2011
@@ -28,9 +28,19 @@
<section name="Mailbox Configuration">
<p>Consult <a href="https://svn.apache.org/repos/asf/james/server/tags/james-server-3.0-M3/container-spring/src/main/config/examples/mailbox.xml">mailbox.xml</a> in SVN to get some examples and hints.</p>
+
+ <p>Use this configuration to define the type of mailbox storage used to persist the user's mails.</p>
+
+ <p>Under maibox tag, define the provider.</p>
+
+ <dl>
+ <dt><strong>provider</strong></dt>
+ <dd>Supported providers are: jpa (default), jcr, maildir, memory. Be aware that maildir will only work on unix like operation systems!</dd>
+ </dl>
</section>
</body>
</document>
+
Modified: james/server/trunk/src/site/xdoc/config-mailetcontainer.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/config-mailetcontainer.xml?rev=1091410&r1=1091409&r2=1091410&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/config-mailetcontainer.xml (original)
+++ james/server/trunk/src/site/xdoc/config-mailetcontainer.xml Tue Apr 12 13:48:55 2011
@@ -37,6 +37,7 @@
<li>All custom mailets must be specified with full package prefix</li>
<li>Package prefixed custom mailet names will be searched across the entire applicable class path</li>
<li>Composite matchers</li>
+ </ul>
<!--
<matcher name="anyname" match="org.apache.james.mailetcontainer.lib.matcher.And">
<matcher match="SenderIs...."/>
@@ -44,7 +45,29 @@
</matcher>
<mailet match="anyname" class="MailetX"/>
-->
- </ul>
+ <p>This configuration block is defined by the <strong>mailserver</strong> tag. All administrators
+ need to adjust the <strong>mailserver</strong> block upon installation.</p>
+
+ <dl>
+ <dt><strong>postmaster</strong></dt>
+ <dd>The body of this element is the address that the server
+ will consider its postmaster address. This address will be listed as the sender address
+ of all error messages that originate from James. Also, all messages addressed to
+ postmaster@<servername>, where <servername> is one of the domain names whose
+ mail is being handled by James, will be redirected to this email address.
+ Set this to the appropriate email address for error reports
+ If this is set to a non-local email address, the mail server
+ will still function, but will generate a warning on startup.</dd>
+ <dt><strong>enableVirtualHosting</strong></dt>
+ <dd>Set to true to support virtualHosting. If virtualHosting support
+ is enabled the server will accept thread every user independ on domain level.</dd>
+ <dt><strong>key</strong></dt>
+ <dd>value.</dd>
+ <dt><strong>defaultDomain</strong></dt>
+ <dd>Set the default domain which will be used if an email is send to a recipient without a domain part.
+ If not defaultdomain is set the first domain of the DomainList get used.</dd>
+ </dl>
+
<!--
<p>The SpoolManager is controlled by a single configuration block in the mailetcontainer.xml.
The spoolmanager tag defines the boundaries of the configuration block. The behavior of
@@ -132,7 +155,7 @@
would be passed to the matcher. The Mailet of the pair will be an instance of ToProcessor, and it will be passed the (name, value)
pair of ("processor", "spam").</p>
- <p>James includes a number of pre-packaged Mailets and Matchers. A list of provided Mailets may be found
+ <p>Apache James Server includes a number of pre-packaged Mailets and Matchers. A list of provided Mailets may be found
<a href="provided-mailets.html">here</a>. A list of provided Matchers may be found <a href="provided-matchers.html">here</a>.</p>
</subsection>
Modified: james/server/trunk/src/site/xdoc/config-recipientrewritetable.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/config-recipientrewritetable.xml?rev=1091410&r1=1091409&r2=1091410&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/config-recipientrewritetable.xml (original)
+++ james/server/trunk/src/site/xdoc/config-recipientrewritetable.xml Tue Apr 12 13:48:55 2011
@@ -29,8 +29,58 @@
<p>Consult <a href="https://svn.apache.org/repos/asf/james/server/tags/james-server-3.0-M3/container-spring/src/main/config/examples/recipientrewritetable.xml">recipientrewritetable.xml</a> in SVN to get some examples and hints.</p>
- </section>
+ <subsection name="JPA Recipient Rewrite Table">
+
+ <p>The default table for storing James' Recipient Rewrite mappings.</p>
+
+ <p>Add a class attribute to recipientrewritetable tag (class="org.apache.james.rrt.jpa.JPARecipientRewriteTable).</p>
+
+ <dl>
+ <dt><strong>recursiveMapping</strong></dt>
+ <dd>If set recursiveMapping false only the first mapping will get processed - Default true.</dd>
+ <dt><strong>mappingLimit</strong></dt>
+ <dd>By setting the mappingLimit you can specify how much mapping will get processed before a bounce will send. This avoid infinity loops. Default 10.</dd>
+ </dl>
+
+ </subsection>
+
+ <subsection name="XML Recipient Rewrite Table">
+
+ <p>Add a class attribute to recipientrewritetable tag (class="org.apache.james.rrt.xml.XMLRecipientRewriteTable).</p>
+
+ <dl>
+ <dt><strong>recursiveMapping</strong></dt>
+ <dd>If set recursiveMapping false only the first mapping will get processed - Default true.</dd>
+ <dt><strong>mappingLimit</strong></dt>
+ <dd>By setting the mappingLimit you can specify how much mapping will get processed before a bounce will send. This avoid infinity loops. Default 10.</dd>
+ <dt><strong>mapping</strong></dt>
+ <dd>Example: some@domain=someuser</dd>
+ </dl>
+
+ </subsection>
+
+ <subsection name="JDBC Recipient Rewrite Table">
+
+ <p>Database backed RecipientRewrite table</p>
+
+ <p>Add a class attribute and a destinationURL attributed to recipientrewritetable tag (class="org.apache.james.rrt.jdbc.JDBCRecipientRewriteTable" destinationURL="db://maildb/RecipientRewriteTable").</p>
+
+ <p>Use these configurations to store the RecipientRewriteTable in a database.</p>
+
+ <dl>
+ <dt><strong>recursiveMapping</strong></dt>
+ <dd>If set recursiveMapping false only the first mapping will get processed - Default true.</dd>
+ <dt><strong>mappingLimit</strong></dt>
+ <dd>By setting the mappingLimit you can specify how much mapping will get processed before a bounce will send. This avoid infinity loops. Default 10.</dd>
+ <dt><strong>sqlFile</strong></dt>
+ <dd>file://conf/sqlResources.xml</dd>
+ </dl>
+
+ </subsection>
+
+ </section>
</body>
</document>
+
Modified: james/server/trunk/src/site/xdoc/config-users.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/config-users.xml?rev=1091410&r1=1091409&r2=1091410&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/config-users.xml (original)
+++ james/server/trunk/src/site/xdoc/config-users.xml Tue Apr 12 13:48:55 2011
@@ -25,17 +25,70 @@
<body>
- <section name="Users Configuration">
+ <section name="Users Repositories">
+
+ <p>User repositories are required to store James user information and authentication data</p>
<p>Consult <a href="https://svn.apache.org/repos/asf/james/server/tags/james-server-3.0-M3/container-spring/src/main/config/examples/usersrepository.xml">usersrepository.xml</a> in SVN to get some examples and hints.</p>
- <subsection name="JPA Users">
+ <subsection name="JPA Users Repository">
+ <p>JPA (database via OpenJPA) based user repository. This is the default implementation.</p>
+
+ <p>The usersrepository tag as 2 attributes: name="LocalUsers" and class="org.apache.james.user.file.UsersFileRepository"></p>
+
+ <dl>
+ <dt><strong>algorithm</strong></dt>
+ <dd>Algorithm to has passwords. Supported password algorithm are: MD5, SHA-256, SHA-512, NONE</dd>
+ <dt><strong>enableVirtualHosting</strong></dt>
+ <dd>true (default) or false. Defines if the usernames must (true) or may not contain (false) a domain part (user@domain.tld).</dd>
+ </dl>
+
</subsection>
- <subsection name="LDAP Users">
+ <subsection name="File Users Repository">
+
+ <p>The File UsersRepository implementations below are DEPRECATED and will get removed in the next release</p>
+ <p>It just listed here for backward-compatibility</p>
+
+ <p>File-based user repositories Use these configurations to store user info in the filesystem.</p>
+
+ <p>The usersrepository tag as 2 attributes:name="LocalUsers" class="org.apache.james.user.file.UsersFileRepository"></p>
+
+ <dl>
+ <dt><strong>destination</strong></dt>
+ <dd>Example: file://var/users/.</dd>
+ <dt><strong>ignoreCase</strong></dt>
+ <dd>true or false.</dd>
+ <dt><strong>enableAliases</strong></dt>
+ <dd>true or false.</dd>
+ <dt><strong>enableForwarding</strong></dt>
+ <dd>true or false.</dd>
+ <dt><strong>enableVirtualHosting</strong></dt>
+ <dd>true (default) or false. Defines if the usernames must (true) or may not contain (false) a domain part (user@domain.tld).</dd>
+ </dl>
+
+ </subsection>
+
+ <subsection name="JDBC Users Repository">
+
+ <p>The JDBC UsersRepository implementations below are DEPRECATED and will get removed in the next release.</p>
+ <p>It just listed here for backward-compatibility.</p>
+
+ </subsection>
+
+ <subsection name="LDAP Users Repository">
+
+ <p>Read-Only LDAP based UsersRepository</p>
+
+ <p>Example:</p>
+
+ <source>
+<repository name="LocalUsers" class="org.apache.james.user.ldap.ReadOnlyUsersLDAPRepository" ldapHost="ldap://myldapserver:389"
+ principal="uid=ldapUser,ou=system" credentials="password" userBase="ou=People,o=myorg.com,ou=system" userIdAttribute="uid"/></source>
+
<!--
- <p>This document explains how to enable JAMES to use an LDAP directory as a
+ <p>This section explains how to enable Apache James Server to use an LDAP directory as a
Users Repository.</p>
<p>We have tried to make the LDAP implementation of UsersRepository as
@@ -162,8 +215,7 @@
</table>
-->
<!--
- <p>
- Six entries in JAMES.conf.xml must be set for this to work:
+ <p>Six entries in JAMES.conf.xml must be set for this to work:
<ul>
<li>change usersManager - type to ldap.</li>
<li>Set the ldapServer element to point to the correct host and port</li>
@@ -177,12 +229,6 @@
</section>
- <section name="Virtual Users Configuration">
-
- <p>Consult <a href="https://svn.apache.org/repos/asf/james/server/tags/james-server-3.0-M3/container-spring/src/main/config/examples/recipientrewritetable.xml">recipientrewritetable.xml</a> in SVN to get some examples and hints.</p>
-
- </section>
-
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org