Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOCS-7505] Update tomcat.md -JAVA_TOOL_OPTIONS #1174

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[DOCS-7505] Update tomcat.md -JAVA_TOOL_OPTIONS #1174

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion content-services/latest/install/zip/tomcat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,8 @@ The new keystore configuration implementation requires it to be configured with
2. Add the following line to `catalina.bat`:

```bash
set “JAVA_TOOL_OPTIONS=-Dencryption.keystore.type=JCEKS -Dencryption.cipherAlgorithm=DESede/CBC/PKCS5Padding -Dencryption.keyAlgorithm=DESede -Dencryption.keystore.location=<TOMCAT_HOME>/alf_data/keystore/metadata-keystore/keystore -Dmetadata-keystore.password=mp6yc0UD9e -Dmetadata-keystore.aliases=metadata -Dmetadata-keystore.metadata.password=oKIWzVdEdA -Dmetadata-keystore.metadata.algorithm=DESede”
set "JAVA_OPTS=%JAVA_OPTS% -Dencryption.keystore.type=JCEKS -Dencryption.cipherAlgorithm=DESede/CBC/PKCS5Padding -Dencryption.keyAlgorithm=DESede -Dencryption.keystore.location=<TOMCAT_HOME>/alf_data/keystore/metadata-keystore/keystore -Dmetadata-keystore.password=mp6yc0UD9e -Dmetadata-keystore.aliases=metadata -Dmetadata-keystore.metadata.password=oKIWzVdEdA -Dmetadata-keystore.metadata.algorithm=DESede"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking at the latest docker-compose from the acs-deployment repository, we still recommend using JAVA_TOOL_OPTIONS to load these specific properties.

Ref: https://github.com/Alfresco/acs-deployment/blob/master/docker-compose/docker-compose.yml#L21-L32

What's the rationale behind changing them here?

cc: @gionn @pzhyland

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JAVA_TOOL_OPTIONS is not used when starting Tomcat

it should as it's a jvm feature, the issue may lie elsewhere

Copy link
Contributor Author

@MattioliLeo MattioliLeo Sep 23, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm referring to manual zip installation documentation.
When using Windows, in the catalina.bat distributed with Tomcat 9/10, the JAVA_TOOL_OPTIONS is not used when launching the executable.
(checked file apache-tomcat-9.0.95-windows-x64.zip and apache-tomcat-10.1.30-windows-x64.zip available for public download on Tomcat site)

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As Giovanni mentioned. The JAVA_TOOL_OPTIONS is a JVM feature. It shouldn't be used by any launcher script. The JVM picks it up if it's set. See https://docs.oracle.com/en/java/javase/17/troubleshoot/environment-variables-and-system-properties.html It mentions that the JAVA_TOOL_OPTIONS might be disabled for a security reasons so maybe this is a case for your env.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Windows customers usually use the OpenJDK distributed by Microsoft, not by Oracle.
I don't know if it's Windows Server 2016 or 2019 (tested both) that restricts the env variable or the Microsoft OpenJDK that doesn't use it, in any case following the documentation I got the error "Keystore are invalid".
As I don't keep test VM for 1 years, I should try to recreate the issue. I think I will have some time mid-October. I will put on my calendar and involve some of you in the debug session. Ok?


```

Make sure to replace `<TOMCAT_HOME>` with your Tomcat installation directory.
Expand Down