This is an automated email from the ASF dual-hosted git repository. quantranhong1999 pushed a commit to branch 3.8.x in repository https://gitbox.apache.org/repos/asf/james-project.git
commit 7bf0a5cd2ae87851f431ce98349413ebeb269aeb Author: Quan Tran <[email protected]> AuthorDate: Wed Jul 29 10:31:51 2026 +0700 [DOCUMENTATION] Webadmin: ease customization demos Disable generated WebAdmin credentials in the custom-route and Rspamd local customization samples so their unauthenticated example requests remain easy to run. Document that production-facing WebAdmin deployments should keep authentication enabled. --- examples/custom-webadmin-route/README.md | 10 +++++++++- .../src/main/resources/webadmin.properties | 4 ++++ third-party/rspamd/README.md | 8 +++++++- third-party/rspamd/sample-configuration/webadmin.properties | 6 +++++- 4 files changed, 25 insertions(+), 3 deletions(-) diff --git a/examples/custom-webadmin-route/README.md b/examples/custom-webadmin-route/README.md index eba5a849d6..7f391315d9 100644 --- a/examples/custom-webadmin-route/README.md +++ b/examples/custom-webadmin-route/README.md @@ -48,12 +48,20 @@ enabled=true port=8000 host=localhost +# Disable WebAdmin authentication for this local customization demo. +# Password generation defaults to true when no password is explicitly configured. +password.generate=false + # List of fully qualified class names that should be exposed over webadmin # in addition to your product default routes. Routes needs to be located # within the classpath or in the ./extensions-jars folder. extensions.routes=org.apache.james.examples.RouteA ``` +This example explicitly disables WebAdmin password generation to keep the customization demo simple. By default, +`password.generate` is enabled and James generates a random WebAdmin password at startup when no `password` is +explicitly configured. Do not disable WebAdmin authentication when exposing it beyond this local demo. + Create a keystore (default password being `james72laBalle`): ``` @@ -76,4 +84,4 @@ You can play with `curl` utility with the resulting server: ``` $ curl -XGET http://172.17.0.2:8000/hello/a RouteA -``` \ No newline at end of file +``` diff --git a/examples/custom-webadmin-route/src/main/resources/webadmin.properties b/examples/custom-webadmin-route/src/main/resources/webadmin.properties index d19b4e5f2a..db5f66a12d 100644 --- a/examples/custom-webadmin-route/src/main/resources/webadmin.properties +++ b/examples/custom-webadmin-route/src/main/resources/webadmin.properties @@ -19,6 +19,10 @@ enabled=true port=8000 host=localhost +# Disable WebAdmin authentication for this local customization demo. +# Password generation defaults to true when no password is explicitly configured. +password.generate=false + # List of fully qualified class names that should be exposed over webadmin # in addition to your product default routes. Routes needs to be located # within the classpath or in the ./extensions-jars folder. diff --git a/third-party/rspamd/README.md b/third-party/rspamd/README.md index 6db4dac7e1..cf898f39e9 100644 --- a/third-party/rspamd/README.md +++ b/third-party/rspamd/README.md @@ -89,8 +89,14 @@ If true `virusProcessor` and `rejectSpamProcessor` are honnered per user, at the - Declare the webadmin for Rspamd in `webadmin.properties` ``` +password.generate=false extensions.routes=org.apache.james.rspamd.route.FeedMessageRoute ``` + +The sample configuration explicitly disables WebAdmin password generation so its local example commands can remain +unauthenticated. Password generation is enabled by default when no `password` is explicitly configured. Do not disable +WebAdmin authentication when exposing it beyond this local customization sample. + How to use admin endpoint, see more at [Additional webadmin endpoints](README.md) - Docker compose file example: [docker-compose.yml](docker-compose.yml) or [docker-compose-distributed.yml](docker-compose-distributed.yml). @@ -204,4 +210,4 @@ The scheduled task will have the following type `FeedHamToRspamdTask` and the fo "timestamp": "2007-12-03T10:15:30Z", "type": "FeedHamToRspamdTask" } -``` \ No newline at end of file +``` diff --git a/third-party/rspamd/sample-configuration/webadmin.properties b/third-party/rspamd/sample-configuration/webadmin.properties index 953fc94dcb..f237fc4dae 100644 --- a/third-party/rspamd/sample-configuration/webadmin.properties +++ b/third-party/rspamd/sample-configuration/webadmin.properties @@ -19,7 +19,11 @@ enabled=true port=8000 host=0.0.0.0 +# Disable WebAdmin authentication for this local customization sample. +# Password generation defaults to true when no password is explicitly configured. +password.generate=false + # List of fully qualified class names that should be exposed over webadmin # in addition to your product default routes. Routes needs to be located # within the classpath or in the ./extensions-jars folder. -extensions.routes=org.apache.james.rspamd.route.FeedMessageRoute \ No newline at end of file +extensions.routes=org.apache.james.rspamd.route.FeedMessageRoute --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
