You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@james.apache.org by bt...@apache.org on 2023/05/12 01:38:53 UTC
[james-project] branch master updated: [DOC] Antora documentation should rely on --generate-keystore (#1556)
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
The following commit(s) were added to refs/heads/master by this push:
new b40c2a1125 [DOC] Antora documentation should rely on --generate-keystore (#1556)
b40c2a1125 is described below
commit b40c2a1125e3dc8b193b732a1cbe3aa53c564f57
Author: Benoit TELLIER <bt...@linagora.com>
AuthorDate: Fri May 12 08:38:47 2023 +0700
[DOC] Antora documentation should rely on --generate-keystore (#1556)
This ease the installation process
---
.../docs/modules/ROOT/pages/run/run-docker.adoc | 20 +++++++++++++-------
.../docs/modules/ROOT/pages/run/run-java.adoc | 18 +++++++++---------
2 files changed, 22 insertions(+), 16 deletions(-)
diff --git a/server/apps/distributed-app/docs/modules/ROOT/pages/run/run-docker.adoc b/server/apps/distributed-app/docs/modules/ROOT/pages/run/run-docker.adoc
index 63df91139a..449ac3039d 100644
--- a/server/apps/distributed-app/docs/modules/ROOT/pages/run/run-docker.adoc
+++ b/server/apps/distributed-app/docs/modules/ROOT/pages/run/run-docker.adoc
@@ -73,16 +73,10 @@ If you want to use all the JMAP search capabilities, you may also need to start
You can find more explanation on the need of Tika in this xref:configure/tika.adoc[page].
-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 the current folder or generate it using the following command. The password must be `james72laBalle` to match default configuration.
-
- $ keytool -genkey -alias james -keyalg RSA -keystore keystore
-
To run this container :
$ docker run --network james --hostname HOSTNAME -p "25:25" -p 80:80 -p "110:110" -p "143:143" -p "465:465" -p "587:587" -p "993:993" -p "127.0.0.1:8000:8000" --name james_run
- -v $PWD/keystore:/root/conf/keystore -t apache/james:distributed-3.7.4
+ -v $PWD/keystore:/root/conf/keystore -t apache/james:distributed-3.7.4 --generate-keystore
Where :
@@ -97,6 +91,18 @@ If you want to pass additional options to the underlying java command, you can c
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.
+=== Specific keystore
+
+
+Alternatively, you can also generate a keystore in your conf folder with the
+following command, and drop `--generate-keystore` option:
+
+
+[source,bash]
+----
+$ keytool -genkey -alias james -keyalg RSA -keystore conf/keystore
+----
+
=== Instrumentation
You can use link:https://glowroot.org/[Glowroot] to instrumentalize James. It is packaged as part of the docker distribution to easily enable valuable performances insights.
Disabled by default, its java agent can easily be enabled:
diff --git a/server/apps/distributed-app/docs/modules/ROOT/pages/run/run-java.adoc b/server/apps/distributed-app/docs/modules/ROOT/pages/run/run-java.adoc
index 7d62facae4..052537523d 100644
--- a/server/apps/distributed-app/docs/modules/ROOT/pages/run/run-java.adoc
+++ b/server/apps/distributed-app/docs/modules/ROOT/pages/run/run-java.adoc
@@ -45,14 +45,6 @@ configuration from
https://github.com/apache/james-project/blob/master/server/apps/distributed-app/sample-configuration/[server/apps/distributed-app/sample-configuration/].
You might need to adapt it to your needs.
-You also need to generate a keystore in your conf folder with the
-following command:
-
-[source,bash]
-----
-$ keytool -genkey -alias james -keyalg RSA -keystore conf/keystore
-----
-
You need to have a Cassandra, OpenSearch, S3 and RabbitMQ instance
running. You can either install the servers or launch them via docker:
@@ -68,7 +60,15 @@ Once everything is set up, you just have to run the jar with:
[source,bash]
----
-$ java -Dworking.directory=. -jar target/james-server-distributed-app.jar
+$ java -Dworking.directory=. -jar target/james-server-distributed-app.jar --generate-keystore
+----
+
+Alternatively, you can also generate a keystore in your conf folder with the
+following command, and drop `--generate-keystore` option:
+
+[source,bash]
+----
+$ keytool -genkey -alias james -keyalg RSA -keystore conf/keystore
----
==== Using AWS S3 of Zenko Cloudserver
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org