[RUN-3585 ] add rundeck windows as service jvm mode#1817
Merged
Conversation
fdevans
approved these changes
Jun 10, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Rundeck Windows installation documentation to provide clearer, tabbed instructions for running Rundeck as a Windows service via Apache Commons Daemon (procrun), adding a new jvm-mode variant intended to capture stdout/stderr logging in-process.
Changes:
- Added a tabbed section to separate “Standard (
javamode)” and “JVM mode (captures logging)” service installation commands. - Documented a
jvm-mode procrun setup including--Classpath,WarLauncher, and required--add-opensoptions for Java 17. - Added a warning/troubleshooting note about
--Jvm/jvm.dllpath and architecture matching.
| @tab Standard (`java` mode) | ||
|
|
||
| ```batch | ||
| rundeck.exe //IS/rundeck ^ |
Comment on lines
+188
to
+189
| --StdOutput=C:\rundeck\service.log ^ | ||
| --StdError=C:\rundeck\service.log ^ |
Comment on lines
+173
to
+174
| --Jvm="%JAVA_HOME%\bin\server\jvm.dll" ^ | ||
| --LibraryPath="%JAVA_HOME%\bin" ^ |
Comment on lines
+194
to
+195
| In `jvm` mode, `--Jvm=auto` often fails with `no JVM configured or found in registry` (many JDK/JRE builds don't register in the Windows registry, and the `LocalSystem` account doesn't see a user-level `JAVA_HOME`). Replace the `--Jvm` and `--LibraryPath` values above with your actual Java installation directory (the same path as `JAVA_HOME`). | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request improves the Windows installation documentation for Rundeck by adding clearer instructions for installing the service using Apache Commons Daemon (procrun) in both
javaandjvmmodes. The update introduces a tabbed section to help users choose the correct mode and provides detailed guidance for thejvmmode, including troubleshooting tips for JVM path issues.Documentation improvements for Windows service installation:
docs/administration/install/windows.mdto separate instructions for standard (javamode) and JVM (jvmmode) service installation, making it easier for users to follow the correct steps.jvmmode, which captures logging directly and requires specific JVM configuration.--Jvmpath and ensuring the architecture ofprunsrv.exeandjvm.dllmatch, addressing common setup pitfalls for users.