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/13 06:19:32 UTC
svn commit: r1091640 - in /james/server/trunk/src/site/xdoc:
config-mailrepositorystore.xml config-users.xml feature-persistence.xml
Author: eric
Date: Wed Apr 13 04:19:32 2011
New Revision: 1091640
URL: http://svn.apache.org/viewvc?rev=1091640&view=rev
Log:
mailrepository and users configuration documentation (JAMES-1219)
Modified:
james/server/trunk/src/site/xdoc/config-mailrepositorystore.xml
james/server/trunk/src/site/xdoc/config-users.xml
james/server/trunk/src/site/xdoc/feature-persistence.xml
Modified: james/server/trunk/src/site/xdoc/config-mailrepositorystore.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/config-mailrepositorystore.xml?rev=1091640&r1=1091639&r2=1091640&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/config-mailrepositorystore.xml (original)
+++ james/server/trunk/src/site/xdoc/config-mailrepositorystore.xml Wed Apr 13 04:19:32 2011
@@ -26,11 +26,84 @@
<body>
<section name="Mail Repository Store Configuration">
+
+ <subsection name="Introduction">
- <p>Consult <a href="https://svn.apache.org/repos/asf/james/server/tags/james-server-3.0-M3/container-spring/src/main/config/examples/mailrepositorystore.xml">mailrepositorystore.xml</a> in SVN to get some examples and hints.</p>
+ <p>Read <a href="feature-persistence.html" for a description of the Mail Repository Store functionality.</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/mailrepositorystore.xml">mailrepositorystore.xml</a> in SVN to get some examples and hints.</p>
+ <p>Mail Repository Stores are distinguished by where they store data. There are five types of
+ storage: File, Database, DBFile, MBox and JCR.</p>
+
+ </subsection>
+
+ <subsection name="File Repositories">
+
+ <p>File-based repositories store all data in the file system. In general, these repositories are extremely
+ simple to configure, but may compare poorly in terms of performance when compared to other repository
+ types. File repositories are not recommended for large or performance-critical configurations. In the
+ default configuration, all repositories are file repositories.</p>
+
+ <p>File repository paths typically begin with the prefix "file". Paths are relative to the application
+ base directory, unless the path begins with a slash. As an example, assume that James is running in
+ /usr/james/phoenix/apps/james. Then "file://var/mail/spool/" would refer to the directory /usr/james/phoenix/apps/james/var/mail/spool.
+ And "file:///var/mail/spool/" (note the extra '/') would refer to the directory /var/mail/spool.</p>
+
+ <p>All repository types (mail, spool, user, and news) have file-based implementations. No special configuration is required to enable file-based repositories</p>
+
+ <!-- File based repositories. These repositories store all message data -->
+ <!-- in the file system. -->
+
+ </subsection>
+
+ <subsection name="Database (JDBC) Repositories">
+
+ <p>These repositories store all message data in the database.</p>
+
+ <p>Database repositories store all data in an administrator-supplied database. Configuration is somewhat
+ more complex, requiring that the administrator adjust the data-connections section. Detailed directions
+ are included in the sample configuration file. The administrator will need to know the JDBC driver class,
+ the appropriate URL for use with his database, and a valid username/password for the database.</p>
+
+ <p>If the administrator wants to configure a database other than MySQL, it will be necessary to add the jar
+ or zip file containing the JDBC driver classes to the lib subdirectory of the installation directory. This
+ will allow Apache James Server to properly load the driver when it is initializing the database repository.</p>
+
+ <p>Database repository paths typically begin with the prefix "db". The format is "db://<data-source>/<table>"
+ where <data-source> is the name of the data-source defined in the data-connections section. And <table> is
+ the particular table associated with the repository.</p>
+
+ </subsection>
+
+ <subsection name="DBFile Repositories">
+
+ <p>These repositories store message delivery and headers in the DB, and the body to the filesystem.</p>
+
+ <p>This is a special repository type used only for mail repositories. DBFile repositories store the body of
+ a mail message in the file system, while headers are stored in the database. This allows the administrator
+ to minimize the size of data stored in the database, while conserving most of the performance of the
+ database repository.</p>
+
+ </subsection>
+
+ <subsection name="MBox Repositories">
+
+ <p>The MBox file format repository.<.p>
+
+ </subsection>
+
+ <subsection name="JCR Repositories">
+
+ <p>Store mails in a JCR (Java Content Repository) based implementation.</p>
+
+ <p>If you enable this you need to make sure that embedded Jackrabbit instance is started as well. Check the container configuration</p>
+
+ </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=1091640&r1=1091639&r2=1091640&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/config-users.xml (original)
+++ james/server/trunk/src/site/xdoc/config-users.xml Wed Apr 13 04:19:32 2011
@@ -27,10 +27,14 @@
<section name="Users Repositories">
- <p>User repositories are required to store James user information and authentication data</p>
+ <subsection name="Introduction">
- <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>
-
+ <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>
+
<subsection name="JPA Users Repository">
<p>JPA (database via OpenJPA) based user repository. This is the default implementation.</p>
Modified: james/server/trunk/src/site/xdoc/feature-persistence.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/feature-persistence.xml?rev=1091640&r1=1091639&r2=1091640&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/feature-persistence.xml (original)
+++ james/server/trunk/src/site/xdoc/feature-persistence.xml Wed Apr 13 04:19:32 2011
@@ -25,109 +25,61 @@
<body>
- <section name="Mailbox and Mailstore">
+ <section name="Mail Persistence: Mailbox and Mail Repository Store">
- <p><u><b>Mailbox</b> is for users' Inbox, Sent Items, Trash... folders</u>.</p>
+ <subsection name="Introduction">
+
+ <p>The <u><b>Mailbox</b> persists users' Inbox, Sent Items, Trash... folders</u> with their mails.</p>
- <p><u><b>Mailstore</b> is for spam, error,... mails, so nothing to do with users visible mails</u>.</p>
-
- <p>Both mailbox and mailstore use database connection defined via database.properties
- in case of database access.</p>
-
- </section>
+ <p>The <u><b>Mail Repository Store</b> persists spam, error,... mails, so nothing to do with users visible mails</u>.
+ The Mail Respos</p>
- <section name="Mailbox Persistence">
+ <p>In case of database access, both Mailbox and Mail Repository Store use database connection defined via database.properties.</p>
+
+ </subsection>
+
+ <subsection name="Mailbox Persistence">
- <p>James Server uses the <a href="http://james.apache.org/mailbox">mailbox</a> storage system
- to store the users mailboxes.</p>
+ <p>Apache James Server uses the <a href="http://james.apache.org/mailbox">Apache James Mailbox</a> storage system
+ to store the users mailboxes.</p>
- <p>The mailbox library supports different persistence mecanisms: MailDir, Database (via JPA) and JCR.</p>
+ <p>The mailbox library supports different persistence mecanisms: MailDir, Database (via JPA) and JCR.</p>
- <p>Mailbox persistence is configured in spring-beans.xml (by default JPA,
- you set the database connection properties in database.properties - can also be
- MailDir, JCR).</p>
+ <p>Mailbox persistence is configured in spring-beans.xml (by default JPA,
+ you set the database connection properties in database.properties - can also be
+ MailDir, JCR).</p>
- </section>
+ </subsection>
- <section name="Mailstore Persistence">
+ <subsection name="Mail Repository Store Persistence">
- <subsection name="Repositories">
-
- <p>Available mailstore persistence (aka repository) are defined in mailstore.xml.
- Each has an URL prefix (file, db, dbfile,...) that can be used in mailetcontainer.xml
- to define where to store spam,... mails (example: file://var/mail/error/).</p>
+ <p>Available Mail Repository Store are defined in mailrepositorystore.xml.
+ Each has an URL prefix (file, db, dbfile,...) that can be used in mailetcontainer.xml
+ to define where to store spam,... mails (example: file://var/mail/error/).</p>
- <p>More information about the mailstores configuration can be
- found <a href="config-mailstores.html">here</a>.</p>
+ <p>More information about the mailstores configuration can be
+ found <a href="config-mailrepositorystores.html">here</a>.</p>
- <p>Mailstores are distinguished by where they store data. There are three types of
- storage - File, Database, and DBFile.</p>
+ <p>Mail Repository Stores are distinguished by how they store data. There are five types of
+ storage: File, Database, DBFile, MBox and JCR.</p>
</subsection>
- <subsection name="File Repositories">
-
- <p>File-based repositories store all data in the file system. In general, these repositories are extremely
- simple to configure, but may compare poorly in terms of performance when compared to other repository
- types. File repositories are not recommended for large or performance-critical configurations. In the
- default configuration, all repositories are file repositories.</p>
-
- <p>File repository paths typically begin with the prefix "file". Paths are relative to the application
- base directory, unless the path begins with a slash. As an example, assume that James is running in
- /usr/james/phoenix/apps/james. Then "file://var/mail/spool/" would refer to the directory /usr/james/phoenix/apps/james/var/mail/spool.
- And "file:///var/mail/spool/" (note the extra '/') would refer to the directory /var/mail/spool.</p>
-
- <p>All repository types (mail, spool, user, and news) have file-based implementations. No special configuration is required to enable file-based repositories</p>
-
- </subsection>
-
- <subsection name="Database (JDBC) Repositories">
-
- <p>Database repositories store all data in an administrator-supplied database. Configuration is somewhat
- more complex, requiring that the administrator adjust the data-connections section. Detailed directions
- are included in the sample configuration file. The administrator will need to know the JDBC driver class,
- the appropriate URL for use with his database, and a valid username/password for the database.</p>
-
- <p>If the administrator wants to configure a database other than MySQL, it will be necessary to add the jar
- or zip file containing the JDBC driver classes to the lib subdirectory of the installation directory. This
- will allow Phoenix to properly load the driver when it is initializing the database repository. The MySQL
- driver is pre-packaged with James.</p>
-
- <p>Database repository paths typically begin with the prefix "db". The format is "db://<data-source>/<table>"
- where <data-source> is the name of the data-source defined in the data-connections section. And <table> is
- the particular table associated with the repository.</p>
-
- <p>Mail, spool, and user repositories have JDBC-based implementations.</p>
-
- </subsection>
-
- <subsection name="DBFile Repositories">
-
- <p>This is a special repository type used only for mail repositories. DBFile repositories store the body of
- a mail message in the file system, while headers are stored in the database. This allows the administrator
- to minimize the size of data stored in the database, while conserving most of the performance of the
- database repository.</p>
-
- <p>Only mail repositories have dbfile-based implementations.</p>
-
- </subsection>
-
- <subsection name="JCR Repositories">
-
- <p>Only user repositories have jcr-based implementations.</p>
-
- </subsection>
-
</section>
<section name="Domain Persistence">
+ <p>Read more on how to configure <a href="config-domainlist.html">domain persistence</a>.</p>
+
</section>
<section name="User Persistence">
+ <p>Read more on how to configure <a href="config-users.html">users persistence</a>.</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