You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by bt...@apache.org on 2017/02/28 11:45:10 UTC
[3/6] james-project git commit: MAILBOX-287 Update website
documentation about ES configuration
MAILBOX-287 Update website documentation about ES configuration
Project: http://git-wip-us.apache.org/repos/asf/james-project/repo
Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/78426b88
Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/78426b88
Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/78426b88
Branch: refs/heads/master
Commit: 78426b881e7ef83f5dca2739fb6d54af7cb411fb
Parents: 8164bad
Author: benwa <bt...@linagora.com>
Authored: Fri Feb 24 11:54:25 2017 +0700
Committer: benwa <bt...@linagora.com>
Committed: Tue Feb 28 18:44:33 2017 +0700
----------------------------------------------------------------------
server/src/site/xdoc/config-elasticsearch.xml | 59 +++++++++++++++++++---
1 file changed, 52 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/james-project/blob/78426b88/server/src/site/xdoc/config-elasticsearch.xml
----------------------------------------------------------------------
diff --git a/server/src/site/xdoc/config-elasticsearch.xml b/server/src/site/xdoc/config-elasticsearch.xml
index 3b5cd2c..1444431 100644
--- a/server/src/site/xdoc/config-elasticsearch.xml
+++ b/server/src/site/xdoc/config-elasticsearch.xml
@@ -27,15 +27,60 @@
<section name="ElasticSearch Configuration">
- <p>Consult <a href="https://github.com/apache/james-project/tree/master/server/app/src/main/resources/elasticsearch-template.properties">elasticsearch-template.properties</a> to get some examples and hints.</p>
+ This configuration applies only to Guice packaging.
+
+ <p>Consult <a href="https://github.com/apache/james-project/blob/master/dockerfiles/run/guice/cassandra/destination/conf/elasticsearch.properties">elasticsearch-template.properties</a> to get some examples and hints.</p>
+
+ Connection to a cluster :
+
+ <dl>
+ <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>
+ </dl>
+
+ Or you can connect a cluster by :
+
+ <dl>
+ <dt><strong>elasticsearch.hosts</strong></dt>
+ <dd>List of comma separated hosts. An host is composed of an address and a port separated by a ':'. Example : elasticsearch.hosts=host1:9300,host2:9300</dd>
+ </dl>
+
+ Other options includes :
+
+ <dl>
+ <dt><strong>elasticsearch.clusterName</strong></dt>
+ <dd>Is the name of the cluster used by James.</dd>
+ <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>
+ <dt><strong>elasticsearch.retryConnection.maxRetries</strong></dt>
+ <dd>Number of retries when connecting the cluster</dd>
+ <dt><strong>elasticsearch.retryConnection.minDelay</strong></dt>
+ <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>
+ </dl>
+
+ For configuring the metric reporting on ElasticSearch :
<dl>
- <dt><strong>elasticsearch.clusterName</strong></dt>
- <dd>Is the name of the cluster used by James.</dd>
- <dt><strong>elasticsearch.masterHost</strong></dt>
- <dd>Is the IP (or host) of the ElasticSearch master</dd>
- <dt><strong>elasticsearch.indexAttachments</strong></dt>
- <dd>Indicates if you wish to index attachments or not (default: true).</dd>
+ <dt><strong>elasticsearch.http.host</strong></dt>
+ <dd>Host to report metrics on. Defaults to master host.</dd>
+
+ <dt><strong>elasticsearch.http.port</strong></dt>
+ <dd>Http port to use for publishing metrics</dd>
+
+ <dt><strong>elasticsearch.metrics.reports.enabled</strong></dt>
+ <dd>Boolean value. Enables metrics reporting.</dd>
+
+ <dt><strong>elasticsearch.metrics.reports.period</strong></dt>
+ <dd>Seconds between metric reports</dd>
+
+ <dt><strong>elasticsearch.metrics.reports.index</strong></dt>
+ <dd>Index to publish metrics on</dd>
</dl>
<p>If you want more explanation about ElasticSearch configuration, you should visit the dedicated <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html">documentation</a>.</p>
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org