amorfo77/docker-minecraft-server
1
0
Fork 0
mirror of https://github.com/itzg/docker-minecraft-server.git synced 2026-09-01 19:57:14 +00:00
Code Issues Projects Releases Wiki Activity

Corrected the examples for JVM_OPTS (#3746)

Browse Source
This commit is contained in:
Geoff Bourne
2025-11-05 14:33:45 -06:00
committed by GitHub
parent a8d8bfeef8
commit eeb62d45f9
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/configuration/jvm-options.md
+6 -6
View File
@@ -57,10 +57,10 @@ To let the JVM calculate the heap size from the container declared memory limit,
## Extra JVM Options ## Extra JVM Options
General JVM options can be passed to the Minecraft Server invocation by passing a `JVM_OPTS` General JVM options can be passed to the Minecraft Server invocation by passing a `JVM_OPTS`
environment variable. The JVM requires `-XX` options to precede `-X` options, so those can be declared in `JVM_XX_OPTS`. Both variables are space-delimited, raw JVM arguments. environment variable. If needing to set `-XX` options, then pass those with the `JVM_XX_OPTS` variable instead. Both variables accept space-delimited, raw JVM arguments.
``` ```
docker run ... -e JVM_OPTS="-someJVMOption someJVMOptionValue" ... docker run ... -e JVM_OPTS="-XsomeJVMOption -DpropName=value" ...
``` ```
**NOTE** When declaring `JVM_OPTS` in a compose file's `environment` section with list syntax, **do not** include the quotes: **NOTE** When declaring `JVM_OPTS` in a compose file's `environment` section with list syntax, **do not** include the quotes:
@@ -68,7 +68,7 @@ docker run ... -e JVM_OPTS="-someJVMOption someJVMOptionValue" ...
```yaml ```yaml
environment: environment:
- EULA=true - EULA=true
- JVM_OPTS=-someJVMOption someJVMOptionValue - JVM_OPTS=-XsomeJVMOption -DpropName=value
``` ```
Using object syntax is recommended and more intuitive: Using object syntax is recommended and more intuitive:
@@ -76,9 +76,9 @@ Using object syntax is recommended and more intuitive:
```yaml ```yaml
environment: environment:
EULA: "true" EULA: "true"
JVM_OPTS: "-someJVMOption someJVMOptionValue" JVM_OPTS: "-XsomeJVMOption -DpropName=value"
# or # or without quotes
# JVM_OPTS: -someJVMOption someJVMOptionValue # JVM_OPTS: -XsomeJVMOption -DpropName=value
``` ```
As a shorthand for passing several system properties as `-D` arguments, you can instead pass a comma separated list of `name=value` or `name:value` pairs with `JVM_DD_OPTS`. (The colon syntax is provided for management platforms like Plesk that don't allow `=` inside a value.) As a shorthand for passing several system properties as `-D` arguments, you can instead pass a comma separated list of `name=value` or `name:value` pairs with `JVM_DD_OPTS`. (The colon syntax is provided for management platforms like Plesk that don't allow `=` inside a value.)