This is an automated email from the ASF dual-hosted git repository. btellier pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/james-project.git
commit e83bb6d306af2affe134722e7a68b37723c32af3 Author: Juhan Aasaru <[email protected]> AuthorDate: Mon Sep 21 14:51:33 2020 +0300 JAMES-3187 remove separate chapters "Handling attachment indexing" and include the same info into respective place in documentation (to avoid information being repeated in several places) --- README.adoc | 44 +++++++++++--------------------------------- 1 file changed, 11 insertions(+), 33 deletions(-) diff --git a/README.adoc b/README.adoc index 934388d..3ac6b06 100644 --- a/README.adoc +++ b/README.adoc @@ -161,18 +161,18 @@ You need a running *rabbitmq* in docker. To achieve this run: You need a running *s3* compatible objectstorage in docker. To achieve this run: - $ docker run -d --env 'REMOTE_MANAGEMENT_DISABLE=1' --env 'SCALITY_ACCESS_KEY_ID=accessKey1' --env 'SCALITY_SECRET_ACCESS_KEY=secretKey1' --name=s3 zenko/cloudserver:8.2.6 + $ docker run -d -p 8080:8000 --env 'REMOTE_MANAGEMENT_DISABLE=1' --env 'SCALITY_ACCESS_KEY_ID=accessKey1' --env 'SCALITY_SECRET_ACCESS_KEY=secretKey1' --name=s3 zenko/cloudserver:8.2.6 You need a running *ElasticSearch* in docker. To achieve this run: $ docker run -d --name=elasticsearch --env 'discovery.type=single-node' docker.elastic.co/elasticsearch/elasticsearch:6.3.2 -If you want to use all the JMAP search capabilities, you may also need to start Tika: +If you want to handle attachment text extraction before indexing in ElasticSearch (this makes attachments searchable) +and if you want to use all the JMAP search capabilities, you also need to start *Tika*. +See http://james.apache.org/server/config-elasticsearch.html#Tika_Configuration[Tika configuration documentation] for more info. $ docker run -d --name=tika apache/tika:1.24 -You can find more explanation on the need of Tika in this page http://james.apache.org/server/config-elasticsearch.html - We need to provide the key we will use for TLS. For obvious reasons, this is not provided in this git. Copy your TLS keys to `run/guice/cassandra-rabbitmq/destination/conf/keystore` or generate it using the following command. The password must be `james72laBalle` to match default configuration. @@ -190,7 +190,8 @@ To run this container : Where : -- HOSTNAME: is the hostname you want to give to your James container. This DNS entry will be used to send mail to your James server. +- HOSTNAME is the hostname you want to give to your James container. This DNS entry will be used to send mail to your James server. +- link to tika is only needed if you started tika earlier. Webadmin port binding is restricted to loopback as users are not authenticated by default on webadmin server. Thus you should avoid exposing it in production. Note that the above example assumes `127.0.0.1` is your loopback interface for convenience but you should change it if this is not the case on your machine. @@ -215,18 +216,6 @@ See the https://github.com/glowroot/glowroot/wiki/Agent-Installation-(with-Embed Or by mapping the 4000 port to the IP of the desired network interface, for example `-p 127.0.0.1:4000:4000`. -==== Handling attachment indexing - -You can handle attachment text extraction before indexing in ElasticSearch. This makes attachments searchable. To enable this: - -Run tika: - - $ docker run --name tika apache/tika:1.24 - -Add a link for the tika container in the above command line: - - $ docker run --hostname HOSTNAME -p "25:25" -p 80:80 -p "110:110" -p "143:143" -p "465:465" -p "587:587" -p "993:993" --link cassandra:cassandra --link rabbitmq:rabbitmq - --link elasticsearch:elasticsearch --link tika:tika --name james_run -t james_run === Run James with Guice + Cassandra + ElasticSearch @@ -250,12 +239,12 @@ You need a running *ElasticSearch* in docker. To achieve this run: $ docker run -d --name=elasticsearch --env 'discovery.type=single-node' docker.elastic.co/elasticsearch/elasticsearch:6.3.2 -If you want to use all the JMAP search capabilities, you may also need to start Tika: +If you want to handle attachment text extraction before indexing in ElasticSearch (this makes attachments searchable) +and if you want to use all the JMAP search capabilities, you also need to start *Tika*. +See http://james.apache.org/server/config-elasticsearch.html#Tika_Configuration[Tika configuration documentation] for more info. $ docker run -d --name=tika apache/tika:1.24 -You can find more explanation on the need of Tika in this page http://james.apache.org/server/config-elasticsearch.html - We need to provide the key we will use for TLS. For obvious reasons, this is not provided in this git. Copy your TLS keys to `run/guice/cassandra/destination/conf/keystore` or generate it using the following command. The password must be `james72laBalle` to match default configuration. @@ -272,25 +261,14 @@ To run this container : Where : -- HOSTNAME: is the hostname you want to give to your James container. This DNS entry will be used to send mail to your James server. +- HOSTNAME is the hostname you want to give to your James container. This DNS entry will be used to send mail to your James server. +- link to tika is only needed if you started tika earlier. Webadmin port binding is restricted to loopback as users are not authenticated by default on webadmin server. Thus you should avoid exposing it in production. Note that the above example assumes `127.0.0.1` is your loopback interface for convenience but you should change it if this is not the case on your machine. To have log file accessible on a volume, add *-v $PWD/logs:/logs* option to the above command line, where *$PWD/logs* is your local directory to put files in. -==== Handling attachment indexing - -You can handle attachment text extraction before indexing in ElasticSearch. This makes attachments searchable. To enable this: - -Run tika: - - $ docker run --name tika apache/tika:1.24 - -Add a link for the tika container in the above command line: - - $ docker run --hostname HOSTNAME -p "25:25" -p 80:80 -p "110:110" -p "143:143" -p "465:465" -p "587:587" -p "993:993" --link cassandra:cassandra --link elasticsearch:elasticsearch --link tika:tika --name james_run -t james_run - === Run James with Guice + JPA + Lucene ==== Requirements --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
