JAMES-1589 Add minimal documentation

Project: http://git-wip-us.apache.org/repos/asf/james-project/repo
Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/1046e4da
Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/1046e4da
Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/1046e4da

Branch: refs/heads/master
Commit: 1046e4daf36a4f13ab92b2114fa7f43c8bcc4e5c
Parents: ea22ede
Author: benwa <btell...@linagora.com>
Authored: Fri Aug 4 17:34:38 2017 +0700
Committer: benwa <btell...@linagora.com>
Committed: Tue Aug 8 17:10:16 2017 +0700

 README.adoc                                | 5 +++++
 src/site/xdoc/server/config-domainlist.xml | 6 ++++--
 2 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/README.adoc b/README.adoc
index ed6de17..ccd6c32 100644
--- a/README.adoc
+++ b/README.adoc
@@ -279,6 +279,11 @@ The base command is different whether you choose guice 
flavor or spring :
 DOMAIN: is the domain you want to add.
+Note: Using docker, one can add an environment variable holding the domain to 
be created. This
+domain will be created upon James start:
+    $ --environment DOMAIN=domain.tld
 ==== How to add a user ?
     $ <your-command-here> -h -p 9999 adduser USER_MAIL_ADDRESS 

diff --git a/src/site/xdoc/server/config-domainlist.xml 
index 3682df9..7ff03c1 100644
--- a/src/site/xdoc/server/config-domainlist.xml
+++ b/src/site/xdoc/server/config-domainlist.xml
@@ -37,7 +37,7 @@
         <dd>Domainnames identifies the DNS namespace served by this instance 
of James. 
 These domainnames are used for both matcher/mailet processing and SMTP auth 
-to determine when a mail is intended for local delivery - Only applicable for 
+to determine when a mail is intended for local delivery - Only applicable for 
XMLDomainList. The entries mentionned here will be created upon start.</dd>
         <dd>true or false - If autodetect is true, James wil attempt to 
discover its own host name AND 
 use any explicitly specified servernames. 
@@ -47,9 +47,11 @@ If autodetect is false, James will use only the specified 
 The automatic IP detection is to support RFC 2821, Sec 4.1.3, address 
         <dd>Set the default domain which will be used if an email is send to a 
recipient without a domain part.
-            If not defaultdomain is set the first domain of the DomainList get 
+            If not defaultdomain is set the first domain of the DomainList get 
used. If the default is not yet contained by the Domain List, the domain will 
be created upon start.</dd>
+      <p>Please note that you can expose the <b>DOMAIN</b> variable to create 
a domain upon start without requiring further configuration.</p>
 <p>To override autodetected domainames names simply add explicit domainname 
 In most cases this will be necessary. By default, the domainname 'localhost' 
is specified. This can be removed, if required.</p>

To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org
For additional commands, e-mail: server-dev-h...@james.apache.org

Reply via email to