You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@james.apache.org by ka...@apache.org on 2023/03/12 11:50:53 UTC
[james-project] 05/07: JAMES-3881 Update documentation accordingly
This is an automated email from the ASF dual-hosted git repository.
kao pushed a commit to branch 3.7.x
in repository https://gitbox.apache.org/repos/asf/james-project.git
commit 83d795a6e0ad5637469ce63a4e14851a01213ec0
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Wed Feb 15 22:00:50 2023 +0700
JAMES-3881 Update documentation accordingly
(cherry picked from commit 05bf241e4362cd55437900d1afeab9f5300c315f)
---
.../docs/modules/ROOT/pages/configure/jmx.adoc | 2 +-
src/site/xdoc/server/config-system.xml | 28 +++++++++++++++++++++-
2 files changed, 28 insertions(+), 2 deletions(-)
diff --git a/server/apps/distributed-app/docs/modules/ROOT/pages/configure/jmx.adoc b/server/apps/distributed-app/docs/modules/ROOT/pages/configure/jmx.adoc
index 996b8a6ebd..1b388427f0 100644
--- a/server/apps/distributed-app/docs/modules/ROOT/pages/configure/jmx.adoc
+++ b/server/apps/distributed-app/docs/modules/ROOT/pages/configure/jmx.adoc
@@ -44,7 +44,7 @@ james-admin readWrite
```
When James runs with option `-Djames.jmx.credential.generation=true`, James will automatically generate `jmxremote.password` if the file does not exist.
-Then the default username is `james-admin` and a random password.
+Then the default username is `james-admin` and a random password. This option defaults to true.
=== James-cli
diff --git a/src/site/xdoc/server/config-system.xml b/src/site/xdoc/server/config-system.xml
index 93e520d9fc..09211b265d 100644
--- a/src/site/xdoc/server/config-system.xml
+++ b/src/site/xdoc/server/config-system.xml
@@ -125,9 +125,35 @@
<dd>The port number the MBean Server will bind/listen to.</dd>
</dl>
- <p>To access from a remote location, it has been reported that -Dcom.sun.management.jmxremote.ssl=false is
+ <p>To access from a remote location, it has been reported that <code>-Dcom.sun.management.jmxremote.ssl=false</code> is
needed in the startup script.</p>
+ <b>JMX Security</b>
+
+ <p>Guice only</p>
+
+ <p>In order to set up JMX authentication, we need to put <code>jmxremote.password</code> and <code>jmxremote.access</code> file
+ to <code>/conf</code> directory.</p>
+
+ <p><code>jmxremote.password</code>: define the username and password, that will be used by the client (here is james-cli)</p>
+
+ <p>File's content example:</p>
+ <pre><code>
+ james-admin pass1
+ </code></pre>
+
+ <p><code>jmxremote.access</code>: define the pair of username and access permission</p>
+
+ <p>File's content example:</p>
+ <pre><code>
+ james-admin readWrite
+ </code></pre>
+
+ <p>When James runs with option <code>-Djames.jmx.credential.generation=true</code>, James will automatically
+ generate <code>jmxremote.password</code> if the file does not exist.
+ Then the default username is <code>james-admin</code> and a random password. This option defaults to true.</p>
+
+
</subsection>
<subsection name="sqlResources.xml">
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org