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 2010/11/07 09:59:12 UTC
svn commit: r1032231 - in /james/server/trunk/src/site: ./ xdoc/
Author: eric
Date: Sun Nov 7 08:59:11 2010
New Revision: 1032231
URL: http://svn.apache.org/viewvc?rev=1032231&view=rev
Log:
Link to conf example from config pages.
Added:
james/server/trunk/src/site/xdoc/config-dnsservice.xml
- copied, changed from r1032226, james/server/trunk/src/site/xdoc/config-dns.xml
Removed:
james/server/trunk/src/site/xdoc/config-dns.xml
Modified:
james/server/trunk/src/site/site.xml
james/server/trunk/src/site/xdoc/config-domainlist.xml
james/server/trunk/src/site/xdoc/config-fetchmail.xml
james/server/trunk/src/site/xdoc/config-imap4.xml
james/server/trunk/src/site/xdoc/config-listmanager.xml
james/server/trunk/src/site/xdoc/config-mailetcontainer.xml
james/server/trunk/src/site/xdoc/config-mailstores.xml
james/server/trunk/src/site/xdoc/config-pop3.xml
james/server/trunk/src/site/xdoc/config-remotemanager.xml
james/server/trunk/src/site/xdoc/config-serverwide.xml
james/server/trunk/src/site/xdoc/config-smtp-lmtp.xml
james/server/trunk/src/site/xdoc/config-users.xml
james/server/trunk/src/site/xdoc/config.xml
james/server/trunk/src/site/xdoc/manage.xml
james/server/trunk/src/site/xdoc/monitor-logging.xml
james/server/trunk/src/site/xdoc/upgrade-2.3.xml
Modified: james/server/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/site.xml?rev=1032231&r1=1032230&r2=1032231&view=diff
==============================================================================
--- james/server/trunk/src/site/site.xml (original)
+++ james/server/trunk/src/site/site.xml Sun Nov 7 08:59:11 2010
@@ -62,7 +62,7 @@
<item name="Domain List" href="/config-domainlist.html" />
<item name="Users" href="/config-users.html" />
<item name="Mail Stores" href="/config-mailstores.html" />
- <item name="DNS" href="/config-dns.html" />
+ <item name="DNS Service" href="/config-dnsservice.html" />
<item name="IMAP4" href="/config-imap4.html" />
<item name="POP3" href="/config-pop3.html" />
<item name="SMTP LMTP" href="/config-smtp-lmtp.html" />
Copied: james/server/trunk/src/site/xdoc/config-dnsservice.xml (from r1032226, james/server/trunk/src/site/xdoc/config-dns.xml)
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/config-dnsservice.xml?p2=james/server/trunk/src/site/xdoc/config-dnsservice.xml&p1=james/server/trunk/src/site/xdoc/config-dns.xml&r1=1032226&r2=1032231&rev=1032231&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/config-dns.xml (original)
+++ james/server/trunk/src/site/xdoc/config-dnsservice.xml Sun Nov 7 08:59:11 2010
@@ -20,43 +20,60 @@
<document>
<properties>
- <title>James 3.0 - Configuring DNS Services</title>
+ <title>James 3.0 - Configuring DNS Service</title>
</properties>
<body>
<section name="DNS Configuration">
- <p>DNS Transport services are controlled by a configuration block in
- the dnsservice.xml. This block affects SMTP remote delivery.</p>
+ <subsection name="dnsservice.xml">
- <p>The dnsserver tag defines the boundaries of the configuration
- block. It encloses all the relevant configuration for the DNS server.
- The behavior of the DNS service is controlled by the attributes and
- children of this tag.</p>
-
- <p>The standard children of the dnsserver tag are:</p>
-
- <ul>
- <li><strong>servers</strong> - This is a list of DNS Servers to be used by James and are
- specified by one, or more <strong><i>server</i></strong> elements, which are child elements.
- Each server element is the IP address of a single DNS server.
- <source>
- <servers>
- <server>127.0.0.1</server>
- <server>166.181.194.205</server>
- </servers>
- </source>
- </li>
- <li><strong>authoritative</strong> - (<strong>true/false</strong>)This tag specifies whether or not
- to require authoritative (non-cached) DNS records; to only accept DNS responses that are
- authoritative for the domain. It is primarily useful in an intranet/extranet environment.
- <p>This should always be <strong>false</strong> unless you understand the implications.</p>
- </li>
- </ul>
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/dnsservice.xml">dnsservice.xml</a> Example.</p>
+ <p>DNS Transport services are controlled by a configuration block in
+ the dnsservice.xml. This block affects SMTP remote delivery.</p>
+
+ <p>The dnsservice tag defines the boundaries of the configuration
+ block. It encloses all the relevant configuration for the DNS server.
+ The behavior of the DNS service is controlled by the attributes and
+ children of this tag.</p>
+
+ <p>The standard children of the dnsservice tag are:</p>
+
+ <ul>
+ <li><strong>servernames</strong> - this element determines exactly which mail domains and IP
+ addresses the server will treat as local. It has two boolean attributes -
+ <strong>autodetect</strong> and <strong>autodetectIP</strong>. The first attribute, if true,
+ causes the server to attempt to determine its own host name and add that to the list of local
+ mail domains. The second attribute causes the server to attempt to determine its own IP
+ address and add it to the list of local mail domains. In addition to these attributes, this
+ tag has zero or more <strong>servername</strong> children.</li>
+ <ul>
+ <li><strong>servername</strong> - a single host name or IP address that should be added to the list of
+ mail domains that the server considers local.</li>
+ </ul>
+ <li><strong>servers</strong> - This is a list of DNS Servers to be used by James and are
+ specified by one, or more <strong><i>server</i></strong> elements, which are child elements.
+ Each server element is the IP address of a single DNS server.
+ <source>
+<servers>
+ <server>127.0.0.1</server>
+ <server>166.181.194.205</server>
+</servers>
+ </source>
+ </li>
+ <li><strong>authoritative</strong> - (<strong>true/false</strong>)This tag specifies whether or not
+ to require authoritative (non-cached) DNS records; to only accept DNS responses that are
+ authoritative for the domain. It is primarily useful in an intranet/extranet environment.
+ <p>This should always be <strong>false</strong> unless you understand the implications.</p>
+ </li>
+ </ul>
+
+ </subsection>
</section>
+<!--
<section name="Sun JVM DNS Lookup Configuration.">
<p>Sun's JVM Internet address lookup uses a cache which is unbounded and doesn't time out.<br/>
This is obviously not great for a long running process like a mail server so we have introduced a system property <strong>networkaddress.cache.ttl</strong> that is used by the distributed phoenix start-up scripts, at startup, to override the java 1.4 <strong>Security.setProperty("networkaddress.cache.ttl")</strong>.<br/> By default this is set to <strong>300</strong> seconds.</p>
@@ -65,7 +82,7 @@
<p>We are not currently aware of the behaviour of this cache in other JVM implementations, nor of the effect, if any, which this change might have on them</p>
<p>For more on this read defect report <a href="http://issues.apache.org/jira/browse/JAMES-592">JAMES-592</a> and related defects.</p>
</section>
-
+ -->
</body>
</document>
Modified: james/server/trunk/src/site/xdoc/config-domainlist.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/config-domainlist.xml?rev=1032231&r1=1032230&r2=1032231&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/config-domainlist.xml (original)
+++ james/server/trunk/src/site/xdoc/config-domainlist.xml Sun Nov 7 08:59:11 2010
@@ -27,6 +27,8 @@
<section name="DomainList Configuration">
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/domainlist.xml">domainlist.xml</a> Example.</p>
+
</section>
</body>
Modified: james/server/trunk/src/site/xdoc/config-fetchmail.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/config-fetchmail.xml?rev=1032231&r1=1032230&r2=1032231&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/config-fetchmail.xml (original)
+++ james/server/trunk/src/site/xdoc/config-fetchmail.xml Sun Nov 7 08:59:11 2010
@@ -25,7 +25,9 @@
<body>
- <section name="Fetchmail">
+ <section name="Fetchmail Configuration">
+
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/fetchmail.xml">fetchmail.xml</a> Example.</p>
<p>Fetchmail acts as a gateway between an external message store such as an IMAP
or POP3 server and James. Mail is fetched from the external message store and
Modified: james/server/trunk/src/site/xdoc/config-imap4.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/config-imap4.xml?rev=1032231&r1=1032230&r2=1032231&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/config-imap4.xml (original)
+++ james/server/trunk/src/site/xdoc/config-imap4.xml Sun Nov 7 08:59:11 2010
@@ -27,6 +27,8 @@
<section name="IMAP4 Configuration">
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/imapserver.xml">imapserver.xml</a> Example.</p>
+
<p>This block controls general connection management. There are two elements.
<ul>
<li><strong>idle-timeout</strong> - the number of milliseconds that it will take for idle
Modified: james/server/trunk/src/site/xdoc/config-listmanager.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/config-listmanager.xml?rev=1032231&r1=1032230&r2=1032231&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/config-listmanager.xml (original)
+++ james/server/trunk/src/site/xdoc/config-listmanager.xml Sun Nov 7 08:59:11 2010
@@ -27,6 +27,8 @@
<section name="List Manager Configuration">
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/james-listmanager.xml">james-listmanager.xml</a> Example.</p>
+
<p>One of the frequent questions on the James-User Mailing List is how
to create a mailing list. This document explains one way of using the
currently supplied Matchers and Mailets in James v3.0.</p>
@@ -115,6 +117,12 @@
</section>
+ <section name="miResources.xml">
+
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/miResources.xml">miResources.xml</a> Example.</p>
+
+ </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=1032231&r1=1032230&r2=1032231&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/config-mailetcontainer.xml (original)
+++ james/server/trunk/src/site/xdoc/config-mailetcontainer.xml Sun Nov 7 08:59:11 2010
@@ -26,6 +26,8 @@
<body>
<section name="Mailet Container Configuration">
+
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/mailetcontainer.xml">mailetcontainer.xml</a> Example.</p>
<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
Modified: james/server/trunk/src/site/xdoc/config-mailstores.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/config-mailstores.xml?rev=1032231&r1=1032230&r2=1032231&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/config-mailstores.xml (original)
+++ james/server/trunk/src/site/xdoc/config-mailstores.xml Sun Nov 7 08:59:11 2010
@@ -27,135 +27,16 @@
<section name="Mail Stores Configuration">
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/mailstore.xml">mailstore.xml</a> Example.</p>
+
</section>
- <section name="Database Configuration">
-
- <p>James has the capacity to use a JDBC-compatible database for storage of both message and user
- data. This section explains how to configure James to utilize a database for storage.</p>
-
- <subsection name="Requirements">
-
- <p>Using James with a database backend has certain requirements. Database configuration is
- extremely vendor-specific, so we can only state the requirements in general terms.</p>
- <p>There must be a database instance accessible from the James server. An account with appropriate
- privileges (select, insert, delete into tables, and on initial startup creation of tables) and
- with sufficient quota for the data to be inserted into the database must be available. Also,
- since James will use JDBC to access the database, an appropriate JDBC driver must be
- available for installation.</p>
- <p>It is important to verify the functionality of the database before attempting to configure
- James to use it as a repository. This will help ensure that configuration issues are properly
- identified.</p>
-
- </subsection>
-
- <subsection name="Connection Configuration">
-
- <p>Configuring the Phoenix container to work with JDBC is the first step in enabling James database support.</p>
- <p>First, Phoenix must be able to load the JDBC classes. To make these classes available to Phoenix, place the
- jar/zip files for the JDBC driver in the lib subdirectory of the James installation directory. Any additional
- libraries upon which the JDBC library depends that are not part of the standard Java distribution should also be
- added to this directory.</p>
- <p>Second, the mailstore.xml must be modified so that Phoenix initializes the database connections. The relevant
- configuration is in the database-connections block. The database-connections tag has only a single child tag,
- data-sources. This latter tag is a simple container tag for a number of child elements. It is these child
- elements, <strong>data-source</strong> elements, that define the database connections.</p>
- <p>Each <strong>data-source</strong> tag has a required attribute, <strong>name</strong>. This value
- must be unique to each <strong>data-source</strong> element. It is this <strong>name</strong> that will
- be used to specify the database connection in other parts of the mailstore.xml file.</p>
- <p>The <strong>data-source</strong> element has five children, all of whom are required.
- <ul>
- <li><strong>driver</strong> - The class name of the database driver to be used.</li>
- <li><strong>dburl</strong> - The JDBC connection URL for your database/driver.</li>
- <li><strong>user</strong> - The user id of the database account to be used by this connection.</li>
- <li><strong>password</strong> - The password of the database account to be used by this connection.</li>
- <li><strong>max</strong> - The maximum number of JDBC connections to be used concurrently by this data-source.</li>
- </ul>
- </p>
- <p>Generally, you simply configure these entries in the mailstore.xml
- file, which are commented, in order to use a database with James. You
- would then use the db: or dbfile: prefix instead of the file: prefix
- for a particular repository. You are currently free to mix and match
- your use of these different storage types for different repositories.
- See <a href="repositories.html">Repository Configuration</a> for
- more details. A sample configuration is described below.</p>
-
- </subsection>
-
- <subsection name="SQL Statement Configuration">
-
- <p>The precise SQL statements used by James to modify and view data stored in the database are specified in
- an external configuration file. The sqlResources.xml file
- (which can be found in the apps/james/conf directory) is a sample configuration file that contains the SQL
- statements used by James. The purpose of each of these statements, as well as the repository with which
- they are associated, is documented in situ.</p>
-
- <p>If you are using a SQL database with unusual SQL commands or data types, you may
- need to add special entries to this file. The James team
- does try to keep sqlResources.xml updated, so if you do run into a
- special case, please let us know.</p>
-
- <p>Also, if the database tables are not created a priori, but rather are to be created by James
- upon startup, special attention should be paid to the "create table" statements in this file. Such
- statements tend to be both very database and very database instance specific.</p>
- </subsection>
-
- <subsection name="Sample James Configuration">
-
- <p>The mailstore.xml file has commented out examples for MySQL and
- MSSQL data sources, and for each of the standard repositories. For
- example, to use MySQL, you would uncomment and adjust the following
- data-source element.</p>
-
- <p>You must create the database, in this case named
- <strong>mail</strong>, the user, and assign the user privileges.
- You may create the tables before running James or, if you so choose, James
- will automatically create the tables it needs. In the latter case the user
- must have table creation privileges.</p>
-
- <source>
-<data-source name="maildb" class="org.apache.james.util.mordred.JdbcDataSource">
- <driver>com.mysql.jdbc.Driver</driver>
- <dburl>jdbc:mysql://127.0.0.1/mail</dburl>
- <user>username</user>
- <password>password</password>
- <max>20</max>
-</data-source>
- </source>
-
- <p>Once the data-source element has been created, it can be referenced elsewhere in the mailstore.xml
- file. For example, the following element tells James to use the maildb data-source and dbfile
- storage mechanism for the message spool:</p>
-
- <source>
-<spoolRepository>
- <repository destinationURL="dbfile://maildb/spool/spool" type="SPOOL"/>
-</spoolRepository>
- </source>
-
- <p>The following element tells James to store mailboxes in a the maildb data-source:</p>
-
- <source>
-<inboxRepository>
- <repository destinationURL="db://maildb/inbox/" type="MAIL"/>
-</inboxRepository>
- </source>
-
- <p>The configuration file contains further examples.</p>
-
- </subsection>
-
- <subsection name="Known Issues">
-
- <p>There are some vendor-specific subtleties in using databases with James that have been observed
- by some users. These issues (and methods to resolve them) are recorded on the
- <a href="../FAQ.html">James FAQ</a> as they are reported. Please consult the FAQ if you encounter any
- difficulties.</p>
-
- </subsection>
-
+ <section name="JCR Repository Configuration">
+
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/jcr-repository.xml">jcr-repository.xml</a> Example.</p>
+
</section>
-
+
</body>
</document>
Modified: james/server/trunk/src/site/xdoc/config-pop3.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/config-pop3.xml?rev=1032231&r1=1032230&r2=1032231&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/config-pop3.xml (original)
+++ james/server/trunk/src/site/xdoc/config-pop3.xml Sun Nov 7 08:59:11 2010
@@ -24,51 +24,57 @@
</properties>
<body>
-<section name="POP3 Configuration">
-<p>The POP3 service is controlled by a configuration block in the pop3server.xml.
-The pop3server tag defines the boundaries of the configuration block. It encloses
-all the relevant configuration for the POP3 server. The behavior of the POP service is
-controlled by the attributes and children of this tag.</p>
-<p>This tag has an optional boolean attribute - <strong>enabled</strong> - that defines whether the service is active or not. The value defaults to "true" if
-not present.</p>
-<p>The standard children of the pop3server tag are:</p>
-<ul>
-<li><strong>port</strong> - This is an optional integer value. This value is the port on which this POP3 server is configured
-to listen.If the tag or value is omitted, the value will default to the standard POP3 port, 110.</li>
-<li><strong>bind</strong> - This is an optional value. If present, this value is a string describing
-the IP address to which this service should be bound. If the tag or value is absent then the service
-will bind to all network interfaces for the machine.</li>
-<li><strong>useTLS</strong> - This is an optional boolean value. If this value is true, then the "ssl"
-server socket factory is used to generate the server socket for this service. If it is false, the
-"plain" server socket factory is used. In either case this behavior is overridden by the serverSocketType
-tag which is described under the expert configuration options.</li>
-<li><strong>handler</strong> - This is an artifact preserved for backwards compatibility. This tag
-was used to group related parameters. It should disappear in future versions.</li>
-<ul>
-<li><strong>helloName</strong> - This is a required tag with an optional body that defines the server name
-used in the initial service greeting. The tag may have an optional attribute - <strong>autodetect</strong>. If
-the autodetect attribute is present and true, the service will use the local hostname
-returned by the Java libraries. If autodetect is absent or false, the body of the tag will be used. In
-this case, if no body is present, the value "localhost" will be used.</li>
-<li><strong>connectionTimeout</strong> - This is an optional tag with an integer body. </li>
-</ul>
-</ul>
-<p>There are a few additional children of the pop3server tag that are appropriate for advanced
-configurations. These should only be used by expert administrators. All tags in this group are optional.</p>
-<ul>
-<li><strong>serverSocketFactory</strong> - This is an optional tag with a string body. If the tag is present,
-the body must be the name of one of the server socket factories specified in the socket manager block. Any other
-value will result in an error. If present, this tag overrides the useTLS tag.</li>
-<li><strong>threadGroup</strong> - This is an optional tag with a string body. If the tag is present,
-the body must be the name of one of the thread groups specified in the thread manager block. Any other
-value will result in an error. This tag is best used to fine tune thread allocation between the services.</li>
-<li><strong>connectionLimit</strong> - The connectionLimit parameter specifies the maximum number of client
-connections that this service will allow. If no value is specified, the value defaults to that specified in
-the connectionmanager block. A value of 0 means that there is no limit imposed
-by the service, although resource limitations imposed by other components
-(i.e. max # of threads) may serve to limit the number of open connections.</li>
-</ul>
-</section>
+ <section name="POP3 Configuration">
+
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/pop3server.xml">pop3server.xml</a> Example.</p>
+
+ <p>The POP3 service is controlled by a configuration block in the pop3server.xml.
+ The pop3server tag defines the boundaries of the configuration block. It encloses
+ all the relevant configuration for the POP3 server. The behavior of the POP service is
+ controlled by the attributes and children of this tag.</p>
+
+ <p>This tag has an optional boolean attribute - <strong>enabled</strong> - that defines whether the service is active or not. The value defaults to "true" if
+ not present.</p>
+ <p>The standard children of the pop3server tag are:</p>
+ <ul>
+ <li><strong>port</strong> - This is an optional integer value. This value is the port on which this POP3 server is configured
+ to listen.If the tag or value is omitted, the value will default to the standard POP3 port, 110.</li>
+ <li><strong>bind</strong> - This is an optional value. If present, this value is a string describing
+ the IP address to which this service should be bound. If the tag or value is absent then the service
+ will bind to all network interfaces for the machine.</li>
+ <li><strong>useTLS</strong> - This is an optional boolean value. If this value is true, then the "ssl"
+ server socket factory is used to generate the server socket for this service. If it is false, the
+ "plain" server socket factory is used. In either case this behavior is overridden by the serverSocketType
+ tag which is described under the expert configuration options.</li>
+ <li><strong>handler</strong> - This is an artifact preserved for backwards compatibility. This tag
+ was used to group related parameters. It should disappear in future versions.</li>
+ <ul>
+ <li><strong>helloName</strong> - This is a required tag with an optional body that defines the server name
+ used in the initial service greeting. The tag may have an optional attribute - <strong>autodetect</strong>. If
+ the autodetect attribute is present and true, the service will use the local hostname
+ returned by the Java libraries. If autodetect is absent or false, the body of the tag will be used. In
+ this case, if no body is present, the value "localhost" will be used.</li>
+ <li><strong>connectionTimeout</strong> - This is an optional tag with an integer body. </li>
+ </ul>
+ </ul>
+ <p>There are a few additional children of the pop3server tag that are appropriate for advanced
+ configurations. These should only be used by expert administrators. All tags in this group are optional.</p>
+ <ul>
+ <li><strong>serverSocketFactory</strong> - This is an optional tag with a string body. If the tag is present,
+ the body must be the name of one of the server socket factories specified in the socket manager block. Any other
+ value will result in an error. If present, this tag overrides the useTLS tag.</li>
+ <li><strong>threadGroup</strong> - This is an optional tag with a string body. If the tag is present,
+ the body must be the name of one of the thread groups specified in the thread manager block. Any other
+ value will result in an error. This tag is best used to fine tune thread allocation between the services.</li>
+ <li><strong>connectionLimit</strong> - The connectionLimit parameter specifies the maximum number of client
+ connections that this service will allow. If no value is specified, the value defaults to that specified in
+ the connectionmanager block. A value of 0 means that there is no limit imposed
+ by the service, although resource limitations imposed by other components
+ (i.e. max # of threads) may serve to limit the number of open connections.</li>
+ </ul>
+
+ </section>
+
</body>
</document>
Modified: james/server/trunk/src/site/xdoc/config-remotemanager.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/config-remotemanager.xml?rev=1032231&r1=1032230&r2=1032231&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/config-remotemanager.xml (original)
+++ james/server/trunk/src/site/xdoc/config-remotemanager.xml Sun Nov 7 08:59:11 2010
@@ -24,8 +24,11 @@
</properties>
<body>
+
<section name="RemoteManager Configuration">
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/remotemanager.xml">remotemanager.xml</a> Example.</p>
+
<p>The RemoteManager is controlled by a configuration block in the remotemanager.xml.
The remotemanager tag defines the boundaries of the configuration block. It encloses
all the relevant configuration for the RemoteManager. The behavior of the RemoteManager is
Modified: james/server/trunk/src/site/xdoc/config-serverwide.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/config-serverwide.xml?rev=1032231&r1=1032230&r2=1032231&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/config-serverwide.xml (original)
+++ james/server/trunk/src/site/xdoc/config-serverwide.xml Sun Nov 7 08:59:11 2010
@@ -34,66 +34,172 @@
<subsection name="mailserver.xml">
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/mailserver.xml">mailserver.xml</a> Example.</p>
+
<p>This configuration block is defined by the <strong>mailserver</strong> tag. All administrators
need to adjust this configuration block upon installation. It no attributes, but several
children, all of which are required.</p>
- <ul>
- <li><strong>postmaster</strong> - 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.</li>
- <li><strong>usernames</strong> - this element has no body, but instead has three required
- boolean attributes. These are <strong>ignoreCase</strong>, <strong>enabledAliases</strong>,
- and <strong>enableForwarding</strong>. The first of these determines whether email user names
- will be treated as case-insensitive or not. The second attribute configures whether local user
- aliasing will be enabled. Finally, the value of the third attribute determines whether forwarding
- to potentially remote users will be enabled.</li>
- </ul>
-
+ <p>The tag has these attributes:</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</dd>
+ <dt><strong>usernames</strong></dt>
+ <dd>this element has no body, but instead has three required
+ boolean attributes. These are <strong>ignoreCase</strong>, <strong>enabledAliases</strong>,
+ and <strong>enableForwarding</strong>. The first of these determines whether email user names
+ will be treated as case-insensitive or not. The second attribute configures whether local user
+ aliasing will be enabled. Finally, the value of the third attribute determines whether forwarding
+ to potentially remote users will be enabled.</dd>
+ </dl>
+
</subsection>
- <subsection name="dnsservice.xml">
-
- <ul>
- <li><strong>servernames</strong> - this element determines exactly which mail domains and IP
- addresses the server will treat as local. It has two boolean attributes -
- <strong>autodetect</strong> and <strong>autodetectIP</strong>. The first attribute, if true,
- causes the server to attempt to determine its own host name and add that to the list of local
- mail domains. The second attribute causes the server to attempt to determine its own IP
- address and add it to the list of local mail domains. In addition to these attributes, this
- tag has zero or more <strong>servername</strong> children.</li>
- <ul>
- <li><strong>servername</strong> - a single host name or IP address that should be added to the list of
- mail domains that the server considers local.</li>
- </ul>
- </ul>
-
+ <subsection name="spring-beans.xml">
+
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/spring-beans.xml">spring-beans.xml</a> Example.</p>
+
</subsection>
<subsection name="database.properties">
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/database.properties">database.properties</a> Example.</p>
+
<p>The database connection in database.properties</p>
+ <p>James has the capacity to use a JDBC-compatible database for storage of both message and user
+ data. This section explains how to configure James to utilize a database for storage.</p>
+
+ <p>Using James with a database backend has certain requirements. Database configuration is
+ extremely vendor-specific, so we can only state the requirements in general terms.</p>
+ <p>There must be a database instance accessible from the James server. An account with appropriate
+ privileges (select, insert, delete into tables, and on initial startup creation of tables) and
+ with sufficient quota for the data to be inserted into the database must be available. Also,
+ since James will use JDBC to access the database, an appropriate JDBC driver must be
+ available for installation.</p>
+ <p>It is important to verify the functionality of the database before attempting to configure
+ James to use it as a repository. This will help ensure that configuration issues are properly
+ identified.</p>
+
+ <p>Configuring the Phoenix container to work with JDBC is the first step in enabling James database support.</p>
+ <p>First, Phoenix must be able to load the JDBC classes. To make these classes available to Phoenix, place the
+ jar/zip files for the JDBC driver in the lib subdirectory of the James installation directory. Any additional
+ libraries upon which the JDBC library depends that are not part of the standard Java distribution should also be
+ added to this directory.</p>
+ <p>Second, the mailstore.xml must be modified so that Phoenix initializes the database connections. The relevant
+ configuration is in the database-connections block. The database-connections tag has only a single child tag,
+ data-sources. This latter tag is a simple container tag for a number of child elements. It is these child
+ elements, <strong>data-source</strong> elements, that define the database connections.</p>
+ <p>Each <strong>data-source</strong> tag has a required attribute, <strong>name</strong>. This value
+ must be unique to each <strong>data-source</strong> element. It is this <strong>name</strong> that will
+ be used to specify the database connection in other parts of the mailstore.xml file.</p>
+ <p>The <strong>data-source</strong> element has five children, all of whom are required.
+ <ul>
+ <li><strong>driver</strong> - The class name of the database driver to be used.</li>
+ <li><strong>dburl</strong> - The JDBC connection URL for your database/driver.</li>
+ <li><strong>user</strong> - The user id of the database account to be used by this connection.</li>
+ <li><strong>password</strong> - The password of the database account to be used by this connection.</li>
+ <li><strong>max</strong> - The maximum number of JDBC connections to be used concurrently by this data-source.</li>
+ </ul>
+ </p>
+ <p>Generally, you simply configure these entries in the mailstore.xml
+ file, which are commented, in order to use a database with James. You
+ would then use the db: or dbfile: prefix instead of the file: prefix
+ for a particular repository. You are currently free to mix and match
+ your use of these different storage types for different repositories.
+ See <a href="repositories.html">Repository Configuration</a> for
+ more details. A sample configuration is described below.</p>
+
</subsection>
-
+
+ <p>The mailstore.xml file has commented out examples for MySQL and
+ MSSQL data sources, and for each of the standard repositories. For
+ example, to use MySQL, you would uncomment and adjust the following
+ data-source element.</p>
+
+ <p>You must create the database, in this case named
+ <strong>mail</strong>, the user, and assign the user privileges.
+ You may create the tables before running James or, if you so choose, James
+ will automatically create the tables it needs. In the latter case the user
+ must have table creation privileges.</p>
+
+ <source>
+<data-source name="maildb" class="org.apache.james.util.mordred.JdbcDataSource">
+ <driver>com.mysql.jdbc.Driver</driver>
+ <dburl>jdbc:mysql://127.0.0.1/mail</dburl>
+ <user>username</user>
+ <password>password</password>
+ <max>20</max>
+</data-source>
+ </source>
+
+ <p>Once the data-source element has been created, it can be referenced elsewhere in the mailstore.xml
+ file. For example, the following element tells James to use the maildb data-source and dbfile
+ storage mechanism for the message spool:</p>
+
+ <source>
+<spoolRepository>
+ <repository destinationURL="dbfile://maildb/spool/spool" type="SPOOL"/>
+</spoolRepository>
+ </source>
+
+ <p>The following element tells James to store mailboxes in a the maildb data-source:</p>
+
+ <source>
+<inboxRepository>
+ <repository destinationURL="db://maildb/inbox/" type="MAIL"/>
+</inboxRepository>
+ </source>
+
+ <p>The configuration file contains further examples.</p>
+
+ <subsection name="Known Issues">
+
+ <p>There are some vendor-specific subtleties in using databases with James that have been observed
+ by some users. These issues (and methods to resolve them) are recorded on the
+ <a href="../FAQ.html">James FAQ</a> as they are reported. Please consult the FAQ if you encounter any
+ difficulties.</p>
+
+ </subsection>
+
<subsection name="META-INF/persistence.xml">
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/META-INF/persistence.xml">META-INF/persistence.xml</a> Example.</p>
+
<p>The JPA information in META-INF/persistence.xml.</p>
</subsection>
- <subsection name="Other global configuration">
-
- <p>Other configuration are available inside James.
- Only expert administrators should modify this configuration.</p>
-
- <ul>
- <li>log4j.properties: See <a href="monitor-logging.html">logging page</a></li>
- <li>database.properties</li>
- <li>sqlResources.xml and mailboxManagerSqlResources.xml</li>
- </ul>
+ <subsection name="jmx.properties">
+
+ <a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/jmx.properties">jmx.properties</a> Example.<br/>
+
+ </subsection>
+
+ <subsection name="sqlResources.xml">
+
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/sqlResources.xml">sqlResources.xml</a> Example.</p>
+
+ <p>Deprecated.</p>
+
+ <p>The precise SQL statements used by James to modify and view data stored in the database are specified in
+ an external configuration file. The sqlResources.xml file
+ (which can be found in the apps/james/conf directory) is a sample configuration file that contains the SQL
+ statements used by James. The purpose of each of these statements, as well as the repository with which
+ they are associated, is documented in situ.</p>
+
+ <p>If you are using a SQL database with unusual SQL commands or data types, you may
+ need to add special entries to this file. The James team
+ does try to keep sqlResources.xml updated, so if you do run into a
+ special case, please let us know.</p>
+
+ <p>Also, if the database tables are not created a priori, but rather are to be created by James
+ upon startup, special attention should be paid to the "create table" statements in this file. Such
+ statements tend to be both very database and very database instance specific.</p>
</subsection>
Modified: james/server/trunk/src/site/xdoc/config-smtp-lmtp.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/config-smtp-lmtp.xml?rev=1032231&r1=1032230&r2=1032231&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/config-smtp-lmtp.xml (original)
+++ james/server/trunk/src/site/xdoc/config-smtp-lmtp.xml Sun Nov 7 08:59:11 2010
@@ -27,6 +27,8 @@
<section name="SMTP Configuration">
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/smtpserver.xml">smtpserver.xml</a> Example.</p>
+
<p>The SMTP service is controlled by a configuration block in the smptserver.xml.
The smtpserver tag defines the boundaries of the configuration block. It encloses
all the relevant configuration for the SMTP server. The behavior of the SMTP service is
@@ -85,21 +87,18 @@
(i.e. max # of threads) may serve to limit the number of open connections.</li>
</ul>
- </section>
-
- <section name="Configure Authenticated SMTP (SMTP AUTH)">
-
- <p>Authenticated SMTP is a method of securing your SMTP server. With SMTP AUTH enabled senders who wish to
- relay mail through the SMTP server (that is, send mail that is eventually to be delivered to another SMTP
- server) must authenticate themselves to James before sending their message. Mail that is to be delivered
- locally does not require authentication. This method ensures that spammers cannot use your SMTP server
- to send unauthorized mail, while still enabling users who may not have fixed IP addresses to send their
- messages.</p>
- <p>Mail servers that allow spammers to send unauthorized email are known as open relays. So SMTP AUTH
- is a mechanism for ensuring that your server is not an open relay .</p>
- <p>At this time James only supports simple user name / password authentication.</p>
+ <subsection name="Configure Authenticated SMTP (SMTP AUTH)">
- <subsection name="Configuring James for Authenticated SMTP">
+ <p>Authenticated SMTP is a method of securing your SMTP server. With SMTP AUTH enabled senders who wish to
+ relay mail through the SMTP server (that is, send mail that is eventually to be delivered to another SMTP
+ server) must authenticate themselves to James before sending their message. Mail that is to be delivered
+ locally does not require authentication. This method ensures that spammers cannot use your SMTP server
+ to send unauthorized mail, while still enabling users who may not have fixed IP addresses to send their
+ messages.</p>
+
+ <p>Mail servers that allow spammers to send unauthorized email are known as open relays. So SMTP AUTH
+ is a mechanism for ensuring that your server is not an open relay .</p>
+ <p>At this time James only supports simple user name / password authentication.</p>
<p>Configuring James for Authentication SMTP is a multi-step process. It requires several adjustments of
the smtpserver.xml. To enable SMTP AUTH, do the following:</p>
@@ -117,10 +116,6 @@
optionally set the verifyIdentity element of the smtpserver configuration block to "true".</p>
<p>Fifth, restart James. This will pull in all of your configuration changes.</p>
- </subsection>
-
- <subsection name="Verifying Your Configuration">
-
<p>Finally, you need to verify that your configuration was done correctly. This step is
<strong>important</strong> and should not be skipped.</p>
<p>Verify that you have not inadvertantly configured your server as an open relay. This is most easily
@@ -140,6 +135,8 @@
<section name="LMTP Configuration">
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/lmtpserver.xml">lmtpserver.xml</a> Example.</p>
+
</section>
</body>
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=1032231&r1=1032230&r2=1032231&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/config-users.xml (original)
+++ james/server/trunk/src/site/xdoc/config-users.xml Sun Nov 7 08:59:11 2010
@@ -26,6 +26,8 @@
<body>
<section name="Users Configuration">
+
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/usersrepository.xml">usersrepository.xml</a> Example.</p>
<subsection name="JPA Users">
@@ -182,6 +184,12 @@
</section>
+ <section name="Virtual Users Configuration">
+
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/virtualusertable.xml">virtualusertable.xml</a> Example.</p>
+
+ </section>
+
</body>
</document>
Modified: james/server/trunk/src/site/xdoc/config.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/config.xml?rev=1032231&r1=1032230&r2=1032231&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/config.xml (original)
+++ james/server/trunk/src/site/xdoc/config.xml Sun Nov 7 08:59:11 2010
@@ -54,18 +54,25 @@
<td></td>
</tr>
<tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/META-INF/persistence.xml">META-INF/persistence.xml</a></td>
+ <td><a href="config-serverwide.html">Server-wide Configuration</a></td>
+ <td></td>
+ </tr>
+ <tr>
<td>
<a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/jmx.properties">jmx.properties</a><br/>
+<!--
<a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/jmx.access">jmx.access</a><br/>
<a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/jmx.password">jmx.password</a><br/>
- </td>
+-->
+ </td>
<td><a href="config-serverwide.html">Server-wide Configuration</a></td>
<td></td>
</tr>
<tr>
<td><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/sqlResources.xml">sqlResources.xml</a></td>
<td><a href="config-serverwide.html">Server-wide Configuration</a></td>
- <td></td>
+ <td>Deprecated</td>
</tr>
<tr>
<td><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/domainlist.xml">domainlist.xml</a></td>
@@ -88,18 +95,13 @@
<td></td>
</tr>
<tr>
- <td><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/miResources.xml">miResources.xml</a></td>
- <td><a href="config-mailstores.html">Mail Stores Configuration</a></td>
- <td></td>
- </tr>
- <tr>
<td><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/jcr-repository.xml">jcr-repository.xml</a></td>
<td><a href="config-mailstores.html">Mail Stores Configuration</a></td>
<td></td>
</tr>
<tr>
<td><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/dnsservice.xml">dnsservice.xml</a></td>
- <td><a href="config-dns.html">DNS Configuration</a></td>
+ <td><a href="config-dnsservice.html">DNS Service Configuration</a></td>
<td></td>
</tr>
<tr>
@@ -143,12 +145,17 @@
<td></td>
</tr>
<tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/miResources.xml">miResources.xml</a></td>
+ <td><a href="config-mailstores.html">List Manager Configuration</a></td>
<td></td>
+ </tr>
+ <tr>
+ <td>TLS</td>
<td><a href="config-tls.html">TLS Configuration</a></td>
<td></td>
</tr>
<tr>
- <td></td>
+ <td>Sieve</td>
<td><a href="config-sieve.html">Sieve Configuration</a></td>
<td></td>
</tr>
Modified: james/server/trunk/src/site/xdoc/manage.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/manage.xml?rev=1032231&r1=1032230&r2=1032231&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/manage.xml (original)
+++ james/server/trunk/src/site/xdoc/manage.xml Sun Nov 7 08:59:11 2010
@@ -35,8 +35,8 @@
<p>After you've done this, restart James to ensure that any changes you've made in
the configuration are incorporated into the running system.</p>
- <p>You are now ready to manage <a href="manage-domains.html">domains</a>,
- <a href="manage-users.html">users</a> and <a href="manage-virtualusers.html">virtual users</a>.</p>
+ <p>You are now ready to manage <a href="manage-domains.html">Domains</a>,
+ <a href="manage-users.html">Users</a> and <a href="manage-virtualusers.html">Virtual Users</a>.</p>
<p>You can manage James via:</p>
Modified: james/server/trunk/src/site/xdoc/monitor-logging.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/monitor-logging.xml?rev=1032231&r1=1032230&r2=1032231&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/monitor-logging.xml (original)
+++ james/server/trunk/src/site/xdoc/monitor-logging.xml Sun Nov 7 08:59:11 2010
@@ -64,6 +64,8 @@ drwxrwxrwx. 7 root root 4096 2010-11-0
-rw-r--r--. 1 root root 71 2010-11-06 09:24 usersrepository.log
</source>
+ <p><a href="https://svn.apache.org/repos/asf/james/server/trunk/container-spring/src/main/config/examples/log4j.properties">log4j.properties</a> Example.</p>
+
<p>The default log4j.properties is taken hereafter for information.</p>
<source>
Modified: james/server/trunk/src/site/xdoc/upgrade-2.3.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/upgrade-2.3.xml?rev=1032231&r1=1032230&r2=1032231&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/upgrade-2.3.xml (original)
+++ james/server/trunk/src/site/xdoc/upgrade-2.3.xml Sun Nov 7 08:59:11 2010
@@ -31,7 +31,7 @@
<p>We are also working on a tool that will migrate 2.3 user repositories to 3 user repository.
See <a href="https://issues.apache.org/jira/browse/JAMES-1090">https://issues.apache.org/jira/browse/JAMES-1090</a>
- to follow progress on this</p>
+ to follow progress on this.</p>
</subsection>
@@ -39,7 +39,7 @@
<p>We are working on a tool that will migrate 2.3 mail repositories to 3.0 mailbox store.
See <a href="https://issues.apache.org/jira/browse/JAMES-1052">https://issues.apache.org/jira/browse/JAMES-1052</a>
- to follow progress on this</p>
+ to follow progress on this.</p>
</subsection>
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org