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 bt...@apache.org on 2017/06/14 08:06:23 UTC
[08/21] james-project git commit: JAMES-1789 Specify which
configuration to use with which packaging
JAMES-1789 Specify which configuration to use with which packaging
Project: http://git-wip-us.apache.org/repos/asf/james-project/repo
Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/6782b966
Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/6782b966
Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/6782b966
Branch: refs/heads/master
Commit: 6782b9661fa64439c02f378406cada48538c2708
Parents: 907d717
Author: benwa <bt...@linagora.com>
Authored: Sat Jun 10 10:18:43 2017 +0700
Committer: benwa <bt...@linagora.com>
Committed: Wed Jun 14 15:01:35 2017 +0700
----------------------------------------------------------------------
src/site/xdoc/server/config-cassandra.xml | 2 ++
src/site/xdoc/server/config-domainlist.xml | 2 +-
src/site/xdoc/server/config-events.xml | 2 ++
src/site/xdoc/server/config-fetchmail.xml | 2 ++
src/site/xdoc/server/config-mailbox.xml | 2 ++
src/site/xdoc/server/config-quota.xml | 2 ++
.../xdoc/server/config-recipientrewritetable.xml | 2 +-
src/site/xdoc/server/config-system.xml | 4 +++-
src/site/xdoc/server/config-users.xml | 4 +++-
src/site/xdoc/server/config.xml | 17 ++++++++++++-----
10 files changed, 30 insertions(+), 9 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/james-project/blob/6782b966/src/site/xdoc/server/config-cassandra.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/server/config-cassandra.xml b/src/site/xdoc/server/config-cassandra.xml
index 6def65d..61ed173 100644
--- a/src/site/xdoc/server/config-cassandra.xml
+++ b/src/site/xdoc/server/config-cassandra.xml
@@ -27,6 +27,8 @@
<section name="Cassandra Configuration">
+ Note: Cassandra is only available with Guice distributions (cassandra-guice and cassandra-guice-ldap).
+
<p>Consult <a href="https://github.com/apache/james-project/tree/master/server/app/src/main/resources/cassandra-template.properties">cassandra-template.properties</a> to get some examples and hints.</p>
<dl>
http://git-wip-us.apache.org/repos/asf/james-project/blob/6782b966/src/site/xdoc/server/config-domainlist.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/server/config-domainlist.xml b/src/site/xdoc/server/config-domainlist.xml
index ef7a33d..2c46dbe 100644
--- a/src/site/xdoc/server/config-domainlist.xml
+++ b/src/site/xdoc/server/config-domainlist.xml
@@ -31,7 +31,7 @@
<p>This configuration block is defined by the <strong>domainlist</strong> tag.</p>
- <p>You must specify the DomainList class as attribute of the domainlist tag (org.apache.james.domainlist.jpa.JPADomainList, or org.apache.james.domainlist.xml.XMLDomainList, or...)</p>
+ <p>Using Spring, you must specify the DomainList class as attribute of the domainlist tag (org.apache.james.domainlist.jpa.JPADomainList, or org.apache.james.domainlist.xml.XMLDomainList, or...). This have no effect when using Guice.</p>
<dl>
<dt><strong>domainnames</strong></dt>
http://git-wip-us.apache.org/repos/asf/james-project/blob/6782b966/src/site/xdoc/server/config-events.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/server/config-events.xml b/src/site/xdoc/server/config-events.xml
index 62dfa51..4a5d887 100644
--- a/src/site/xdoc/server/config-events.xml
+++ b/src/site/xdoc/server/config-events.xml
@@ -27,6 +27,8 @@
<section name="Events System Configuration">
+ This configuration applies only to Spring packaging.
+
<p>Consult <a href="https://github.com/apache/james-project/tree/master/server/app/src/main/resources/events-template.xml">events-template.xml</a> in GIT to get some examples and hints.</p>
<p>Use this configuration to define the type of Event System you want.</p>
http://git-wip-us.apache.org/repos/asf/james-project/blob/6782b966/src/site/xdoc/server/config-fetchmail.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/server/config-fetchmail.xml b/src/site/xdoc/server/config-fetchmail.xml
index f7afcfe..73d882e 100755
--- a/src/site/xdoc/server/config-fetchmail.xml
+++ b/src/site/xdoc/server/config-fetchmail.xml
@@ -27,6 +27,8 @@
<section name="Fetchmail Configuration">
+ This configuration file requires Spring packaging.
+
<p>Consult <a href="https://github.com/apache/james-project/tree/master/server/app/src/main/resources/fetchmail-template.xml">fetchmail-template.xml</a> in GIT to get some examples and hints.</p>
<p>Fetchmail acts as a gateway between an external message store such as an IMAP
http://git-wip-us.apache.org/repos/asf/james-project/blob/6782b966/src/site/xdoc/server/config-mailbox.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/server/config-mailbox.xml b/src/site/xdoc/server/config-mailbox.xml
index bfa149c..d556a64 100644
--- a/src/site/xdoc/server/config-mailbox.xml
+++ b/src/site/xdoc/server/config-mailbox.xml
@@ -27,6 +27,8 @@
<section name="Mailbox Configuration">
+ This configuration applies only to Spring packaging.
+
<p>Consult <a href="https://github.com/apache/james-project/tree/master/server/app/src/main/resources/mailbox-template.xml">mailbox-template.xml</a> in GIT 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>
http://git-wip-us.apache.org/repos/asf/james-project/blob/6782b966/src/site/xdoc/server/config-quota.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/server/config-quota.xml b/src/site/xdoc/server/config-quota.xml
index 74e6d34..17a494f 100644
--- a/src/site/xdoc/server/config-quota.xml
+++ b/src/site/xdoc/server/config-quota.xml
@@ -27,6 +27,8 @@
<section name="Quota Configuration">
+ This configuration applies only to Spring packaging.
+
<p>Consult <a href="https://github.com/apache/james-project/tree/master/server/app/src/main/resources/quota-template.xml">quota-template.xml</a> in GIT to get some examples and hints.</p>
<p>Use this configuration to define the type of quota storage used to persist the quotas.</p>
http://git-wip-us.apache.org/repos/asf/james-project/blob/6782b966/src/site/xdoc/server/config-recipientrewritetable.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/server/config-recipientrewritetable.xml b/src/site/xdoc/server/config-recipientrewritetable.xml
index d217a28..7de3248 100644
--- a/src/site/xdoc/server/config-recipientrewritetable.xml
+++ b/src/site/xdoc/server/config-recipientrewritetable.xml
@@ -33,7 +33,7 @@
<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>
+ <p>Using Spring, you should add a class attribute to recipientrewritetable tag (class="org.apache.james.rrt.jpa.JPARecipientRewriteTable). It has no effect with Guice packaging.</p>
<dl>
<dt><strong>recursiveMapping</strong></dt>
http://git-wip-us.apache.org/repos/asf/james-project/blob/6782b966/src/site/xdoc/server/config-system.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/server/config-system.xml b/src/site/xdoc/server/config-system.xml
index bb71839..e7c66c1 100644
--- a/src/site/xdoc/server/config-system.xml
+++ b/src/site/xdoc/server/config-system.xml
@@ -53,7 +53,9 @@
</subsection>
<subsection name="james-database.properties">
-
+
+ <p>This configuration file is only relevant when using JPA, with Spring or Guice.</p>
+
<p>Consult <a href="https://github.com/apache/james-project/tree/master/server/app/src/main/resources/james-database-template.properties">james-database.properties</a> in GIT to get some examples and hints.</p>
<p>The database connection in database.properties</p>
http://git-wip-us.apache.org/repos/asf/james-project/blob/6782b966/src/site/xdoc/server/config-users.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/server/config-users.xml b/src/site/xdoc/server/config-users.xml
index b3ef344..d259725 100644
--- a/src/site/xdoc/server/config-users.xml
+++ b/src/site/xdoc/server/config-users.xml
@@ -39,7 +39,9 @@
<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>
+ <p>The usersrepository tag as 2 attributes: name="LocalUsers" and class="org.apache.james.user.file.UsersFileRepository">
+ The class tag should be specified for Spring, but is not taken into acount by Guice.</p>
+
<dl>
<dt><strong>algorithm</strong></dt>
http://git-wip-us.apache.org/repos/asf/james-project/blob/6782b966/src/site/xdoc/server/config.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/server/config.xml b/src/site/xdoc/server/config.xml
index e5af722..613043c 100644
--- a/src/site/xdoc/server/config.xml
+++ b/src/site/xdoc/server/config.xml
@@ -29,10 +29,17 @@
<p>All configuration files resides in the ./conf and ./conf/META-INF folder.</p>
- <p>We ship with default configuration (embedded in jars) and -template files
+ <p>With default Spring packaging, we ship with default configuration (embedded in jars) and -template files
you can use to override the default configuration. Simply copy in conf folder *-template.xml
to *.xml (example: smtpserver-template.xml to smtpserver.xml), and change
in *.xml the settings to map your needs.</p>
+
+ <p> For Guice based packaging, you are encouraged to take a look at default configuration of the
+ <a href="https://github.com/apache/james-project/tree/master/dockerfiles/run/guice">James docker images</a>.</p>
+
+ <p>Please note that the configuration is dependent of the packaging you have chosen. Some configuration files are specific to
+ some back-ends, to some protocols. Please also note that some configuration files are not required for Guice. In this
+ case, it will be specified.</p>
<p>You can/must configure James for the following:</p>
@@ -61,17 +68,17 @@
</tr>
<tr>
<td><a href="https://github.com/apache/james-project/tree/master/server/app/src/main/resources/mailbox-template.xml">mailbox.xml</a></td>
- <td><a href="config-mailbox.html">Mailbox Configuration</a></td>
+ <td><a href="config-mailbox.html">Mailbox Configuration (Spring only)</a></td>
<td></td>
</tr>
<tr>
<td><a href="https://github.com/apache/james-project/tree/master/server/app/src/main/resources/quota-template.xml">mailbox.xml</a></td>
- <td><a href="config-quota.html">Quota Configuration</a></td>
+ <td><a href="config-quota.html">Quota Configuration (Spring only)</a></td>
<td></td>
</tr>
<tr>
<td><a href="https://github.com/apache/james-project/tree/master/server/app/src/main/resources/events-template.xml">events.xml</a></td>
- <td><a href="config-events.html">Event system Configuration</a></td>
+ <td><a href="config-events.html">Event system Configuration (Spring only)</a></td>
<td></td>
</tr>
<tr>
@@ -111,7 +118,7 @@
</tr>
<tr>
<td><a href="https://github.com/apache/james-project/tree/master/server/app/src/main/resources/fetchmail-template.xml">fetchmail.xml</a></td>
- <td><a href="config-fetchmail.html">FetchMail Configuration</a></td>
+ <td><a href="config-fetchmail.html">FetchMail Configuration (Spring only)</a></td>
<td></td>
</tr>
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org