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/10/12 18:00:09 UTC
svn commit: r1021813 - in /james/server/trunk/src/site: ./ resources/images/
resources/james-server-mailets-function/ resources/stylesheets/ xdoc/
xdoc/images/ xdoc/stylesheets/
Author: eric
Date: Tue Oct 12 16:00:07 2010
New Revision: 1021813
URL: http://svn.apache.org/viewvc?rev=1021813&view=rev
Log:
One more safety commit for 3.0 web site (JAMES-887)
Added:
james/server/trunk/src/site/resources/images/james-logo.jpg
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/images/james-logo.jpg
james/server/trunk/src/site/resources/images/void.gif
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/images/void.gif
james/server/trunk/src/site/resources/james-server-mailets-function/
james/server/trunk/src/site/resources/james-server-mailets-function/mailet-report.html
james/server/trunk/src/site/resources/stylesheets/
- copied from r1021749, james/server/trunk/src/site/xdoc/stylesheets/
james/server/trunk/src/site/xdoc/concept_mailetcontainer.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/mailetcontainer.xml
james/server/trunk/src/site/xdoc/concept_queue_priority.xml
- copied, changed from r1021749, james/server/trunk/src/site/xdoc/queue_priority.xml
james/server/trunk/src/site/xdoc/concept_stores.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/stores.xml
james/server/trunk/src/site/xdoc/concept_summary.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/summary.xml
james/server/trunk/src/site/xdoc/configuration.xml
- copied, changed from r1021749, james/server/trunk/src/site/xdoc/configuration_instructions.xml
james/server/trunk/src/site/xdoc/configuration_common.xml
- copied, changed from r1021749, james/server/trunk/src/site/xdoc/common_configurations.xml
james/server/trunk/src/site/xdoc/configuration_dns.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/dns_configuration.xml
james/server/trunk/src/site/xdoc/configuration_domains.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/domains_configuration.xml
james/server/trunk/src/site/xdoc/configuration_fetchmail.xml
- copied, changed from r1021749, james/server/trunk/src/site/xdoc/fetchmail_configuration.xml
james/server/trunk/src/site/xdoc/configuration_imap4.xml
- copied, changed from r1021749, james/server/trunk/src/site/xdoc/imap4_configuration.xml
james/server/trunk/src/site/xdoc/configuration_listmanager.xml
james/server/trunk/src/site/xdoc/configuration_mailetcontainer.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/mailetcontainer_configuration.xml
james/server/trunk/src/site/xdoc/configuration_mailstores.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/mailstores_configuration.xml
james/server/trunk/src/site/xdoc/configuration_nntp.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/nntp_configuration.xml
james/server/trunk/src/site/xdoc/configuration_pop3.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/pop3_configuration.xml
james/server/trunk/src/site/xdoc/configuration_remotemanager.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/remotemanager_configuration.xml
james/server/trunk/src/site/xdoc/configuration_serverwide.xml
- copied, changed from r1021749, james/server/trunk/src/site/xdoc/serverwide_configuration.xml
james/server/trunk/src/site/xdoc/configuration_smtp_lmtp.xml
- copied unchanged from r1006107, james/server/trunk/src/site/xdoc/smtp_configuration.xml
james/server/trunk/src/site/xdoc/configuration_users.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/users_configuration.xml
james/server/trunk/src/site/xdoc/dev_architecture.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/james_architecture.xml
james/server/trunk/src/site/xdoc/dev_build.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/build_james.xml
james/server/trunk/src/site/xdoc/dev_custom_mailet.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/custom_mailet.xml
james/server/trunk/src/site/xdoc/dev_custom_matcher.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/custom_matcher.xml
james/server/trunk/src/site/xdoc/dev_extend.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/extend_james.xml
james/server/trunk/src/site/xdoc/installation.xml
- copied, changed from r1021749, james/server/trunk/src/site/xdoc/installation_instructions.xml
james/server/trunk/src/site/xdoc/james_perfomance.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/perfomance.xml
james/server/trunk/src/site/xdoc/james_security.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/security.xml
james/server/trunk/src/site/xdoc/james_upgrade.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/upgrade_instructions.xml
james/server/trunk/src/site/xdoc/management.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/management_instructions.xml
james/server/trunk/src/site/xdoc/management_domains.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/adding_domains.xml
james/server/trunk/src/site/xdoc/management_users.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/adding_users.xml
james/server/trunk/src/site/xdoc/management_virtualusers.xml
- copied unchanged from r1021749, james/server/trunk/src/site/xdoc/adding_virtualusers.xml
james/server/trunk/src/site/xdoc/monitoring.xml
- copied, changed from r1021749, james/server/trunk/src/site/xdoc/monitoring_instructions.xml
james/server/trunk/src/site/xdoc/monitoring_jmx.xml
- copied, changed from r1021749, james/server/trunk/src/site/xdoc/queues_monitoring.xml
james/server/trunk/src/site/xdoc/monitoring_logging.xml
Removed:
james/server/trunk/src/site/xdoc/adding_domains.xml
james/server/trunk/src/site/xdoc/adding_users.xml
james/server/trunk/src/site/xdoc/adding_virtualusers.xml
james/server/trunk/src/site/xdoc/build_james.xml
james/server/trunk/src/site/xdoc/common_configurations.xml
james/server/trunk/src/site/xdoc/configuration_instructions.xml
james/server/trunk/src/site/xdoc/custom_mailet.xml
james/server/trunk/src/site/xdoc/custom_matcher.xml
james/server/trunk/src/site/xdoc/dns_configuration.xml
james/server/trunk/src/site/xdoc/domains_configuration.xml
james/server/trunk/src/site/xdoc/extend_james.xml
james/server/trunk/src/site/xdoc/fetchmail_configuration.xml
james/server/trunk/src/site/xdoc/images/
james/server/trunk/src/site/xdoc/imap4_configuration.xml
james/server/trunk/src/site/xdoc/installation_instructions.xml
james/server/trunk/src/site/xdoc/james_architecture.xml
james/server/trunk/src/site/xdoc/mailetcontainer.xml
james/server/trunk/src/site/xdoc/mailetcontainer_configuration.xml
james/server/trunk/src/site/xdoc/mailstores_configuration.xml
james/server/trunk/src/site/xdoc/management_instructions.xml
james/server/trunk/src/site/xdoc/monitoring_instructions.xml
james/server/trunk/src/site/xdoc/nntp_configuration.xml
james/server/trunk/src/site/xdoc/perfomance.xml
james/server/trunk/src/site/xdoc/pop3_configuration.xml
james/server/trunk/src/site/xdoc/queue_priority.xml
james/server/trunk/src/site/xdoc/queues_monitoring.xml
james/server/trunk/src/site/xdoc/remotemanager_configuration.xml
james/server/trunk/src/site/xdoc/security.xml
james/server/trunk/src/site/xdoc/serverwide_configuration.xml
james/server/trunk/src/site/xdoc/smtp_configuration.xml
james/server/trunk/src/site/xdoc/stores.xml
james/server/trunk/src/site/xdoc/stylesheets/
james/server/trunk/src/site/xdoc/summary.xml
james/server/trunk/src/site/xdoc/upgrade_instructions.xml
james/server/trunk/src/site/xdoc/users_configuration.xml
Modified:
james/server/trunk/src/site/site.xml
james/server/trunk/src/site/xdoc/index.xml
Added: james/server/trunk/src/site/resources/james-server-mailets-function/mailet-report.html
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/resources/james-server-mailets-function/mailet-report.html?rev=1021813&view=auto
==============================================================================
(empty)
Modified: james/server/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/site.xml?rev=1021813&r1=1021812&r2=1021813&view=diff
==============================================================================
--- james/server/trunk/src/site/site.xml (original)
+++ james/server/trunk/src/site/site.xml Tue Oct 12 16:00:07 2010
@@ -37,71 +37,70 @@
<item name="Introduction" href="/index.html"/>
<item name="Release Notes" href="/release_notes.html"/>
<item name="Changes" href="/changelog.html"/>
- <item name="Security" href="/security.html" />
- <item name="Performance" href="/perfomance.html" />
-<!-- <item name='JIRA Report' href='/jira-report.html'/>-->
+ <item name="Security" href="/james_security.html" />
+ <item name="Performance" href="/james_perfomance.html" />
+<!-- <item name="JIRA Report" href="/jira-report.html"/>-->
</menu>
<menu name="Concepts">
- <item name="Summary" href="/summary.html" />
- <item name="Stores" href="/stores.html" />
- <item name="Mailet Container" href="/mailetcontainer.html" />
- <item name="Queue Priority" href="/queue_priority.html" />
+ <item name="Summary" href="/concept_summary.html" />
+ <item name="Stores" href="/concept_stores.html" />
+ <item name="Mailet Container" href="/concept_mailetcontainer.html" collapse="true" >
+ <item name="Mailet Site" href="http://james.apache.org/mailet/index.html"/>
+ <item name="Mailet API" href="http://james.apache.org/mailet/api/index.html"/>
+ <item name="Mailet Toolkit" href="http://james.apache.org/mailet/base/index.html"/>
+ <item name="Mailet Crypto" href="http://james.apache.org/mailet/crypto/index.html"/>
+ <item name="Mailet Sieve" href="http://james.apache.org/mailet/standard/index.html"/>
+ <item name="Mailet Standard" href="http://james.apache.org/mailet/standard/index.html"/>
+ <item name="Mailet Docs" href="http://james.apache.org/mailet/maven-mailetdocs-plugin/index.html"/>
+ <item name="Server Mailets" href="/james-server-mailets-function/mailet-report.html"/>
+ </item>
+ <item name="Queue Priority" href="/concept_queue_priority.html" />
</menu>
<menu name="How to...">
- <item name="1. Install James" href="/installation_instructions.html" />
- <item name="2. Configure James" href="/configuration_instructions.html" collapse="true" >
- <item name="Server-wide" href="/serverwide_configuration.html" />
- <item name="Domains" href="/domains_configuration.html" />
- <item name="Users" href="/users_configuration.html" />
- <item name="Mail Stores" href="/mailstores_configuration.html" />
- <item name="DNS" href="/dns_configuration.html" />
- <item name="IMAP4" href="/imap4_configuration.html" />
- <item name="POP3" href="/pop3_configuration.html" />
- <item name="SMTP LMTP" href="/smtp_configuration.html" />
-<!-- <item name="NNTP" href="/nntp_configuration.html" />-->
- <item name="Mailet Container" href="/mailetcontainer_configuration.html" />
- <item name="FetchMail" href="/fetchmail_configuration.html" />
- <item name="Remote Manager" href="/remotemanager_configuration.html" />
+ <item name="1. Install James" href="/installation.html" />
+ <item name="2. Configure James" href="/configuration.html" collapse="true" >
+ <item name="Server-wide" href="/configuration_serverwide.html" />
+ <item name="Domains" href="/configuration_domains.html" />
+ <item name="Users" href="/configuration_users.html" />
+ <item name="Mail Stores" href="/configuration_mailstores.html" />
+ <item name="DNS" href="/configuration_dns.html" />
+ <item name="IMAP4" href="/configuration_imap4.html" />
+ <item name="POP3" href="/configuration_pop3.html" />
+ <item name="SMTP LMTP" href="/configuration_smtp_lmtp.html" />
+ <item name="Mailet Container" href="/configuration_mailetcontainer.html" />
+ <item name="FetchMail" href="/configuration_fetchmail.html" />
+ <item name="Remote Manager" href="/configuration_remotemanager.html" />
+ <item name="List Manager" href="/configuration_listmanager.html" />
</item>
- <item name="3. Manage James" href="/management_instructions.html" collapse="true" >
- <item name="Domains" href="/adding_domains.html" />
- <item name="Users" href="/adding_users.html" />
- <item name="Virtual Users" href="/adding_virtual_users.html" />
+ <item name="3. Manage James" href="/management.html" collapse="true" >
+ <item name="Domains" href="/management_domains.html" />
+ <item name="Users" href="/management_users.html" />
+ <item name="Virtual Users" href="/management_virtualusers.html" />
</item>
- <item name="4. Monitor James" href="/monitoring_instructions.html" collapse="true" >
- <item name="Queues" href="/queues_monitoring.html" />
+ <item name="4. Monitor James" href="/monitoring.html" collapse="true" >
+ <item name="Logging" href="/monitoring_logging.html" />
+ <item name="JMX" href="/monitoring_jmx.html" />
</item>
</menu>
<menu name="FAQ">
- <item name="Upgrade from James 2.3" href="/upgrade_instructions.html" />
- <item name="Common Configs" href="/common_configurations.html" />
- <item name="James and Sendmail" href="/james_and_sendmail.html" />
+ <item name="Upgrade from James 2.3" href="/james_upgrade.html" />
+ <item name="Common Configs" href="/configuration_common.html" />
<item name="Provided Mailets" href="/provided_mailets.html" />
<item name="Provided Matchers" href="/provided_matchers.html" />
</menu>
<menu name="Developers Corner">
- <item name="Architecture" href="/james_architecture.html" />
- <item name="Build from source" href="/build_james.html" />
- <item name="Develop a Mailet" href="/custom_mailet.html" />
- <item name="Develop a Matcher" href="/custom_matcher.html" />
- <item name="Extend James" href="/extend_james.html" />
+ <item name="Architecture" href="/dev_architecture.html" />
+ <item name="Build from source" href="/dev_build.html" />
+ <item name="Develop a Mailet" href="/dev_custom_mailet.html" />
+ <item name="Develop a Matcher" href="/dev_custom_matcher.html" />
+ <item name="Extend James" href="/dev_extend.html" />
+ <item name="Javadoc" href="./apidocs/index.html" />
</menu>
- <menu name='Mailets'>
- <item name='Overview' href='http://james.apache.org/mailet/index.html'/>
- <item name='API' href='http://james.apache.org/mailet/api/index.html'/>
- <item name='Basic Toolkit' href='http://james.apache.org/mailet/base/index.html'/>
- <item name='Crypto' href='http://james.apache.org/mailet/crypto/index.html'/>
- <item name='Sieve' href='http://james.apache.org/mailet/standard/index.html'/>
- <item name='MailetDocs' href='http://james.apache.org/mailet/maven-mailetdocs-plugin/index.html'/>
- <item name='Server' href='/james-server-mailets-function/mailet-report.html'/>
- <item name='Standard' href='http://james.apache.org/mailet/standard/index.html'/>
- </menu>
-
${reports}
</body>
Copied: james/server/trunk/src/site/xdoc/concept_queue_priority.xml (from r1021749, james/server/trunk/src/site/xdoc/queue_priority.xml)
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/concept_queue_priority.xml?p2=james/server/trunk/src/site/xdoc/concept_queue_priority.xml&p1=james/server/trunk/src/site/xdoc/queue_priority.xml&r1=1021749&r2=1021813&rev=1021813&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/queue_priority.xml (original)
+++ james/server/trunk/src/site/xdoc/concept_queue_priority.xml Tue Oct 12 16:00:07 2010
@@ -25,11 +25,11 @@
<body>
- <section name="Queue">
+ <section name="Queueing System">
</section>
- <section name="Priority">
+ <section name="Priority in the Queue">
<p>Priority is supported when James (de)queues the mails during the spooling process.</p>
Copied: james/server/trunk/src/site/xdoc/configuration.xml (from r1021749, james/server/trunk/src/site/xdoc/configuration_instructions.xml)
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/configuration.xml?p2=james/server/trunk/src/site/xdoc/configuration.xml&p1=james/server/trunk/src/site/xdoc/configuration_instructions.xml&r1=1021749&r2=1021813&rev=1021813&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/configuration_instructions.xml (original)
+++ james/server/trunk/src/site/xdoc/configuration.xml Tue Oct 12 16:00:07 2010
@@ -25,9 +25,28 @@
<body>
-<section name="Configuration">
+ <section name="Configuration">
+
+ <p>All configuration files resides in the conf and conf/META-INF directories.</p>
+
+ <p>You can configure James for on the following:</p>
+
+ <ul>
+ <li><a href="configuration_serverwide.html">Server-wide Configuration</a></li>
+ <li><a href="configuration_domains.html">Domains Configuration</a></li>
+ <li><a href="configuration_users.html">Users Configuration</a></li>
+ <li><a href="configuration_mailstores.html">Mail Stores Configuration</a></li>
+ <li><a href="configuration_dns.html">DNS Configuration</a></li>
+ <li><a href="configuration_imap4.html">IMAP4 Configuration</a></li>
+ <li><a href="configuration_pop3.html">POP3 Configuration</a></li>
+ <li><a href="configuration_smtp_lmtp.html">SMTP LMTP Configuration</a></li>
+ <li><a href="configuration_mailetcontainer.html">Mailet Container Configuration</a></li>
+ <li><a href="configuration_fetchmail.html">FetchMail Configuration</a></li>
+ <li><a href="configuration_remotemanager.html">Remote Manager Configuration</a></li>
+ <li><a href="configuration_listmanager.html">List Manager Configuration</a></li>
+ </ul>
-</section>
+ </section>
</body>
Copied: james/server/trunk/src/site/xdoc/configuration_common.xml (from r1021749, james/server/trunk/src/site/xdoc/common_configurations.xml)
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/configuration_common.xml?p2=james/server/trunk/src/site/xdoc/configuration_common.xml&p1=james/server/trunk/src/site/xdoc/common_configurations.xml&r1=1021749&r2=1021813&rev=1021813&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/common_configurations.xml (original)
+++ james/server/trunk/src/site/xdoc/configuration_common.xml Tue Oct 12 16:00:07 2010
@@ -20,11 +20,19 @@
<document>
<properties>
- <title>James 3.0 - Using Authenticated SMTP</title>
+ <title>James 3.0 - Common configurations</title>
</properties>
<body>
+ <section name="Use LDAP to store users">
+
+ </section>
+
+ <section name="Configure Sieve">
+
+ </section>
+
<section name="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
Copied: james/server/trunk/src/site/xdoc/configuration_fetchmail.xml (from r1021749, james/server/trunk/src/site/xdoc/fetchmail_configuration.xml)
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/configuration_fetchmail.xml?p2=james/server/trunk/src/site/xdoc/configuration_fetchmail.xml&p1=james/server/trunk/src/site/xdoc/fetchmail_configuration.xml&r1=1021749&r2=1021813&rev=1021813&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/fetchmail_configuration.xml (original)
+++ james/server/trunk/src/site/xdoc/configuration_fetchmail.xml Tue Oct 12 16:00:07 2010
@@ -45,7 +45,7 @@
<a href="#How_Fetchmail_Works">How Fetchmail Works</a><br/>
<a href="#Fetchmail_Configuration_Parameters">Fetchmail Configuration Parameters</a><br/>
<a href="#Fetchmail_Examples">Fetchmail Examples</a><br/>
- <a href="#Fetchmail_Caveats">Fetchmail Caveats</a>
+ <a href="#Fetchmail_Caveats">Fetchmail Caveats</a><br/>
<a href="#Fetchmail_Gmail">Fetchmail Gmail</a>
</p>
Copied: james/server/trunk/src/site/xdoc/configuration_imap4.xml (from r1021749, james/server/trunk/src/site/xdoc/imap4_configuration.xml)
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/configuration_imap4.xml?p2=james/server/trunk/src/site/xdoc/configuration_imap4.xml&p1=james/server/trunk/src/site/xdoc/imap4_configuration.xml&r1=1021749&r2=1021813&rev=1021813&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/imap4_configuration.xml (original)
+++ james/server/trunk/src/site/xdoc/configuration_imap4.xml Tue Oct 12 16:00:07 2010
@@ -27,6 +27,21 @@
<section name="IMAP4 Configuration">
+ <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
+ client connections managed by this connection manager to be marked at timed out. If no
+ value is specified, the value defaults to 5 minutes, 300000 milliseconds. A value of 0
+ means that client sockets will not timeout.</li>
+ <li><strong>max-connections</strong> - The max-connections parameter specifies the default
+ maximum number of client connections that this connection manager will allow per managed
+ server socket. This value can be overridden by each individual service. If no value is
+ specified, the value defaults to 30. A value of 0 means that there is no limit imposed
+ by the connection manager, although resource limitations imposed by other components
+ (i.e. max # of threads) may serve to limit the number of open connections.</li>
+ </ul>
+ </p>
+
</section>
</body>
Added: james/server/trunk/src/site/xdoc/configuration_listmanager.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/configuration_listmanager.xml?rev=1021813&view=auto
==============================================================================
--- james/server/trunk/src/site/xdoc/configuration_listmanager.xml (added)
+++ james/server/trunk/src/site/xdoc/configuration_listmanager.xml Tue Oct 12 16:00:07 2010
@@ -0,0 +1,34 @@
+<?xml version="1.0"?>
+<!--
+ 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.
+-->
+<document>
+
+ <properties>
+ <title>James 3.0 - List Manager Configuration</title>
+ </properties>
+
+<body>
+
+<section name="List Manager Configuration">
+
+</section>
+
+</body>
+
+</document>
Copied: james/server/trunk/src/site/xdoc/configuration_serverwide.xml (from r1021749, james/server/trunk/src/site/xdoc/serverwide_configuration.xml)
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/configuration_serverwide.xml?p2=james/server/trunk/src/site/xdoc/configuration_serverwide.xml&p1=james/server/trunk/src/site/xdoc/serverwide_configuration.xml&r1=1021749&r2=1021813&rev=1021813&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/serverwide_configuration.xml (original)
+++ james/server/trunk/src/site/xdoc/configuration_serverwide.xml Tue Oct 12 16:00:07 2010
@@ -24,77 +24,99 @@
</properties>
<body>
-<section name="Global Server Configuration">
-<p>There are a number of global configuration blocks that do not fall into any one
-component. They have effects that are global in scope across the server. Some of
-these blocks are crucial, while others can be ignored by any but the most sophisticated
-server administrators.</p>
-<subsection name="The James Block">
-<p>This configuration block is defined by the <strong>James</strong> tag. All administrators
-need to adjust this configuration block upon installation. It no attributes, but several
-children, all of which are required.
-<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>
-<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>inboxRepository</strong> - This is a simple container tag which contains a single child element.</li>
-<ul>
-<li><strong>repository</strong> - this defines the mail repository that will be used to store
-mail delivered locally. This element has no body. The required attribute <strong>type</strong>
-is always set to "MAIL". The required attribute <strong>repositoryURL</strong> addresses the
-repository as described in <a href="repositories.html">the repository configuration section</a>.</li>
-</ul>
-</ul>
-</p>
-</subsection>
-<subsection name="The Connectionmanager Block">
-<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
-client connections managed by this connection manager to be marked at timed out. If no
-value is specified, the value defaults to 5 minutes, 300000 milliseconds. A value of 0
-means that client sockets will not timeout.</li>
-<li><strong>max-connections</strong> - The max-connections parameter specifies the default
-maximum number of client connections that this connection manager will allow per managed
-server socket. This value can be overridden by each individual service. If no value is
-specified, the value defaults to 30. A value of 0 means that there is no limit imposed
-by the connection manager, although resource limitations imposed by other components
-(i.e. max # of threads) may serve to limit the number of open connections.</li>
-</ul>
-</p>
-</subsection>
-<subsection name="The Objectstorage Block">
-<p>This block controls the low level file repository to file mapping. There is no need to modify this.</p>
-</subsection>
-<subsection name="The Socketmanager Block">
-<p>This block controls the socket types available inside James. Unless you are intending to enable SSL, it
-shouldn't be necessary for you to adjust this block. For modifications to this block that are required to
-enable TLS, see <a href="usingTLS.html">the using TLS section</a>.</p>
-</subsection>
-<subsection name="The Threadmanager Block">
-<p>This block controls the thread pools available inside James. Only expert administators should modify
-this configuration.</p>
-</subsection>
-</section>
+
+ <section name="Global Server Configuration">
+
+ <p>There are a number of global configuration blocks that do not fall into any one
+ component. They have effects that are global in scope across the server. Some of
+ these blocks are crucial, while others can be ignored by any but the most sophisticated
+ server administrators.</p>
+
+ <subsection name="mailserver.xml">
+
+ <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.
+
+ <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>
+ <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>inboxRepository</strong> - This is a simple container tag which contains a single child element.</li>
+ <ul>
+ <li><strong>repository</strong> - this defines the mail repository that will be used to store
+ mail delivered locally. This element has no body. The required attribute <strong>type</strong>
+ is always set to "MAIL". The required attribute <strong>repositoryURL</strong> addresses the
+ repository as described in <a href="concept_repositories.html">the repository configuration section</a>.</li>
+ </ul>
+ </ul>
+ </p>
+
+ </subsection>
+
+ <subsection name="database.properties">
+
+ <p>The database connection in database.properties</p>
+
+ </subsection>
+
+ <subsection name="META-INF/persistence.xml">
+
+ <p>The JPA information in META-INF/persistence.xml.</p>
+
+ </subsection>
+
+ <subsection name="The Objectstorage Block">
+
+ <p>This block controls the low level file repository to file mapping.
+ There is no need to modify this.</p>
+
+ </subsection>
+
+ <subsection name="The Socketmanager Block">
+
+ <p>This block controls the socket types available inside James. Unless you are intending to enable SSL, it
+ shouldn't be necessary for you to adjust this block. For modifications to this block that are required to
+ enable TLS, see <a href="usingTLS.html">the using TLS section</a>.</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="monitoring_logging.html">logging page</a></li>
+ <li>database.properties</li>
+ <li>mailetpackages.xml and matcherpackages.xml</li>
+ <li>sqlResources.xml and mailboxManagerSqlResources.xml</li>
+ <li>bayesiananalyzermanagement.xml</li>
+ </ul>
+
+ </subsection>
+
+ </section>
+
</body>
+
</document>
Modified: james/server/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/index.xml?rev=1021813&r1=1021812&r2=1021813&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/index.xml (original)
+++ james/server/trunk/src/site/xdoc/index.xml Tue Oct 12 16:00:07 2010
@@ -27,6 +27,8 @@
<section name="James 3.0-M1">
+ <div style="float:left; width:70%;">
+
<p>The Java Apache Mail Enterprise Server (a.k.a. Apache James) is a 100% pure Java SMTP, IMAP4 and POP3 Mail
server designed to be a complete and portable enterprise mail engine solution.
James is based on currently available open protocols.</p>
@@ -36,34 +38,36 @@
and <a href="/build_james.html">develop</a> the James server.</p>
<p>James is <b>secured</b>, <b>performant</b>, <b>extensible</b> and supports many <b>features</b>.
- You can download stables releases, it from <a href="http://james.apache.org/download.cgi">here</a>
- (or from here for latest <a href="http://repository.apache.org/content/groups/snapshots/org/apache/james/james-server-spring-deployment/3.0-SNAPSHOT/ ">snapshots</a>).</p>
+ You can download stables releases from <a href="http://james.apache.org/download.cgi">here</a>
+ (or latest snapshots from <a href="http://repository.apache.org/content/groups/snapshots/org/apache/james/james-server-spring-deployment/3.0-SNAPSHOT/ ">here</a>).</p>
<subsection name="Secured">
- James is a secured mail server. See our <a href="/security.html">security</a> page to get more information.
+ <p>James is a secured mail server by default. You can read more on the existing security
+ measures and infrastructure on the <a href="/security.html">security</a>.</p>
</subsection>
<subsection name="Performant">
- James is a performant mail server. See our <a href="/performance.html">performance</a> page to get some numbers.
+ <p>A special focuss has been brought to the performance: James can process more than
+ 100 mails per second. See the <a href="/performance.html">performance</a> page to get more numbers.</p>
</subsection>
<subsection name="Extensible">
- <p>The James server also serves as a mail application platform. The James project hosts the Apache Mailet API,
- and the James server is a Mailet container. This feature makes it easy to design, write, and deploy
+ <p>James serves as a mail application platform. The James project hosts the Apache Mailet API,
+ and provides the Mailet container. These features makes it easy to design, write, and deploy
custom applications for mail processing. This modularity and ease of customization is one of James'
strengths, and can allow administrators to produce powerful applications surprisingly easily.</p>
<p>James 3.0 is now built on top of Spring 3.0 in replacement of trunk version of the <a href="http://avalon.apache.org/">Avalon Application Framework</a>.
- With Spring, We keep the good development practices introduced by Avalon such as
+ With Spring, We keep the good development practices introduced by Avalon such as
Component Oriented Programming and Inversion of Control.
The stable and robust Spring container provides a strong foundation for the James server.</p>
- <p>The internal APIs for this first miletstone release are under current validation and are
+ <p>The internal and exposed APIs for this 3.0-M1 release are under current validation and are
expected to be subject to change.</p>
</subsection>
@@ -72,8 +76,8 @@
<p>James 3.0 represents the leading edge of development. This codestream has many more
features than the 2.x code, but is not as well tested in production. Reasonable
- configuration compatibility has been retained with 3.0. James 3.0 requires Java 1.5 but Java 1.6 is recommended.
- A migration guide for users willing to upgrade from 3.0 to 3.0 is under development.
+ configuration compatibility has been retained with 3.0. James 3.0 requires Java 1.5 but Java 1.6 is recommended.
+ A migration guide for users willing to upgrade from 2.3 to 3.0 is <a href="james_upgrade.html">available</a>.
The NNTP News server present in James 2.3 has been removed from the 3.0 release line.</p>
<ul>
@@ -90,10 +94,16 @@
is able to maintain a constant mail throughput rate of thousands of
messages/minute for continuous periods.</li>
</ul>
+
+ </subsection>
- <table width="500">
+ </div>
+
+ <div style="float:right; width:30%;">
+
+ <table>
<tr>
- <th>Functionality</th>
+ <th>Feature</th>
<th align="center"><b>2.3.x</b></th>
<th align="center"><b>3.0</b></th>
</tr>
@@ -123,6 +133,11 @@
<td align="center">no</td>
</tr>
<tr>
+ <td>List Server</td>
+ <td align="center">yes</td>
+ <td align="center">yes</td>
+ </tr>
+ <tr>
<td>File Mail Store</td>
<td align="center">yes</td>
<td align="center">yes</td>
@@ -134,7 +149,7 @@
</tr>
<tr>
<td>JPA Database Mail Store</td>
- <td align="center"></td>
+ <td align="center">no</td>
<td align="center">yes</td>
</tr>
<tr>
@@ -143,89 +158,64 @@
<td align="center">yes</td>
</tr>
<tr>
- <td>Alternate Store</td>
- <td align="center">no</td>
+ <td>Mailets API</td>
+ <td align="center">yes</td>
<td align="center">yes</td>
</tr>
<tr>
- <td>Mailets API</td>
+ <td>Alternate User and Mail stores</td>
<td align="center">yes</td>
<td align="center">yes</td>
</tr>
<tr>
<td>Alternate Queue</td>
- <td align="center"></td>
+ <td align="center">no</td>
<td align="center">yes</td>
</tr>
<tr>
- <td>SpamAssassin</td>
+ <td>Integration with SpamAssassin</td>
<td align="center">partial</td>
<td align="center">yes</td>
</tr>
<tr>
+ <td>Run-as-service scripts</td>
+ <td align="center">no</td>
+ <td align="center">yes</td>
+ </tr>
+ <tr>
+ <td>Deployment in WEB container</td>
+ <td align="center">no</td>
+ <td align="center">yes</td>
+ </tr>
+ <tr>
+ <td>Deployment in OSGI container</td>
+ <td align="center">no</td>
+ <td align="center">planned</td>
+ </tr>
+ <tr>
+ <td>Configuration Hot Reload</td>
+ <td align="center">no</td>
+ <td align="center">planned</td>
+ </tr>
+ <tr>
+ <td>Monitoring via JMX</td>
+ <td align="center">yes</td>
+ <td align="center">planned</td>
+ </tr>
+ <tr>
<td>IP V6</td>
<td align="center">no</td>
<td align="center">partial</td>
</tr>
+ <tr>
+ <td>Java 1.4</td>
+ <td align="center">yes</td>
+ <td align="center">no</td>
+ </tr>
</table>
-
- </subsection>
-
- <!-- This hierarchy is present in the menu. It will be easier to not replicate it here
- <subsection name="Table of Contents">
- <p>
- I. James Concepts
- <ul>
- <li><a href="summary.html">Summary</a></li>
- <li><a href="spoolmanager.html">SpoolManager</a></li>
- <li><a href="repositories.html">Repositories</a></li>
- <li><a href="mailet_api.html">The Mailet API</a></li>
- </ul>
- II. How To Build James
- <ul>
- <li><a href="build_instructions.html">Building James</a></li>
- </ul>
- III. How To Install James
- <ul>
- <li><a href="installation_instructions.html">Installing James</a></li>
- </ul>
- IV. Configuring James
- <ul>
- <li><a href="dns_configuration.html">DNS Server Configuration</a></li>
- <li><a href="pop3_configuration.html">POP3 Server Configuration</a></li>
- <li><a href="smtp_configuration.html">SMTP Server Configuration</a></li>
- <li><a href="nntp_configuration.html">NNTP Server Configuration</a></li>
- <li><a href="fetchmail_configuration.html">fetchMail Configuration</a></li>
- <li><a href="remotemanager_configuration.html">RemoteManager Configuration</a></li>
- <li><a href="repositories.html">Repository Configuration</a></li>
- <li><a href="spoolmanager_configuration.html">SpoolManager Configuration</a></li>
- <li><a href="serverwide_configuration.html">Server-wide Configuration</a></li>
- <li><a href="adding_users.html">Adding Users</a></li>
- <li><a href="provided_matchers.html">Provided Matchers</a></li>
- <li><a href="provided_mailets.html">Provided Mailets</a></li>
- </ul>
- V. Common Configurations
- <ul>
- <li><a href="smtp_auth.html">Using SMTP AUTH</a></li>
- <li><a href="using_database.html">Using a Database with James</a></li>
- <li><a href="usingTLS.html">Using TLS/SSL</a></li>
- <li><a href="mailing_lists.html">Creating Mailing Lists</a></li>
- </ul>
- VI. Customizing James
- <ul>
- <li><a href="custom_matcher.html">How to write a custom Matcher</a></li>
- <li><a href="custom_mailet.html">How to write a custom Mailet</a></li>
- </ul>
- V. Other Information
- <ul>
- <li><a href="upgrade_instructions.html">Upgrade James</a></li>
- </ul>
- </p>
- </subsection>
+ </div>
- -->
-
</section>
</body>
Copied: james/server/trunk/src/site/xdoc/installation.xml (from r1021749, james/server/trunk/src/site/xdoc/installation_instructions.xml)
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/installation.xml?p2=james/server/trunk/src/site/xdoc/installation.xml&p1=james/server/trunk/src/site/xdoc/installation_instructions.xml&r1=1021749&r2=1021813&rev=1021813&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/installation_instructions.xml (original)
+++ james/server/trunk/src/site/xdoc/installation.xml Tue Oct 12 16:00:07 2010
@@ -22,95 +22,8 @@
<properties>
<title>James 3.0 - Installation</title>
</properties>
-<body>
-
-<section name="Step 0: Building. (only necessary for daily snapshots)">
-<p> If you have downloaded a binary distribution, you do not need to build James.
- Proceed directory to Step 1. </p>
-<p> To compile James from the source code you need <a href="http://ant.apache.org/">Ant</a>.
- This is a Java-tailored, XML-configured, extensible build or make system. We
- are currently using Ant 1.4, which is included in the source distribution.</p>
-<p> If you have downloaded a daily snapshot, you need to build a distribution.
- James includes Ant to compile and package its distribution. Extract the snapshot
- to your favorite directory, cd to that directory and run the build by calling "build"
- or "./build.sh" which will create an unpacked binary distribution
- in the dist directory, but no archives.</p>
-<p>This "./dist" directory is the distribution directory used in Step 1 and beyond.
- You may either cd to ./dist, or you may copy and rename the dist directory to your
- installation directory.</p>
-<p>If you prefer you can run build with the "dist" task "build dist"
- (or "./build.sh dist"). This will create the distribution in the "./dist"
- directory as well as create .tgz and .zip copies of this directory, however it may
- require other resources to build the documentation. </p>
-<p> <strong>Warning!</strong> Any changes you've made in the 'dist' directory
- will be lost after a recompilation. If you are making changes to the conf.xml
- or other files, we recommend you backup and then change the copies in src to
- avoid losing work. </p>
-</section> <section name="Step 1: Installation.">
-<p> Download distibution. Extract or copy all the files in the archive or dist
- directory intto your installation directory. </p>
-</section>
-
-<section name="Step 2: Configuration.">
- <p>
- Read the short and snappy documentation at docs/index.html for a proper
- overview of configuring the system.
- </p>
- <p>
- <b>Summary</b> (for impatient people)
- </p>
-
-<p> M$ users should just run /bin/run.bat. Unix users will find run.sh under the
- same directory. A JVM must be present and its location specified in the JAVA_HOME
- environment variable. Set this on windows at the command prompt with something
- similar to "set JAVA_HOME=\jdk1.3\bin" on *nix with JAVA_HOME=/jdk1.3/</p>
-<p> Running [run* --help] will provide a simple command line help. </p>
- <p>
- Most UNIX systems require superuser privileges to open sockets below 1024,
- which includes the IANA-standard SMTP (on port 25) and POP3 (on port 110).
- These default ports can be changed in the conf.xml file. (Obviously, you
- would then need to reconfigure your clients. This may not be an option if
- you want to receive mail from external mailservers.)
- </p>
-
-<p> The Avalon framework will unpack the necessary configuration files you will
- need to start the server. Wait until it is running, stop it again (ctrl-c), and
- edit the configuration (thereafter *nix users can run the server in the background
- using ./run.sh &). For basic use, you only need to set two items in the
- JAMES.conf.xml file: a root password for the remote administration facility
- and the IP address of a DNS server. Once you have edited the configuration files,
- press 'Enter' on the terminal where Avalon is waiting. </p>
-</section>
-
-<section name="Step 4: Kickstart.">
- <p>
- Once started you'll see a message saying Avalon is running. This means that
- Avalon has loaded JAMES and every other needed Block (see /logs/avalon.log)
- and is now waiting for a socket request.
- Since at the beginning James is empty, it will not have any local users
- registered.
- To register a local user open a telnet session with localhost on port 4555,
- log in as root ("root[enter] <password-you-set-in-conf.xml>[enter]") and
- type "help" for a list of available commands in the "JAMES remote
- administrator tool". It is really a basic set but should allow you to test
- installation.
- </p>
- <p>
- Once you have some local users registered, try sending mail to one of them
- @localhost with SMTP (port 25) (assuming you have not changed the default
- server names in the conf.xml file). You'll see the mail appear under
- ../var/mail/localinbox/[user].
- Try now to retrieve that mail using POP3 (port 110).
- Trace out JAMES actions in /logs/*info.log.
- Actions that will be taken by JAMES on incoming mail are configured in
- the mailet pipe line (/conf/JAMES.conf.xml). Look at it if you want to
- understand what's happening.
- </p>
- <p>
- Good luck :)
- </p>
-</section>
+<body>
<section name="Requirements">
<p>James requires a Java Runtime Environment of Java version 1.4 or higher installed to run the
@@ -126,6 +39,7 @@ server sockets on such ports in standard
Obviously James also requires sufficient disk space, processor power, and network bandwidth. But,
other than what's been discussed here, it has no additional special requirements.</p>
</section>
+
<section name="Installation Comments">
<p>James installation involves a number of steps, each of which is described in some detail in the
following sections. But as this sequence of steps has confused some users in the past, additional
@@ -155,14 +69,39 @@ will be ready to configure your James in
</subsection>
</section>
-<section name="Initial Configuration">
-<p>
-After installing the binary, the next step is to adjust the initial configuration. The server should be stopped, and then
+<section name="Step 0: Building. (only necessary for daily snapshots)">
+<p> If you have downloaded a binary distribution, you do not need to build James.
+ Proceed directory to Step 1. </p>
+<p> To compile James from the source code you need <a href="http://ant.apache.org/">Ant</a>.
+ This is a Java-tailored, XML-configured, extensible build or make system. We
+ are currently using Ant 1.4, which is included in the source distribution.</p>
+<p> If you have downloaded a daily snapshot, you need to build a distribution.
+ James includes Ant to compile and package its distribution. Extract the snapshot
+ to your favorite directory, cd to that directory and run the build by calling "build"
+ or "./build.sh" which will create an unpacked binary distribution
+ in the dist directory, but no archives.</p>
+<p>This "./dist" directory is the distribution directory used in Step 1 and beyond.
+ You may either cd to ./dist, or you may copy and rename the dist directory to your
+ installation directory.</p>
+<p>If you prefer you can run build with the "dist" task "build dist"
+ (or "./build.sh dist"). This will create the distribution in the "./dist"
+ directory as well as create .tgz and .zip copies of this directory, however it may
+ require other resources to build the documentation. </p>
+<p> <strong>Warning!</strong> Any changes you've made in the 'dist' directory
+ will be lost after a recompilation. If you are making changes to the conf.xml
+ or other files, we recommend you backup and then change the copies in src to
+ avoid losing work. </p>
+</section> <section name="Step 1: Installation.">
+<p> Download distibution. Extract or copy all the files in the archive or dist
+ directory intto your installation directory. </p>
+</section>
+
+<section name="Step 2: Configuration.">
+<p>After installing the binary, the next step is to adjust the initial configuration. The server should be stopped, and then
configuration can proceed. The most essential configuration is set in the config.xml file. This file can be
found in the apps/james/SAR-INF subdirectory of the installation directory.</p>
<p>The out of the box configuration makes certain assumptions and has some default values that are unlikely to
-be appropriate for real-world servers. There are a few issues that should be addressed immediately upon installation:
-</p>
+be appropriate for real-world servers. There are a few issues that should be addressed immediately upon installation:</p>
<ul>
<li>RemoteManager Administrator Account - Before the RemoteManager service can be used to add users to this server
installation an administrator account must be created. More information can be found <a href="remotemanager_configuration.html">here</a>.</li>
@@ -179,8 +118,35 @@ section of the config.xml. More informa
<p>In addition to adjusting these parameters, you may wish to consult the documentation for a discussion of
common configurations. A list of such configurations, as well as the steps necessary to configure them, can
be found <a href="index.html">here</a>.</p>
+ <p>Read the short and snappy documentation at docs/index.html for a proper
+ overview of configuring the system.</p>
+ <p>
+ <b>Summary</b> (for impatient people)
+ </p>
+
+<p> M$ users should just run /bin/run.bat. Unix users will find run.sh under the
+ same directory. A JVM must be present and its location specified in the JAVA_HOME
+ environment variable. Set this on windows at the command prompt with something
+ similar to "set JAVA_HOME=\jdk1.3\bin" on *nix with JAVA_HOME=/jdk1.3/</p>
+<p> Running [run* --help] will provide a simple command line help. </p>
+ <p>
+ Most UNIX systems require superuser privileges to open sockets below 1024,
+ which includes the IANA-standard SMTP (on port 25) and POP3 (on port 110).
+ These default ports can be changed in the conf.xml file. (Obviously, you
+ would then need to reconfigure your clients. This may not be an option if
+ you want to receive mail from external mailservers.)
+ </p>
+
+<p> The Avalon framework will unpack the necessary configuration files you will
+ need to start the server. Wait until it is running, stop it again (ctrl-c), and
+ edit the configuration (thereafter *nix users can run the server in the background
+ using ./run.sh &). For basic use, you only need to set two items in the
+ JAMES.conf.xml file: a root password for the remote administration facility
+ and the IP address of a DNS server. Once you have edited the configuration files,
+ press 'Enter' on the terminal where Avalon is waiting. </p>
</section>
-<section name="Starting James with Your Configuration">
+
+<section name="Step 4: Kickstart.">
<p>Once you have edited the configuration file you will need to restart James so that the changes take
effect. When James starts, a list of the James services and the ports on which they are listening should
be displayed on the console. Additional information about the system configuration is printed in the James log files
@@ -188,6 +154,25 @@ upon startup.</p>
<p>Finally, after configuration is complete, it will be necessary to create user accounts before the James server
will be fully operational. Instructions on creating user accounts can be found
<a href="adding_users.html">here</a>.</p>
+ <p>Once started you'll see a message saying Avalon is running. This means that
+ Avalon has loaded JAMES and every other needed Block (see /logs/avalon.log)
+ and is now waiting for a socket request.
+ Since at the beginning James is empty, it will not have any local users
+ registered.
+ To register a local user open a telnet session with localhost on port 4555,
+ log in as root ("root[enter] <password-you-set-in-conf.xml>[enter]") and
+ type "help" for a list of available commands in the "JAMES remote
+ administrator tool". It is really a basic set but should allow you to test
+ installation.</p>
+ <p>Once you have some local users registered, try sending mail to one of them
+ @localhost with SMTP (port 25) (assuming you have not changed the default
+ server names in the conf.xml file). You'll see the mail appear under
+ ../var/mail/localinbox/[user].
+ Try now to retrieve that mail using POP3 (port 110).
+ Trace out JAMES actions in /logs/*info.log.
+ Actions that will be taken by JAMES on incoming mail are configured in
+ the mailet pipe line (/conf/JAMES.conf.xml). Look at it if you want to
+ understand what's happening.</p>
</section>
</body>
Copied: james/server/trunk/src/site/xdoc/monitoring.xml (from r1021749, james/server/trunk/src/site/xdoc/monitoring_instructions.xml)
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/monitoring.xml?p2=james/server/trunk/src/site/xdoc/monitoring.xml&p1=james/server/trunk/src/site/xdoc/monitoring_instructions.xml&r1=1021749&r2=1021813&rev=1021813&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/monitoring_instructions.xml (original)
+++ james/server/trunk/src/site/xdoc/monitoring.xml Tue Oct 12 16:00:07 2010
@@ -26,6 +26,9 @@
<body>
<section name="Monitoring Instructions">
+
+ <p>smtp/imap/lmtp/pop3/remotemanager/dnsservice/domainlist</p>
+ <p>connections are active per component, whats the limit,...</p>
</section>
Copied: james/server/trunk/src/site/xdoc/monitoring_jmx.xml (from r1021749, james/server/trunk/src/site/xdoc/queues_monitoring.xml)
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/monitoring_jmx.xml?p2=james/server/trunk/src/site/xdoc/monitoring_jmx.xml&p1=james/server/trunk/src/site/xdoc/queues_monitoring.xml&r1=1021749&r2=1021813&rev=1021813&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/queues_monitoring.xml (original)
+++ james/server/trunk/src/site/xdoc/monitoring_jmx.xml Tue Oct 12 16:00:07 2010
@@ -20,13 +20,17 @@
<document>
<properties>
- <title>James 3.0 - Queues Monitoring</title>
+ <title>James 3.0 - JMX Monitoring</title>
</properties>
<body>
- <section name="Queues Monitoring">
+ <section name="JMX Monitoring">
+ <subsection name="Queues Monitoring">
+
+ </subsection>
+
</section>
</body>
Added: james/server/trunk/src/site/xdoc/monitoring_logging.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/monitoring_logging.xml?rev=1021813&view=auto
==============================================================================
--- james/server/trunk/src/site/xdoc/monitoring_logging.xml (added)
+++ james/server/trunk/src/site/xdoc/monitoring_logging.xml Tue Oct 12 16:00:07 2010
@@ -0,0 +1,34 @@
+<?xml version="1.0"?>
+<!--
+ 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.
+-->
+<document>
+
+ <properties>
+ <title>James 3.0 - Logging</title>
+ </properties>
+
+<body>
+
+ <section name="Logging">
+
+ </section>
+
+</body>
+
+</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org