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

docs: document JMX_PORT (#2489)

Browse Source
This commit is contained in:
Geoff Bourne
2023-11-12 21:31:42 -06:00
committed by GitHub
parent 4c0bd61faf
commit e8ffa0fc0d
1 changed files with 23 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/configuration/jvm-options.md
+20 -1
View File
@@ -62,12 +62,31 @@ you can use
## Enable Remote JMX for Profiling ## Enable Remote JMX for Profiling
To enable remote JMX, such as for profiling with VisualVM or JMC, add the environment variable `ENABLE_JMX=true`, set `JMX_HOST` to the IP/host running the Docker container, and add a port forwarding of TCP port 7091, such as: To enable remote JMX, such as for profiling with VisualVM or JMC, set the environment variable `ENABLE_JMX` to "true", set `JMX_HOST` to the IP/host running the Docker container, and add a port forwarding of TCP port 7091, such as:
!!! example
With `docker run`
``` ```
-e ENABLE_JMX=true -e JMX_HOST=$HOSTNAME -p 7091:7091 -e ENABLE_JMX=true -e JMX_HOST=$HOSTNAME -p 7091:7091
``` ```
If needing to map to a different port, then also set the environment variable `JMX_PORT` to the desired host port.
!!! example
With a compose file:
```yaml
environment:
ENABLE_JMX: true
JMX_HOST: ${HOSTNAME}
JMX_PORT: "7092"
ports:
- "7092:7092"
```
## Enable Aikar's Flags ## Enable Aikar's Flags
[Aikar has done some research](https://aikar.co/2018/07/02/tuning-the-jvm-g1gc-garbage-collector-flags-for-minecraft/) into finding the optimal JVM flags for GC tuning, which becomes more important as more users are connected concurrently. [PaperMC also has an explanation](https://docs.papermc.io/paper/aikars-flags) of what the JVM flags are doing. [Aikar has done some research](https://aikar.co/2018/07/02/tuning-the-jvm-g1gc-garbage-collector-flags-for-minecraft/) into finding the optimal JVM flags for GC tuning, which becomes more important as more users are connected concurrently. [PaperMC also has an explanation](https://docs.papermc.io/paper/aikars-flags) of what the JVM flags are doing.