From 619cee5ae5d579e10bb517eee18fc2b3db08861c Mon Sep 17 00:00:00 2001 From: Geoff Bourne Date: Sun, 21 Jan 2024 12:21:40 -0600 Subject: [PATCH] docs: clarify that disabling RCON disables other features (#2607) --- docs/configuration/server-properties.md | 8 ++++++-- docs/variables.md | 2 +- examples/jline/docker-compose.yml | 14 ++++++++++++++ 3 files changed, 21 insertions(+), 3 deletions(-) create mode 100644 examples/jline/docker-compose.yml diff --git a/docs/configuration/server-properties.md b/docs/configuration/server-properties.md index 1ca61c50..b7d680cc 100644 --- a/docs/configuration/server-properties.md +++ b/docs/configuration/server-properties.md @@ -187,9 +187,13 @@ The server icon which has been set doesn't get overridden by default. It can be RCON is **enabled by default** to allow for graceful shut down the server and coordination of save state during backups. RCON can be disabled by setting `ENABLE_RCON` to "false". -The default password is randomly generated if `RCON_PASSWORD` has not been set. +!!! warning -**DO NOT MAP THE RCON PORT EXTERNALLY** unless you aware of all the consequences and have set a **secure password** with `RCON_PASSWORD`. + Disabling RCON will remove and limit some features, such as interactive and color console support. + +The default password is randomly generated on each startup; however, a specific one can be set with `RCON_PASSWORD`. + +**DO NOT MAP THE RCON PORT EXTERNALLY** unless you are aware of all the consequences and have set a **secure password** with `RCON_PASSWORD`. !!! info diff --git a/docs/variables.md b/docs/variables.md index c5e5492a..60cb8014 100644 --- a/docs/variables.md +++ b/docs/variables.md @@ -540,7 +540,7 @@ alternatively, you can mount: /etc/localtime:/etc/localtime:ro ENABLE_RCON - Should RCON be enabled + Enable/disable RCON support; however, be aware that disabling RCON will remove and limit some features, such as interactive and color console support. true ⬜️ diff --git a/examples/jline/docker-compose.yml b/examples/jline/docker-compose.yml new file mode 100644 index 00000000..f14729e9 --- /dev/null +++ b/examples/jline/docker-compose.yml @@ -0,0 +1,14 @@ +services: + mc: + image: itzg/minecraft-server + tty: true + stdin_open: true + environment: + EULA: true + TYPE: FABRIC + MODRINTH_PROJECTS: | + jline4mcdsrv + volumes: + - mc-data:/data +volumes: + mc-data: {} \ No newline at end of file