james-server-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rouaz...@apache.org
Subject james-project git commit: JAMES-2461 Complete some missing documentation
Date Fri, 13 Jul 2018 13:59:59 GMT
Repository: james-project
Updated Branches:
  refs/heads/master 7442ad385 -> 0855a757f


JAMES-2461 Complete some missing 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/0855a757
Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/0855a757
Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/0855a757

Branch: refs/heads/master
Commit: 0855a757f026ab4e8d734b6d5790ab0e380bc8f5
Parents: 7442ad3
Author: Gautier DI FOLCO <gdifolco@linagora.com>
Authored: Tue Jul 10 11:48:59 2018 +0200
Committer: Gautier DI FOLCO <gdifolco@linagora.com>
Committed: Fri Jul 13 15:57:21 2018 +0200

----------------------------------------------------------------------
 src/site/xdoc/server/config-domainlist.xml    |  2 +
 src/site/xdoc/server/config-elasticsearch.xml | 10 +++-
 src/site/xdoc/server/config-imap4.xml         |  4 +-
 src/site/xdoc/server/config-webadmin.xml      | 63 ++++++++++++++++++++++
 src/site/xdoc/server/config.xml               |  5 ++
 src/site/xdoc/server/dev-activemq.xml         | 55 +++++++++++++++++++
 src/site/xdoc/server/dev.xml                  |  4 +-
 src/site/xdoc/server/monitor-folders.xml      |  2 +-
 8 files changed, 139 insertions(+), 6 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/james-project/blob/0855a757/src/site/xdoc/server/config-domainlist.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/server/config-domainlist.xml b/src/site/xdoc/server/config-domainlist.xml
index 7ff03c1..8337e0d 100644
--- a/src/site/xdoc/server/config-domainlist.xml
+++ b/src/site/xdoc/server/config-domainlist.xml
@@ -33,6 +33,8 @@
       
       <p>Using Spring, you must specify the DomainList class as attribute of the domainlist
tag (org.apache.james.domainlist.jpa.JPADomainList, or org.apache.james.domainlist.xml.XMLDomainList,
or...). This have no effect when using Guice.</p>
 
+      <p>JAMES-Guice uses a bundled domain list and you don't need to specify class
attribute in <strong>domainlist</strong> tag</p>
+
       <dl>
         <dt><strong>domainnames</strong></dt>
         <dd>Domainnames identifies the DNS namespace served by this instance of James.


http://git-wip-us.apache.org/repos/asf/james-project/blob/0855a757/src/site/xdoc/server/config-elasticsearch.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/server/config-elasticsearch.xml b/src/site/xdoc/server/config-elasticsearch.xml
index 2e2812f..33600f1 100644
--- a/src/site/xdoc/server/config-elasticsearch.xml
+++ b/src/site/xdoc/server/config-elasticsearch.xml
@@ -37,7 +37,7 @@
           <dt><strong>elasticsearch.masterHost</strong></dt>
           <dd>Is the IP (or host) of the ElasticSearch master</dd>
           <dt><strong>elasticsearch.port</strong></dt>
-          <dd>Is the IP (or host) of the port of ElasticSearch master</dd>
+          <dd>Is the port of ElasticSearch master</dd>
       </dl>
 
       Or you can connect a cluster by :
@@ -55,7 +55,7 @@
           <dt><strong>elasticsearch.nb.shards</strong></dt>
           <dd>Number of shards for index provisionned by James</dd>
           <dt><strong>elasticsearch.nb.replica</strong></dt>
-          <dd>Number of replica for index provisionned by James</dd>
+          <dd>Number of replica for index provisionned by James (default: 0)</dd>
           <dt><strong>elasticsearch.index.mailbox.name</strong></dt>
           <dd>Name of the mailbox index backed by the alias. It will be created if
missing.</dd>
           <dt><strong>elasticsearch.index.name</strong></dt>
@@ -81,6 +81,12 @@
           <dd>Minimum delay between connection attempts</dd>
           <dt><strong>elasticsearch.indexAttachments</strong></dt>
           <dd>Indicates if you wish to index attachments or not (default: true).</dd>
+          <dt><strong>elasticsearch.index.quota.ratio.name</strong></dt>
+          <dd>Specify the ElasticSearch alias name used for quotas</dd>
+          <dt><strong>elasticsearch.alias.read.quota.ratio.name</strong></dt>
+          <dd>Specify the ElasticSearch alias name used for reading quotas</dd>
+          <dt><strong>elasticsearch.alias.write.quota.ratio.name</strong></dt>
+          <dd>Specify the ElasticSearch alias name used for writing quotas</dd>
       </dl>
 
       For configuring the metric reporting on ElasticSearch :

http://git-wip-us.apache.org/repos/asf/james-project/blob/0855a757/src/site/xdoc/server/config-imap4.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/server/config-imap4.xml b/src/site/xdoc/server/config-imap4.xml
index 1dab962..d997723 100644
--- a/src/site/xdoc/server/config-imap4.xml
+++ b/src/site/xdoc/server/config-imap4.xml
@@ -47,7 +47,7 @@
       port 143 is the well-known/IANA registered port for IMAP 
      port 993 is the well-known/IANA registered port for IMAPS  ie over SSL/TLS</dd>
         <dt><strong>connectionBacklog</strong></dt>
-        <dd></dd>
+        <dd>Number of connection backlog of the server (maximum number of queued connection
requests)</dd>
         <dt><strong>compress</strong></dt>
         <dd>true or false - Use or don't use COMPRESS extension.</dd>
         <dt><strong>maxLineLength</strong></dt>
@@ -55,6 +55,8 @@
             This should be set with caution as a to high value can make the server a target
for DOS (Denial of Service)!</dd>
         <dt><strong>inMemorySizeLimit</strong></dt>
         <dd>10MB size limit before we will start to stream to a temporary file</dd>
+        <dt><strong>jmxName</strong></dt>
+        <dd>The name given to the configuration</dd>
         <dt><strong>tls</strong></dt>
         <dd>Set to true to support STARTTLS or SSL for the Socket.
          To use this you need to copy sunjce_provider.jar to /path/james/lib directory. To
create a new keystore execute:

http://git-wip-us.apache.org/repos/asf/james-project/blob/0855a757/src/site/xdoc/server/config-webadmin.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/server/config-webadmin.xml b/src/site/xdoc/server/config-webadmin.xml
new file mode 100644
index 0000000..31ed7de
--- /dev/null
+++ b/src/site/xdoc/server/config-webadmin.xml
@@ -0,0 +1,63 @@
+<?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>Apache James Server 3 - WebAdmin Configuration</title>
+ </properties>
+
+<body>
+
+  <section name="WebAdmin Configuration">
+
+    <p>Consult <a href="https://github.com/apache/james-project/server/container/guice/memory-guice/sample-configuration/webadmin.properties">webadmin.properties</a>
in GIT to get some examples and hints.</p>
+
+    <p>Use this configuration to define the WebAdmin's responding host and port.</p>
+
+    <dl>
+        <dt><strong>enabled</strong></dt>
+        <dd>Define if WebAdmin is launched (default: false)</dd>
+        <dt><strong>port</strong></dt>
+        <dd>Define WebAdmin's port (default: 8080)</dd>
+        <dt><strong>host</strong></dt>
+        <dd>Define WebAdmin's host (default: localhost)</dd>
+        <dt><strong>cors.enable</strong></dt>
+        <dd>Allow the Cross-origin resource sharing (default: false)</dd>
+        <dt><strong>cors.origin</strong></dt>
+        <dd>Specify ths CORS origin (default: null)</dd>
+        <dt><strong>jwt.enable</strong></dt>
+        <dd>Allow JSON Web Token (default: false)</dd>
+        <dt><strong>https.enable</strong></dt>
+        <dd>Use https (default: false)</dd>
+        <dt><strong>https.keystore</strong></dt>
+        <dd>Specify a keystore file for https (default: null)</dd>
+        <dt><strong>https.password</strong></dt>
+        <dd>Specify the keystore password (default: null)</dd>
+        <dt><strong>https.trust.keystore</strong></dt>
+        <dd>Specify a truststore file for https (default: null)</dd>
+        <dt><strong>https.trust.password</strong></dt>
+        <dd>Specify the truststore password (default: null)</dd>
+    </dl>
+  </section>
+
+</body>
+
+</document>
+

http://git-wip-us.apache.org/repos/asf/james-project/blob/0855a757/src/site/xdoc/server/config.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/server/config.xml b/src/site/xdoc/server/config.xml
index 073c97e..96dad73 100644
--- a/src/site/xdoc/server/config.xml
+++ b/src/site/xdoc/server/config.xml
@@ -128,6 +128,11 @@
         <td><a href="config-jmap.html">JMAP Configuration (Guice only)</a></td>
         <td></td>
       </tr>
+      <tr>
+        <td><a href="https://github.com/apache/james-project/blob/master/dockerfiles/run/guice/cassandra-ldap/destination/conf/webadmin.properties">webadmin.properties</a></td>
+        <td><a href="config-webadmin.html">WebAdmin Configuration</a></td>
+        <td></td>
+      </tr>
 
     </table>
     

http://git-wip-us.apache.org/repos/asf/james-project/blob/0855a757/src/site/xdoc/server/dev-activemq.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/server/dev-activemq.xml b/src/site/xdoc/server/dev-activemq.xml
new file mode 100644
index 0000000..f2c2eec
--- /dev/null
+++ b/src/site/xdoc/server/dev-activemq.xml
@@ -0,0 +1,55 @@
+<?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>Apache James Server 3 - ActiveMQ</title>
+ </properties>
+
+  <head>
+    <script type="text/javascript" src="./js/dev-extend.js" />
+  </head>
+
+<body>
+
+<section name="ActiveMQ">
+
+  <subsection name="Specification">
+
+    <p>By default with James spring, ActiveMQ is activated, an <strong>mailqueuefactory</strong>
is searched in the class path, see <a href="https://github.com/linagora/james-project/blob/master/server/container/spring/src/main/resources/META-INF/org/apache/james/spring-server.xml">import</a>
and <a href="https://github.com/linagora/james-project/blob/master/server/queue/queue-activemq/src/main/resources/META-INF/spring/activemq-queue-context.xml">initialisation</a>.</p>
+
+  </subsection>
+  <subsection name="Initialisation">
+
+      You have to declare a bean identified as <strong>mailqueuefactory</strong>
with the type
+      <strong>org.apache.james.queue.activemq.ActiveMQMailQueueFactory</strong>
with the following indexed-arguments:
+
+    <dl>
+    <dt><strong>org.apache.james.queue.activemq.EmbeddedActiveMQ</strong></dt>
+    <dt><strong>iorg.apache.james.queue.api.MailQueueItemDecoratorFactory</strong></dt>
+    <dt><strong>iorg.apache.james.metrics.api.MetricFactory</strong></dt>
+
+  </subsection>
+
+</section>
+
+</body>
+
+</document>

http://git-wip-us.apache.org/repos/asf/james-project/blob/0855a757/src/site/xdoc/server/dev.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/server/dev.xml b/src/site/xdoc/server/dev.xml
index 5ba147b..dd14648 100644
--- a/src/site/xdoc/server/dev.xml
+++ b/src/site/xdoc/server/dev.xml
@@ -51,12 +51,12 @@
     <p>The mail protocol services use the mailbox librairies to fetch/store mails.</p>
     
     <p>When a mail arrives via SMTP, it gets processed by the SMTP services and is
placed
-       in a Apache ActiveMQ queue (ActiveMQ  is the Java Messaging Service JMS implementation
at Apache)</p>
+       in a <a href="dev-activemq.xml">Apache ActiveMQ</a> queue (ActiveMQ  is
the Java Messaging Service JMS implementation at Apache)</p>
        
     <p>This allow to decouple mail spooling from the rest of the incoming traffic.</p>
     
     <p>After being the put in the queue, the mailetcontainer is responsible to get
the 
-       next mail to process from the ActiveMQ queue.</p>
+       next mail to process from the <a href="dev-activemq.xml">ActiveMQ queue</a>.</p>
        
     <p>The mailets defined in mailetcontainer.xml are applied to define if the mail
is to be 
        treated as a Local or Remote delivery.</p>

http://git-wip-us.apache.org/repos/asf/james-project/blob/0855a757/src/site/xdoc/server/monitor-folders.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/server/monitor-folders.xml b/src/site/xdoc/server/monitor-folders.xml
index dc389fb..2320118 100644
--- a/src/site/xdoc/server/monitor-folders.xml
+++ b/src/site/xdoc/server/monitor-folders.xml
@@ -84,7 +84,7 @@ activemq
   +-spool
 </source>
           
-          <p>The activemq component is configured to use this folder
+          <p>The <a href="dev-activemq.html">activemq component</a> is
configured to use this folder
              for queue (and topics if any) processing.</p>
      
 <source>


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


Mime
View raw message