rcon-cli upgraded to support command history (#3354)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.github/ISSUE_TEMPLATE/bug.yml

@@ -11,9 +11,9 @@ body:
         
         Please double check some things first:
         1. Do you just have a question about something? If so, asking in the [Q&A Discussions](https://github.com/itzg/docker-minecraft-server/discussions/categories/q-a) or asking on [the Discord server](https://discord.gg/DXfKpjB) would be best.
-        2. Did you re-pull the newest image using `docker pull`? 
-        3. Is this bug happening after the `[init]` prefixed logs and after the log that says "Starting the Minecraft server"? If so, please report the bug with Mojang or the respective server provider.
-        4. Are you seeing a performance problem? If so, that is typically outside the scope of the image setup mechanims. Ask a question as above or contact the respective server provider.
+        2. Did you **re-pull the newest image** and confirmed the issue after that? Run `docker pull <image>` or if using a compose file, it's as easy as running `docker compose pull`. If using Kubernetes, add `imagePullPolicy: Always` to the container. 
+        4. Is this bug happening after the `[init]` prefixed logs and after the log that says "Starting the Minecraft server"? If so, please report the bug with Mojang or the respective server provider.
+        5. Are you seeing a performance problem? If so, that is typically outside the scope of this image. Ask a question as above or contact the respective server provider.
   - type: textarea
     id: problem
     attributes:

.github/workflows/build-multiarch.yml

@@ -10,6 +10,8 @@ on:
       - "*.md"
       - "docs/**"
       - "examples/**"
+      - "notes/**"
+      - "kustomize/**"
 
 jobs:
   build:
@@ -18,84 +20,75 @@ jobs:
       matrix:
         # NOTE: the "latest" variant is identified in the Docker meta step's 'latest' config
         variant:
-          - java21-graalvm
+          - java23
+          - java23-graalvm
           - java21
           - java21-alpine
+          - java21-graalvm
+          - java21-jdk
           - java17
           - java17-graalvm
-          - java17-jdk
-          - java17-openj9
           - java17-alpine
           - java8
           - java8-graalvm-ce
-          - java8-multiarch
           - java8-openj9
           - java8-jdk
           - java11
-          - java11-openj9
-          - java11-jdk
         include:
+        # JAVA 23
+          - variant: java23
+            baseImage: eclipse-temurin:23-jre
+            platforms: linux/amd64,linux/arm64
+            mcVersion: latest
+          - variant: java23-graalvm
+            baseImage: container-registry.oracle.com/graalvm/jdk:23-ol8
+            platforms: linux/amd64,linux/arm64
+            mcVersion: latest
         # JAVA 21:
           - variant: java21-graalvm
             baseImage: container-registry.oracle.com/graalvm/jdk:21-ol8
             platforms: linux/amd64,linux/arm64
-            mcVersion: 1.20.2
+            mcVersion: latest
           - variant: java21
             baseImage: eclipse-temurin:21-jre
             platforms: linux/amd64,linux/arm64
-            mcVersion: 1.19.3
+            mcVersion: latest
+          - variant: java21-jdk
+            baseImage: eclipse-temurin:21
+            platforms: linux/amd64,linux/arm64
+            mcVersion: latest
           - variant: java21-alpine
             baseImage: eclipse-temurin:21-jre-alpine
-            platforms: linux/amd64
-            mcVersion: 1.19.3
+            platforms: linux/amd64,linux/arm64
+            mcVersion: latest
         # JAVA 17:
           - variant: java17
             # jammy doesn't work until minecraft updates to https://github.com/netty/netty/issues/12343
             baseImage: eclipse-temurin:17-jre-focal
             platforms: linux/amd64,linux/arm/v7,linux/arm64
-            mcVersion: 1.18.2
+            mcVersion: 1.20.4
           - variant: java17-graalvm
             baseImage: container-registry.oracle.com/graalvm/jdk:17-ol8
             platforms: linux/amd64,linux/arm64
-            mcVersion: 1.18.2
-          - variant: java17-jdk
-            baseImage: eclipse-temurin:17-focal
-            platforms: linux/amd64,linux/arm/v7,linux/arm64
-            mcVersion: 1.18.2
-          - variant: java17-openj9
-            baseImage: ibm-semeru-runtimes:open-17-jre
-            platforms: linux/amd64,linux/arm64
-            mcVersion: 1.18.2
+            mcVersion: 1.20.4
           - variant: java17-alpine
             baseImage: eclipse-temurin:17-jre-alpine
             platforms: linux/amd64
-            mcVersion: 1.18.2
+            mcVersion: 1.20.4
         # JAVA 11:
           - variant: java11
             baseImage: adoptopenjdk:11-jre-hotspot
             platforms: linux/amd64,linux/arm/v7,linux/arm64
             mcVersion: 1.16.5
-          - variant: java11-jdk
-            baseImage: adoptopenjdk:11-jdk-hotspot
-            platforms: linux/amd64,linux/arm/v7,linux/arm64
-            mcVersion: 1.16.5
-          - variant: java11-openj9
-            baseImage: ibm-semeru-runtimes:open-11-jre
-            platforms: linux/amd64,linux/arm64
-            mcVersion: 1.16.5
         # JAVA 8: NOTE: Unable to go past 8u312 because of Forge dependencies
           - variant: java8
-            baseImage: openjdk:8-jre-alpine3.9
-            platforms: linux/amd64
+            baseImage: eclipse-temurin:8u312-b07-jre-focal
+            platforms: linux/amd64,linux/arm/v7,linux/arm64
             mcVersion: 1.12.2
           - variant: java8-graalvm-ce
             baseImage: ghcr.io/graalvm/graalvm-ce:java8
             platforms: linux/amd64
             mcVersion: 1.12.2
-          - variant: java8-multiarch
-            baseImage: eclipse-temurin:8u312-b07-jre-focal
-            platforms: linux/amd64,linux/arm/v7,linux/arm64
-            mcVersion: 1.12.2
           - variant: java8-jdk
             baseImage: eclipse-temurin:8u312-b07-jdk-focal
             platforms: linux/amd64,linux/arm64
@@ -105,20 +98,20 @@ jobs:
             platforms: linux/amd64,linux/arm64
             mcVersion: 1.12.2
     env:
-      IMAGE_TO_TEST: ${{ github.repository_owner }}/minecraft-server:test-${{ matrix.variant }}-${{ github.run_id }}
+      IMAGE_TO_TEST: "${{ github.repository_owner }}/minecraft-server:test-${{ matrix.variant }}-${{ github.run_id }}"
       HAS_IMAGE_REPO_ACCESS: ${{ secrets.DOCKER_USER != '' && secrets.DOCKER_PASSWORD != '' }}
-      MAIN_VARIANT: java17
-    runs-on: ubuntu-20.04
+      MAIN_VARIANT: java21
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v4.1.1
+        uses: actions/checkout@v4.2.2
         with:
           # for build-files step
           fetch-depth: 0
 
       - name: Docker meta
         id: meta
-        uses: docker/metadata-action@v5.5.0
+        uses: docker/metadata-action@v5.6.1
         with:
           # NOTE for forks: if your Docker Hub organization doesn't match your Github repo's,
           # then the use of ${{ github.repository_owner }} will need to be replaced.
@@ -136,6 +129,8 @@ jobs:
             type=raw,value=stable,enable=${{ github.ref_type == 'tag' && matrix.variant == env.MAIN_VARIANT }}            
             # apply the variant as a moving tag for most recent commit per variant
             type=raw,value=${{ matrix.variant }},enable=${{ github.ref_name == github.event.repository.default_branch }}
+            # for backward compatibility with users referencing java8-multiarch, this will set an extra label on java8
+            type=raw,value=java8-multiarch,enable=${{ matrix.variant == 'java8' && github.ref_name == github.event.repository.default_branch }}
           # NOTE this identifies which variant will be published as "latest", which isn't
           # necessarily the newest version of Java
           flavor: |
@@ -144,13 +139,13 @@ jobs:
             org.opencontainers.image.authors=Geoff Bourne <itzgeoff@gmail.com>
 
       - name: Setup Docker Buildx
-        uses: docker/setup-buildx-action@v3.0.0
+        uses: docker/setup-buildx-action@v3.9.0
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3.0.0
+        uses: docker/setup-qemu-action@v3.4.0
 
       - name: Build for test
-        uses: docker/build-push-action@v5.1.0
+        uses: docker/build-push-action@v6.14.0
         with:
           platforms: linux/amd64
           tags: ${{ env.IMAGE_TO_TEST }}
@@ -173,14 +168,14 @@ jobs:
           tests/test.sh
 
       - name: Login to DockerHub
-        uses: docker/login-action@v3.0.0
+        uses: docker/login-action@v3.3.0
         if: env.HAS_IMAGE_REPO_ACCESS
         with:
           username: ${{ secrets.DOCKER_USER }}
           password: ${{ secrets.DOCKER_PASSWORD }}
 
       - name: Login to GHCR
-        uses: docker/login-action@v3.0.0
+        uses: docker/login-action@v3.3.0
         if: env.HAS_IMAGE_REPO_ACCESS
         with:
           registry: ghcr.io
@@ -188,7 +183,7 @@ jobs:
           password: ${{ github.token }}
 
       - name: Build and push
-        uses: docker/build-push-action@v5.1.0
+        uses: docker/build-push-action@v6.14.0
         if: github.actor == github.repository_owner
         with:
           platforms: ${{ matrix.platforms }}

.github/workflows/discord.yml

@@ -19,7 +19,7 @@ jobs:
     steps:
       - name: on-publish
         if: github.event_name == 'release' && github.event.action == 'published'
-        uses: SethCohen/github-releases-to-discord@v1.15.0
+        uses: SethCohen/github-releases-to-discord@v1.16.2
         with:
           webhook_url: ${{ secrets.DISCORD_WEBHOOK }}
       - name: on-success

.github/workflows/stale-check.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   check:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     permissions:
       issues: write
       pull-requests: write

.github/workflows/verify-pr.yml

@@ -7,6 +7,8 @@ on:
       - "*.md"
       - "docs/**"
       - "examples/**"
+      - "notes/**"
+      - "kustomize/**"
       - "docker-compose*.yml"
       - "mkdocs.yml"
 
@@ -17,44 +19,44 @@ jobs:
       matrix:
         variant:
           - java21
+          - java21-alpine
           - java17
-          - java17-alpine
-          - java8-multiarch
+          - java8
         include:
         # JAVA 21:
           - variant: java21
             baseImage: eclipse-temurin:21-jre
             platforms: linux/amd64,linux/arm64
-            mcVersion: 1.19.4
+            mcVersion: latest
+          - variant: java21-alpine
+            baseImage: eclipse-temurin:21-jre-alpine
+            platforms: linux/amd64,linux/arm64
+            mcVersion: latest
         # JAVA 17:
           - variant: java17
             # jammy doesn't work until minecraft updates to https://github.com/netty/netty/issues/12343
             baseImage: eclipse-temurin:17-jre-focal
             platforms: linux/amd64
-            mcVersion: 1.19.4
-          - variant: java17-alpine
-            baseImage: eclipse-temurin:17-jre-alpine
-            platforms: linux/amd64
-            mcVersion: 1.19.4
-          - variant: java8-multiarch
+            mcVersion: 1.20.4
+          - variant: java8
             baseImage: eclipse-temurin:8u312-b07-jre-focal
             platforms: linux/amd64
             mcVersion: 1.12.2
     env:
       IMAGE_TO_TEST: ${{ github.repository_owner }}/minecraft-server:test-${{ matrix.variant }}-${{ github.run_id }}
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v4.1.1
+        uses: actions/checkout@v4.2.2
         with:
           # for build-files step
           fetch-depth: 0
 
       - name: Setup Docker Buildx
-        uses: docker/setup-buildx-action@v3.0.0
+        uses: docker/setup-buildx-action@v3.9.0
 
       - name: Confirm multi-arch build
-        uses: docker/build-push-action@v5.1.0
+        uses: docker/build-push-action@v6.14.0
         with:
           platforms: ${{ matrix.platforms }}
           # ensure latest base image is used
@@ -64,7 +66,7 @@ jobs:
           cache-from: type=gha,scope=${{ matrix.variant }}
 
       - name: Build for test
-        uses: docker/build-push-action@v5.1.0
+        uses: docker/build-push-action@v6.14.0
         with:
           # Only build single platform since loading multi-arch image into daemon fails with
           # "docker exporter does not currently support exporting manifest lists"

.readthedocs.yaml

@@ -1,5 +1,4 @@
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
 version: 2
 
 build:

Dockerfile

@@ -1,6 +1,4 @@
-# syntax = docker/dockerfile:1.3
-
-ARG BASE_IMAGE=eclipse-temurin:17-jre-focal
+ARG BASE_IMAGE=eclipse-temurin:21-jre
 FROM ${BASE_IMAGE}
 
 # hook into docker BuildKit --platform support
@@ -9,14 +7,17 @@ ARG TARGETOS
 ARG TARGETARCH
 ARG TARGETVARIANT
 
-# CI system should set this to a hash or git revision of the build directory and it's contents to
-# ensure consistent cache updates.
-ARG BUILD_FILES_REV=1
+# The following three arg/env vars get used by the platform specific "install-packages" script
+ARG EXTRA_DEB_PACKAGES=""
+ARG EXTRA_DNF_PACKAGES=""
+ARG EXTRA_ALPINE_PACKAGES=""
+ARG FORCE_INSTALL_PACKAGES=1
 RUN --mount=target=/build,source=build \
-    REV=${BUILD_FILES_REV} TARGET=${TARGETARCH}${TARGETVARIANT} /build/run.sh install-packages
+    TARGET=${TARGETARCH}${TARGETVARIANT} \
+    /build/run.sh install-packages
 
 RUN --mount=target=/build,source=build \
-    REV=${BUILD_FILES_REV} /build/run.sh setup-user
+    /build/run.sh setup-user
 
 COPY --chmod=644 files/sudoers* /etc/sudoers.d
 
@@ -25,31 +26,31 @@ EXPOSE 25565
 ARG APPS_REV=1
 ARG GITHUB_BASEURL=https://github.com
 
-ARG EASY_ADD_VERSION=0.8.2
+ARG EASY_ADD_VERSION=0.8.9
 ADD ${GITHUB_BASEURL}/itzg/easy-add/releases/download/${EASY_ADD_VERSION}/easy-add_${TARGETOS}_${TARGETARCH}${TARGETVARIANT} /usr/bin/easy-add
 RUN chmod +x /usr/bin/easy-add
 
-ARG RESTIFY_VERSION=1.7.1
+ARG RESTIFY_VERSION=1.7.7
 RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
   --var version=${RESTIFY_VERSION} --var app=restify --file {{.app}} \
   --from ${GITHUB_BASEURL}/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
-ARG RCON_CLI_VERSION=1.6.4
+ARG RCON_CLI_VERSION=1.7.0
 RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
   --var version=${RCON_CLI_VERSION} --var app=rcon-cli --file {{.app}} \
   --from ${GITHUB_BASEURL}/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
-ARG MC_MONITOR_VERSION=0.12.6
+ARG MC_MONITOR_VERSION=0.15.3
 RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
   --var version=${MC_MONITOR_VERSION} --var app=mc-monitor --file {{.app}} \
   --from ${GITHUB_BASEURL}/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
-ARG MC_SERVER_RUNNER_VERSION=1.11.0
+ARG MC_SERVER_RUNNER_VERSION=1.12.6
 RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
   --var version=${MC_SERVER_RUNNER_VERSION} --var app=mc-server-runner --file {{.app}} \
   --from ${GITHUB_BASEURL}/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
-ARG MC_HELPER_VERSION=1.37.9
+ARG MC_HELPER_VERSION=1.41.2
 ARG MC_HELPER_BASE_URL=${GITHUB_BASEURL}/itzg/mc-image-helper/releases/download/${MC_HELPER_VERSION}
 # used for cache busting local copy of mc-image-helper
 ARG MC_HELPER_REV=1
@@ -63,7 +64,7 @@ WORKDIR /data
 STOPSIGNAL SIGTERM
 
 # End user MUST set EULA and change RCON_PASSWORD
-ENV TYPE=VANILLA VERSION=LATEST EULA="" UID=1000 GID=1000
+ENV TYPE=VANILLA VERSION=LATEST EULA="" UID=1000 GID=1000 LC_ALL=en_US.UTF-8
 
 COPY --chmod=755 scripts/start* /
 COPY --chmod=755 bin/ /usr/local/bin/
@@ -76,4 +77,4 @@ RUN curl -fsSL -o /image/Log4jPatcher.jar https://github.com/CreeperHost/Log4jPa
 RUN dos2unix /start* /auto/*
 
 ENTRYPOINT [ "/start" ]
-HEALTHCHECK --start-period=1m --interval=5s --retries=24 CMD mc-health
+HEALTHCHECK --start-period=2m --retries=2 --interval=30s CMD mc-health

bin/mc-health

@@ -13,6 +13,6 @@ elif isTrue "${ENABLE_AUTOPAUSE}" && [[ "$( ps -ax -o stat,comm | grep 'java' |
   echo "Java process suspended by Autopause function"
   exit 0
 else
-  mc-monitor status "${MC_HEALTH_EXTRA_ARGS[@]}" --host localhost --port "${SERVER_PORT:-25565}"
+  mc-monitor status "${MC_HEALTH_EXTRA_ARGS[@]}" --host "${SERVER_HOST:-localhost}" --port "${SERVER_PORT:-25565}"
   exit $?
 fi

bin/mc-send-to-console

@@ -3,26 +3,22 @@
 : "${CONSOLE_IN_NAMED_PIPE:=/tmp/minecraft-console-in}"
 
 if isFalse "${CREATE_CONSOLE_IN_PIPE:-false}"; then
-  echo "ERROR: console pipe needs to be enabled by setting CREATE_CONSOLE_IN_PIPE to true"
+  error "Console pipe needs to be enabled by setting CREATE_CONSOLE_IN_PIPE to true"
 fi
 
 
 if [ $# = 0 ]; then
-  echo "ERROR: pass console commands as arguments"
+  error "Pass console commands as arguments"
   exit 1
 fi
 
 if [ ! -p "${CONSOLE_IN_NAMED_PIPE}" ]; then
-  echo "ERROR: named pipe ${CONSOLE_IN_NAMED_PIPE} is missing"
+  error "Named pipe ${CONSOLE_IN_NAMED_PIPE} is missing"
   exit 1
 fi
 
-if [ "$(id -u)" = 0 ]; then
-  if [[ $(getDistro) == alpine ]]; then
-    exec su-exec minecraft bash -c "echo '$*' > '${CONSOLE_IN_NAMED_PIPE:-/tmp/minecraft-console-in}'"
-  else
-    exec gosu minecraft bash -c "echo '$*' > '${CONSOLE_IN_NAMED_PIPE:-/tmp/minecraft-console-in}'"
-  fi
+if [ "$(id -u)" = 0 -a $UID != 0 ]; then
+  exec $(getSudoFromDistro) minecraft bash -c "echo '$*' > '${CONSOLE_IN_NAMED_PIPE}'"
 else
-  echo "$@" >"${CONSOLE_IN_NAMED_PIPE:-/tmp/minecraft-console-in}"
+  echo "$@" >"${CONSOLE_IN_NAMED_PIPE}"
 fi

bin/mcstatus

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-echo "WARNING: mcstatus is deprecated; calling mc-monitor instead"
+warning "mcstatus is deprecated; calling mc-monitor instead"
 
 ##### mcstatus shim for mc-monitor
 # handles translating calls to
@@ -11,8 +11,8 @@ addr="$1"
 
 IFS=':'
 read -a parts <<< "${addr}"
+args=(--host ${parts[0]}) 
 if [[ ${#parts[*]} -gt 1 ]]; then
-  exec mc-monitor status --host ${parts[0]} --port ${parts[1]}
-else
-  exec mc-monitor status --host ${parts[0]}
+    args+=(--port ${parts[1]})
 fi
+exec mc-monitor ${args[@]}

bin/rcon-cmds-daemon.sh

@@ -44,7 +44,7 @@ do
       if [[ "$RCON_CMDS_STARTUP" ]]; then
         while read -r cmd; do
           run_command "$cmd"
-        done <<< "$RCON_CMDS_STARTUP"
+        done <<< "$(echo -e "$RCON_CMDS_STARTUP")"
       fi
       if 
         [[ -z "$RCON_CMDS_ON_CONNECT" ]] && 
@@ -66,7 +66,7 @@ do
         logRcon "First Clients has Connected, running first connect cmds"
         while read -r cmd; do
           run_command "$cmd"
-        done <<< "$RCON_CMDS_FIRST_CONNECT"
+        done <<< "$(echo -e "$RCON_CMDS_FIRST_CONNECT")"
     fi
 
     # When a client joins
@@ -74,13 +74,13 @@ do
         logRcon "Clients have Connected, running connect cmds"
         while read -r cmd; do
           run_command "$cmd"
-        done <<< "$RCON_CMDS_ON_CONNECT"
+        done <<< "$(echo -e "$RCON_CMDS_ON_CONNECT")"
     # When a client leaves
     elif (( CURR_CLIENTCONNECTIONS < CLIENTCONNECTIONS )) && [[ "$RCON_CMDS_ON_DISCONNECT" ]]; then
         logRcon "Clients have Disconnected, running disconnect cmds"
         while read -r cmd; do
           run_command "$cmd"
-        done <<< "$RCON_CMDS_ON_DISCONNECT"
+        done <<< "$(echo -e "$RCON_CMDS_ON_DISCONNECT")"
     fi
 
     # Last client connection
@@ -89,7 +89,7 @@ do
         logRcon "ALL Clients have Disconnected, running last disconnect cmds"
         while read -r cmd; do
           run_command "$cmd"
-        done <<< "$RCON_CMDS_LAST_DISCONNECT"
+        done <<< "$(echo -e "$RCON_CMDS_LAST_DISCONNECT")"
     fi
     CLIENTCONNECTIONS=$CURR_CLIENTCONNECTIONS
     ;;

build/alpine/install-packages.sh

@@ -3,6 +3,8 @@
 set -e
 set -o pipefail
 
+# Install necessary packages
+# shellcheck disable=SC2086
 apk add --no-cache -U \
     openssl \
     imagemagick \
@@ -14,21 +16,33 @@ apk add --no-cache -U \
     procps \
     shadow \
     bash \
-    curl iputils \
+    curl \
+    iputils \
     git \
     jq \
     mysql-client \
     tzdata \
     rsync \
     nano \
+    ncurses \
     sudo \
     tar \
     zstd \
     nfs-utils \
     libpcap \
-    libwebp
+    libwebp \
+    libcap \
+    ${EXTRA_ALPINE_PACKAGES}
 
-# Patched knockd
+# Download and install patched knockd
 curl -fsSL -o /tmp/knock.tar.gz https://github.com/Metalcape/knock/releases/download/0.8.1/knock-0.8.1-alpine-amd64.tar.gz
 tar -xf /tmp/knock.tar.gz -C /usr/local/ && rm /tmp/knock.tar.gz
 ln -s /usr/local/sbin/knockd /usr/sbin/knockd
+setcap cap_net_raw=ep /usr/local/sbin/knockd
+
+# Set Git credentials globally
+cat <<EOF >> /etc/gitconfig
+[user]
+	name = Minecraft Server on Docker
+	email = server@example.com
+EOF

build/ol/install-gosu.sh

@@ -1,12 +1,22 @@
 #!/bin/bash
 
-if [[ $(uname -m) == "aarch64" ]]; then 
-    curl -sL -o /bin/gosu https://github.com/tianon/gosu/releases/download/1.16/gosu-arm64
-    chmod +x /bin/gosu
-elif [[ $(uname -m) == "x86_64" ]]; then 
-    curl -sL -o /bin/gosu https://github.com/tianon/gosu/releases/download/1.16/gosu-amd64
-    chmod +x /bin/gosu
-else
-    echo "Not supported!"
-    exit 1
-fi  
+set -euo pipefail
+
+GOSU_VERSION="1.16"
+GOSU_BASE_URL="https://github.com/tianon/gosu/releases/download/$GOSU_VERSION"
+
+case $(uname -m) in
+    "aarch64")
+        GOSU_ARCH="gosu-arm64"
+        ;;
+    "x86_64")
+        GOSU_ARCH="gosu-amd64"
+        ;;
+    *)
+        echo "Architecture not supported!"
+        exit 1
+        ;;
+esac
+
+curl -sL -o /bin/gosu "${GOSU_BASE_URL}/${GOSU_ARCH}"
+chmod +x /bin/gosu

build/ol/install-packages.sh

@@ -4,21 +4,28 @@ export TARGET
 
 set -euo pipefail
 
+# Install and configure dnf
 microdnf install dnf -y
-
 dnf install 'dnf-command(config-manager)' -y
 dnf config-manager --set-enabled ol8_codeready_builder
-tee /etc/yum.repos.d/ol8-epel.repo<<EOF
+
+# Add EPEL repository
+tee /etc/yum.repos.d/ol8-epel.repo <<EOF
 [ol8_developer_EPEL]
-name= Oracle Linux \$releasever EPEL (\$basearch)
+name=Oracle Linux \$releasever EPEL (\$basearch)
 baseurl=https://yum.oracle.com/repo/OracleLinux/OL8/developer/EPEL/\$basearch/
 gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-oracle
 gpgcheck=1
 enabled=1
 EOF
+
+# Update system
 dnf update -y
 
-dnf install -y ImageMagick \
+# Install necessary packages
+# shellcheck disable=SC2086
+dnf install -y \
+  ImageMagick \
   file \
   sudo \
   net-tools \
@@ -38,11 +45,30 @@ dnf install -y ImageMagick \
   libpcap \
   libwebp \
   findutils \
-  which
+  which \
+  glibc-langpack-en \
+  ${EXTRA_DNF_PACKAGES}
 
+# Install Git LFS
+curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.rpm.sh | sudo bash
+dnf update -y
+dnf install -y git-lfs
+
+# Clean up DNF when done
+dnf clean all
+
+# Install gosu (assuming the script /build/ol/install-gosu.sh exists and is executable)
 bash /build/ol/install-gosu.sh
 
-# Patched knockd
+# Download and install patched knockd
 curl -fsSL -o /tmp/knock.tar.gz https://github.com/Metalcape/knock/releases/download/0.8.1/knock-0.8.1-$TARGET.tar.gz
 tar -xf /tmp/knock.tar.gz -C /usr/local/ && rm /tmp/knock.tar.gz
 ln -s /usr/local/sbin/knockd /usr/sbin/knockd
+setcap cap_net_raw=ep /usr/local/sbin/knockd
+
+# Set git credentials globally
+cat <<EOF >> /etc/gitconfig
+[user]
+	name = Minecraft Server on Docker
+	email = server@example.com
+EOF

build/ubuntu/install-packages.sh

@@ -4,8 +4,9 @@ export TARGET
 
 set -euo pipefail
 
+# Update and install packages
 apt-get update
-
+# shellcheck disable=SC2086
 DEBIAN_FRONTEND=noninteractive \
 apt-get install -y \
   imagemagick \
@@ -27,12 +28,26 @@ apt-get install -y \
   lbzip2 \
   nfs-common \
   libpcap0.8 \
-  webp
+  ${EXTRA_DEB_PACKAGES}
 
+# Install Git LFS
+curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh | sudo bash
+apt-get update
+apt-get install -y git-lfs
+
+# Clean up APT when done
 apt-get clean
 
-# Patched knockd
+# Download and install patched knockd
 curl -fsSL -o /tmp/knock.tar.gz https://github.com/Metalcape/knock/releases/download/0.8.1/knock-0.8.1-$TARGET.tar.gz
 tar -xf /tmp/knock.tar.gz -C /usr/local/ && rm /tmp/knock.tar.gz
 ln -s /usr/local/sbin/knockd /usr/sbin/knockd
+setcap cap_net_raw=ep /usr/local/sbin/knockd
 find /usr/lib -name 'libpcap.so.0.8' -execdir cp '{}' libpcap.so.1 \;
+
+# Set git credentials globally
+cat <<EOF >> /etc/gitconfig
+[user]
+	name = Minecraft Server on Docker
+	email = server@example.com
+EOF

build/ubuntu/setup-user.sh

@@ -2,5 +2,9 @@
 
 set -e
 
+if id ubuntu > /dev/null 2>&1; then
+  deluser ubuntu
+fi
+
 addgroup --gid 1000 minecraft
 adduser --system --shell /bin/false --uid 1000 --ingroup minecraft --home /data minecraft

docker-compose-mkdocs.yml

@@ -4,8 +4,6 @@
 #
 # and then access http://localhost:8000
 
-version: "3.8"
-
 services:
   mkdocs:
     build:

docker-compose.yml

@@ -1,5 +1,3 @@
-version: "3.8"
-
 services:
   mc:
     image: itzg/minecraft-server

docs/Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.8
+FROM python:3.9
 
 RUN pip install --upgrade pip
 

docs/commands.md

@@ -19,7 +19,9 @@ docker exec mc rcon-cli stop
 
 _The `-i` is not needed in this case._
 
-If rcon is disabled you can send commands by passing them as arguments to the packaged `mc-send-to-console` script. For example, a player can be op'ed in the container `mc` with: 
+## When RCON is disabled
+
+If rcon is disabled you can send commands by passing them as arguments to the packaged `mc-send-to-console` script after setting the env var `CREATE_CONSOLE_IN_PIPE` to "true". For example, a player can be op'ed in the container `mc` with: 
 
 ```shell
 docker exec mc mc-send-to-console op player
@@ -27,9 +29,26 @@ docker exec mc mc-send-to-console op player
             +- container name     +- Minecraft commands start here
 ```
 
-In order to attach and interact with the Minecraft server, add `-it` when starting the container, such as
+## Enabling interactive console
 
+In order to attach and interact with the Minecraft server make sure to enable TTY and keep stdin open.
+
+!!! example
+
+    With `docker run` use the `-it` arguments:
+
+    ```shell
     docker run -d -it -p 25565:25565 --name mc itzg/minecraft-server
+    ```
+
+    or with a compose file:
+
+    ```yaml
+    services:
+      minecraft:
+        stdin_open: true
+        tty: true
+    ```
 
 With that you can attach and interact at any time using
 
@@ -37,9 +56,6 @@ With that you can attach and interact at any time using
 
 and then Control-p Control-q to **detach**.
 
-For remote access, configure your Docker daemon to use a `tcp` socket (such as `-H tcp://0.0.0.0:2375`)
-and attach from another machine:
+!!! info "RCON is required for fully interactive, color console"
 
-    docker -H $HOST:2375 attach mc
-
-Unless you're on a home/private LAN, you should [enable TLS access](https://docs.docker.com/articles/https/).
+    RCON must be enabled, which is the default, in order to use a fully interactive console with auto-completion and colorized log output. 

docs/configuration/interpolating.md

@@ -4,14 +4,10 @@ title: Modifying config files
 
 ## Replacing variables inside configs
 
-Sometimes you have mods or plugins that require configuration information that is only available at runtime.
-For example if you need to configure a plugin to connect to a database,
-you don't want to include this information in your Git repository or Docker image.
-Or maybe you have some runtime information like the server name that needs to be set
-in your config files after the container starts.
+Sometimes you have mods or plugins that require configuration information that is only available at deploy-time. For example if you need to configure a plugin to connect to a database, you don't want to include this information in your Git repository or Docker image.
+Or maybe you have some runtime information like the server name that needs to be set in your config files after the container starts.
 
-For those cases there is the option to replace defined variables inside your configs
-with environment variables defined at container runtime.
+For those cases there is the option to replace defined variables inside your configs with environment variables defined at container runtime.
 
 When the environment variable `REPLACE_ENV_IN_PLACE` is set to `true` (the default), the startup script will go through all files inside the container's `/data` path and replace variables that match the container's environment variables. Variables can instead (or in addition to) be replaced in files sync'ed from `/plugins`, `/mods`, and `/config` by setting `REPLACE_ENV_DURING_SYNC` to `true` (defaults to `false`).
 
@@ -66,7 +62,6 @@ database:
 This is how your `docker-compose.yml` file could look like:
 
 ```yml
-version: "3.8"
 # Other docker-compose examples in /examples
 
 services:

docs/configuration/jvm-options.md

@@ -8,13 +8,47 @@ By default, the image declares an initial and maximum Java memory-heap limit of
 - `INIT_MEMORY`: independently sets the initial heap size
 - `MAX_MEMORY`: independently sets the max heap size
 
-The values of all three are passed directly to the JVM and support format/units as `<size>[g|G|m|M|k|K]`. For example:
+The values of all three are passed directly to the JVM and support format/units as `<size>[g|G|m|M|k|K]`. 
 
-    -e MEMORY=2G
+!!! example "Using docker run"
+ 
+    ```
+        -e MEMORY=2G
+    ```
 
-To let the JVM calculate the heap size from the container declared memory limit, unset `MEMORY` with an empty value, such as `-e MEMORY=""`. By default, the JVM will use 25% of the container memory limit as the heap limit; however, as an example the following would tell the JVM to use 75% of the container limit of 2GB of memory:
+    or to use init and max memory:
 
-     -e MEMORY="" -e JVM_XX_OPTS="-XX:MaxRAMPercentage=75" -m 2000M
+    ```
+        -e INIT_MEMORY=1G -e MAX_MEMORY=4G
+    ```
+
+!!! example "Using compose file"
+     
+    ```
+        environment:
+          MEMORY: 2G
+    ```
+
+    or to use init and max memory:
+
+    ```
+        environment:
+          INIT_MEMORY: 1G
+          MAX_MEMORY: 4G
+    ```
+
+To let the JVM calculate the heap size from the container declared memory limit, unset `MEMORY` with an empty value, such as `-e MEMORY=""`. By default, the JVM will use 25% of the container memory limit as the heap limit; however, as an example the following would tell the JVM to use 75% of the container limit of 4GB of memory:
+
+!!! example "MaxRAMPercentage using compose file"
+
+    ```
+        environment:
+          MEMORY: ""
+          JVM_XX_OPTS: "-XX:MaxRAMPercentage=75"
+        deploy:
+          limits:
+            memory: 4G  
+    ```
 
 !!! important
     The settings above only set the Java **heap** limits. Memory resource requests and limits on the overall container should also account for non-heap memory usage. An extra 25% is [a general best practice](https://dzone.com/articles/best-practices-java-memory-arguments-for-container).

docs/configuration/misc-options.md

@@ -41,21 +41,9 @@ See [Custom worlds directory path](../misc/world-data.md#custom-worlds-directory
 
 ## Interactive and Color Console
 
-If you would like to `docker attach` to the Minecraft server console with color and interactive capabilities, then add
+When RCON is enabled, which is the default, and [TTY](https://docs.docker.com/compose/compose-file/05-services/#tty) is enabled on the container, then some server types will output colorized logs and provide a fully interactive console. To access the interactive console, use [`docker attach`](https://docs.docker.com/engine/reference/commandline/container_attach/) (not `exec`). When finished, make sure to use the sequence Control-P, Control-Q to detach without stopping the container.
 
-```
-  -e EXEC_DIRECTLY=true
-```
-
-> **NOTES**
->
-> This feature doesn't work via rcon, so you will need to `docker attach` to the container. Use the sequence Ctrl-P, Ctrl-Q to detach. 
-> 
-> This will bypass graceful server shutdown handling when using `docker stop`, so be sure the server console's `stop` command.
-> 
-> Make to enable stdin and tty with `-it` when using `docker run` or `stdin_open: true` and `tty: true` when using docker compose.
->
-> This feature is incompatible with Autopause and cannot be set when `ENABLE_AUTOPAUSE=true`.
+If this behavior interferes with the log content, then disable TTY or remove the setting entirely since the default is disabled. In a compose file, set the service's `tty` parameter to `false`. On the `docker run` command-line remove the `-t` argument.
 
 ## Server Shutdown Options
 
@@ -67,6 +55,24 @@ To allow time for players to finish what they're doing during a graceful server
     
     The grace period can be increased using [the -t option on docker-compose down](https://docs.docker.com/compose/reference/down/) or set the [stop_grace_period](https://docs.docker.com/compose/compose-file/05-services/#stop_grace_period) in the compose file.
 
+The `STOP_SERVER_ANNOUNCE_DELAY` can be bypassed by sending a `SIGUSR1` signal to the `mc-server-runner` process.
+
+`docker`:
+
+        docker stop --signal SIGUSR1 mc
+
+`docker compose`:
+
+        docker compose kill --signal SIGUSR1
+
+## Configuration Options for Minecraft Server Health Monitoring
+
+The image tags include specific variables to simplify configuration for monitoring the health of a Minecraft server:
+
+- `-e SERVER_HOST=localhost` : This variable sets the host address of the Minecraft server to be monitored. By default, it is set to `localhost`, but you can replace it with the actual hostname or IP address of your Minecraft server.
+
+- `-e SERVER_PORT=25565` : This variable sets the port number on which the Minecraft server is running. By default, Minecraft servers run on port 25565, but if your server is configured to use a different port, you should replace `25565` with the correct port number. This helps the monitoring system to accurately check the health status of the Minecraft server on the specified port.
+
 ## OpenJ9 Specific Options
 
 The openj9 image tags include specific variables to simplify configuration:

docs/configuration/server-properties.md

@@ -4,7 +4,9 @@ If you prefer to manually manage the `server.properties` file, set `OVERRIDE_SER
 
 !!! note
   
-    To clear a server property, set the variable to an empty string, such as `-e RESOURCE_PACK=""`. An unset variable is ignored and the existing `server.property` is left unchanged.
+    To clear a server property, set the variable to an empty string, such as `-e RESOURCE_PACK=""`. An unset variable is ignored and the existing server property is left unchanged.
+
+To see what `server.properties` will get used by the server, set the environment variable `DUMP_SERVER_PROPERTIES` to "true" and the contents of `server.properties` will get output before the server starts.
 
 ## Placeholders
 
@@ -62,9 +64,25 @@ The section symbol (§) and other unicode characters are automatically converted
     
     ![](../img/motd-example.png)
 
-To produce a multi-line MOTD, embed a newline character as `\n` in the string, such as
+To produce a multi-line MOTD, embed a newline character as `\n` in the string, such as the following example.
 
+!!! example "Multi-line MOTD"
+
+    With `docker run`
+    
+    ```
     -e MOTD="Line one\nLine two"
+    ```
+    
+    or within a compose file
+    
+    ```yaml
+          MOTD: |
+            line one
+            line two
+    # or
+    #      MOTD: "line one\nline two"
+    ```
 
 !!! tip
 
@@ -110,7 +128,7 @@ When either is set, [whitelisting of connecting users](https://minecraft.wiki/w/
 
 To change the behavior when the whitelist file already exists, set the variable `EXISTING_WHITELIST_FILE` to one of the following options:
 
-`SKIP` (default)
+`SKIP`
 : Skip processing of the whitelist file when one is already present. This is the same as setting the legacy variable `OVERRIDE_WHITELIST` to "false".
 
 `SYNCHRONIZE`
@@ -119,7 +137,7 @@ To change the behavior when the whitelist file already exists, set the variable
 `MERGE`
 : Merge the list of users from `WHITELIST` into the existing file. `WHITELIST_FILE` cannot be used with this option.
 
-`SYNC_FILE_MERGE_LIST`
+`SYNC_FILE_MERGE_LIST` (default)
 : When `WHITELIST_FILE` is provided it will overwrite an existing whitelist file. Also, if `WHITELIST` is provided, then those users will be merged into the newly copied file.
 
 !!! note 
@@ -128,6 +146,11 @@ To change the behavior when the whitelist file already exists, set the variable
 
 To [enforce the whitelist changes immediately](https://minecraft.wiki/w/Server.properties#enforce-whitelist) when whitelist commands are used , set `ENFORCE_WHITELIST` to "true". If managing the whitelist file manually, `ENABLE_WHITELIST` can be set to "true" to set the `white-list` property.
 
+!!! tip "Changing user API provider"
+
+    The usernames provided for whitelist and ops processing are resolved using either [PlayerDB](https://playerdb.co/) or [Mojang's API](https://wiki.vg/Mojang_API#Username_to_UUID). The default uses PlayerDB, but can be changed by setting the environment variable `USER_API_PROVIDER` to "mojang". Sometimes one or the other service can become overloaded, which is why there is the ability to switch providers.
+
+
 ### Op/Administrator Players
 
 Similar to the whitelist, users can be provisioned as operators (aka administrators) to your Minecraft server by
@@ -148,7 +171,7 @@ Similar to the whitelist, users can be provisioned as operators (aka administrat
 
 To change the behavior when the ops file already exists, set the variable `EXISTING_OPS_FILE` to one of the following options:
 
-`SKIP` (default)
+`SKIP`
 : Skip processing of the ops file when one is already present. This is the same as setting the legacy variable `OVERRIDE_OPS` to "false".
 
 `SYNCHRONIZE`
@@ -157,7 +180,7 @@ To change the behavior when the ops file already exists, set the variable `EXIST
 `MERGE`
 : Merge the list of users from `OPS` into the existing file. `OPS_FILE` cannot be used with this option.
 
-`SYNC_FILE_MERGE_LIST`
+`SYNC_FILE_MERGE_LIST` (default)
 : When `OPS_FILE` is provided it will overwrite an existing ops file. Also, if `OPS` is provided, then those users will be merged into the newly copied file.
 
 !!! note
@@ -472,4 +495,11 @@ When using `docker run` from a bash shell, the entries must be quoted with the `
 | SIMULATION_DISTANCE               | simulation-distance               |
 | SYNC_CHUNK_WRITES                 | sync-chunk-writes                 |
 | USE_NATIVE_TRANSPORT              | use-native-transport              |
-
+| HIDE_ONLINE_PLAYERS               | hide-online-players               |
+| RESOURCE_PACK_ID                  | resource-pack-id                  |
+| RESOURCE_PACK_PROMPT              | resource-pack-prompt              |
+| MAX_CHAINED_NEIGHBOR_UPDATES      | max-chained-neighbor-updates      |
+| LOG_IPS                           | log-ips                           |
+| REGION_FILE_COMPRESSION           | region-file-compression           |   
+| BUG_REPORT_LINK                   | bug-report-link                   |
+| PAUSE_WHEN_EMPTY_SECONDS          | pause-when-empty-seconds          |

docs/data-directory.md

@@ -31,7 +31,6 @@ When attached in this way you can stop the server, edit the configuration under
 With Docker Compose, setting up a host attached directory is even easier since relative paths can be configured. For example, with the following `docker-compose.yml` Docker will automatically create/attach the relative directory `minecraft-data` to the container.
 
 ``` yaml title="docker-compose.yml"
-version: "3"
 
 services:
   mc:

docs/index.md

@@ -19,7 +19,7 @@ where, in this case, the standard server port 25565, will be exposed on your hos
 
 !!! note
 
-    If you plan on running a server for a longer amount of time it is highly recommended using a management layer such as [Docker Compose](#using-docker-compose) or [Kubernetes](#deployment-templates-and-examples) to allow for incremental reconfiguration and image upgrades.
+    If you plan on running a server for a longer amount of time it is highly recommended using a management layer such as [Docker Compose](#using-docker-compose) or [Kubernetes](misc/deployment/index.md#on-kubernetes) to allow for incremental reconfiguration and image upgrades.
 
 !!! info 
 
@@ -39,7 +39,6 @@ By default, the container will download the latest version of the "vanilla" [Min
 4. Done! Point your client at your host's name/IP address and port 25565.
 
 ```yaml
-version: "3.8"
 
 services:
   mc:
@@ -59,6 +58,9 @@ To apply changes made to the compose file, just run `docker compose up -d` again
 
 Follow the logs of the container using `docker compose logs -f`, check on the status with `docker compose ps`, and stop the container using `docker compose stop`.
 
+!!! note "Configurator Tool"
+    If you prefer to use an interactive tool to create or edit a Docker Compose file for this image, you can check out [setupmc.com's configurator](https://setupmc.com/java-server/). It provides a form that supports most of the image variables and generates the `compose.yml` file in real time.
+
 !!! note "More Compose Examples"
     There are more [examples located in the Github repo](https://github.com/itzg/docker-minecraft-server/tree/master/examples).
 

docs/misc/autopause-autostop/autopause.md

@@ -16,7 +16,7 @@ A file called `.paused` is created in `/data` directory when the server is pause
 
 A `.skip-pause` file can be created in the `/data` directory to make the server skip autopausing, for as long as the file is present. The autopause timer will also be reset.
 
-A starting, example compose file has been provided in [examples/docker-compose-autopause.yml](https://github.com/itzg/docker-minecraft-server/blob/master/examples/docker-compose-autopause.yml).
+A starting, example compose file has been provided in [the examples](https://github.com/itzg/docker-minecraft-server/blob/master/examples/autopause/compose.yml).
 
 Auto-pause is not compatible with `EXEC_DIRECTLY=true` and the two cannot be set together.
 
@@ -45,7 +45,9 @@ The following environment variables define the behaviour of auto-pausing:
 
 ## Rootless Auto-Pause
 
-If you're running the container as rootless, you might need to set change the default port forwarder from RootlessKit to slirp4netns.
+If you're running the container as rootless, then it is necessary to add the `CAP_NET_RAW` capability to the container, such as using [the `cap_add` service field](https://docs.docker.com/compose/compose-file/05-services/#cap_add) in a compose file or [`--cap-add` docker run argument](https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities). It may also be necessary to set the environment variable `SKIP_SUDO` to "true". 
+
+You might need to set change the default port forwarder from RootlessKit to slirp4netns.
 
 For Docker, see the following for setup:
 
@@ -54,8 +56,9 @@ For Docker, see the following for setup:
 
 For Podman, see the following for setup:
 - https://rootlesscontaine.rs/getting-started/podman/#changing-the-port-forwarder
-- Run with
 
-  ```
-  -e AUTOPAUSE_KNOCK_INTERFACE=tap0 --cap-add=CAP_NET_RAW --network slirp4netns:port_handler=slirp4netns
-  ```
+
+!!! example "Using docker run"
+
+    -e AUTOPAUSE_KNOCK_INTERFACE=tap0 --cap-add=CAP_NET_RAW --network slirp4netns:port_handler=slirp4netns
+

docs/misc/autopause-autostop/autostop.md

@@ -2,7 +2,7 @@
 
 An option to stop the server after a specified time has been added for niche applications (e.g. billing saving on AWS Fargate). The function is incompatible with the Autopause functionality, as they basically cancel out each other.
 
-!!! note 
+!!! note
 
     the docker container variables have to be set accordingly (restart policy set to "no") and that the container has to be manually restarted.
 
@@ -25,3 +25,6 @@ The following environment variables define the behavior of auto-stopping:
   describes period of the daemonized state machine, that handles the stopping of the server
 
 > To troubleshoot, add `DEBUG_AUTOSTOP=true` to see additional output
+
+## Proxy Support
+If you make use of PROXY Protocol, i.e. through something like HAProxy or Fly.io, you will need to enable it in your variety of server's configuration, and then set the `USES_PROXY_PROTOCOL` envar to `true`. This lets Autostop monitor the server, where it otherwise wouldn't

docs/misc/contributing/building.md

@@ -26,3 +26,11 @@ or just a plain build
 ```shell
 docker build -t IMG_PREFIX/minecraft-server .
 ```
+
+## Installing extra packages
+
+The following build args can be set to install additional packages for the respective base image distro:
+
+- `EXTRA_DEB_PACKAGES`
+- `EXTRA_DNF_PACKAGES`
+- `EXTRA_ALPINE_PACKAGES`

docs/misc/examples.md

@@ -7,7 +7,6 @@ Various examples are [maintained in the repository](https://github.com/itzg/dock
 Using the [GeyserMC plugin](https://geysermc.org/) with a Paper server (or similar) "enables clients from Minecraft Bedrock Edition to join your Minecraft Java server". The example also includes [Floodgate](https://wiki.geysermc.org/floodgate/) which "allows Xbox Live authenticated Bedrock users to join without a Java Edition account". 
 
 ```yaml
-version: "3.8"
 
 services:
   mc:
@@ -27,19 +26,65 @@ services:
 
 [Source](https://github.com/itzg/docker-minecraft-server/blob/master/examples/geyser/docker-compose.yml)
 
+## Lazymc - Put your Minecraft server to rest when idle
+
+With [lazymc-docker-proxy](https://github.com/joesturge/lazymc-docker-proxy) you are able to use [lazymc](https://github.com/timvisee/lazymc) with the minecraft container.
+
+```yaml
+services:
+  lazymc:
+    container_name: lazymc
+    image: ghcr.io/joesturge/lazymc-docker-proxy:latest
+    environment:
+      # Point to the service name of the Minecraft server
+      SERVER_ADDRESS: mc:25565
+      # Required to find the container to manage it
+      LAZYMC_GROUP: mc
+    restart: unless-stopped
+    volumes:
+      # you should mount the minecraft server dir under /server, using read only.
+      - data:/server:ro
+      # you need to supply the docker socket, so that the container can run docker command
+      - /var/run/docker.sock:/var/run/docker.sock:ro
+    ports:
+      # lazymc-docker-proxy acts as a proxy, so there is
+      # no need to expose the server port on the Minecraft container
+      - "25565:25565"
+
+  # Standard Docker Minecraft server, also works with other server types
+  mc:
+    image: itzg/minecraft-server:java21
+    container_name: minecraft-server
+    # We need to add a label here so that lazymc-docker-proxy knows which
+    # container to manage
+    labels:
+      - lazymc.group=mc
+    tty: true
+    stdin_open: true
+    # This container should be managed solely by the lazymc container
+    # so set restart to no, or else the container will start again...
+    restart: no
+    environment:
+      EULA: "TRUE"
+    volumes:
+      - data:/data
+
+volumes:
+  data:
+```
+[Source](https://github.com/joesturge/lazymc-docker-proxy/blob/master/docker-compose.yaml)
+
 ## Lazytainer - Stop Minecraft container based on traffic
 Monitors network traffic to the Minecraft containers. If there is traffic, the container runs, otherwise the container is stopped/paused.
 
 By using [Lazytainer](https://github.com/vmorganp/Lazytainer) with the [docker-minecraft-server](https://github.com/itzg/docker-minecraft-server) a somehow similar behaviour to [Lazymc](https://github.com/timvisee/lazymc) can be archived.
 
 ```yaml
-version: "3"
 services:
   lazytainer:
-    container_name: lazytainer
     image: ghcr.io/vmorganp/lazytainer:master
     environment:
-      - VERBOSE=false
+      VERBOSE: false
     ports:
       - 25565:25565
     volumes:
@@ -54,13 +99,11 @@ services:
   mc:
     image: itzg/minecraft-server
     environment:
-      - EULA=TRUE
-      - TYPE=PURPUR
-      - MEMORY=4G
-      - TZ=Europe/Berlin
-      - OVERRIDE_SERVER_PROPERTIES=TRUE
+      EULA: TRUE
+      TYPE: PAPER
+      MEMORY: 4G
     volumes:
-      - /opt/container_volumes/minecraft/data:/data
+      - ./data:/data
     labels:
       - lazytainer.group=minecraft
     depends_on:
@@ -69,6 +112,5 @@ services:
     tty: true
     stdin_open: true
     restart: unless-stopped
-networks: {}
 ```
 [Source](https://github.com/itzg/docker-minecraft-server/blob/master/examples/lazytainer/docker-compose.yml)

docs/misc/related-projects.md

@@ -6,7 +6,7 @@ Docker image that runs a Minecraft Bedrock server.
 
 Lightweight multiplexer/proxy for Minecraft Java servers. Provided as a stand-alone application and a Docker image.
 
-### [itzg/bungeecord](https://github.com/itzg/docker-bungeecord/)
+### [itzg/mc-proxy](https://github.com/itzg/docker-bungeecord/)
 
 Docker image that runs a proxy powered by Bungeecord, Velocity, or Waterfall
 

docs/misc/troubleshooting.md

@@ -3,3 +3,5 @@ To troubleshoot the container initialization, such as when server files are pre-
 To troubleshoot just the command-line used to start the Minecraft server, set the environment variable `DEBUG_EXEC` to `true`.
 
 To troubleshoot any issues with memory allocation reported by the JVM, set the environment variable `DEBUG_MEMORY` to `true`.
+
+If you are experiencing any issues with the "Changing ownership of /data" step, that can be disabled by setting `SKIP_CHOWN_DATA` to `true`.

docs/misc/world-data.md

@@ -80,6 +80,10 @@ Example of expected VanillaTweaks share codes:
 VANILLATWEAKS_SHARECODE: MGr52E,tF1zL2,LnEDwT
 ```
 
+!!! note
+
+    Datapack names are all lower case. [See their spec](https://vanillatweaks.net/assets/resources/json/1.21/dpcategories.json) for a full list of 1.21 datapacks, and [their spec](https://vanillatweaks.net/assets/resources/json/1.21/ctcategories.json) for a full list of 1.21 crafting tweaks.
+
 Example of expected VanillaTweaks files:
 
 ``` yaml
@@ -89,13 +93,14 @@ VANILLATWEAKS_FILE: /config/vt-datapacks.json,/config/vt-craftingtweaks.json,/co
 ``` json title="DataPacks json"
 {
   "type": "datapacks",
-  "version": "1.18",
+  "version": "1.21",
   "packs": {
-    "survival": [
+    "gameplay changes": [
       "graves",
-      "multiplayer sleep"
+      "multiplayer sleep",
+      "armored elytra"
     ],
-    "items": ["armored elytra"]
+    "teleport commands": ["tpa"]
   }
 }
 ```
@@ -103,7 +108,7 @@ VANILLATWEAKS_FILE: /config/vt-datapacks.json,/config/vt-craftingtweaks.json,/co
 ``` json title="ResourcePacks json"
 {
     "type": "resourcepacks",
-    "version": "1.18",
+    "version": "1.21",
     "packs": {
         "aesthetic": ["CherryPicking", "BlackNetherBricks", "AlternateBlockDestruction"]
     }
@@ -114,7 +119,7 @@ VANILLATWEAKS_FILE: /config/vt-datapacks.json,/config/vt-craftingtweaks.json,/co
 ``` json title="CraftingTweaks Json"
 {
     "type": "craftingtweaks",
-    "version": "1.18",
+    "version": "1.21",
     "packs": {
         "quality of life": [
             "dropper to dispenser",

docs/mods-and-plugins/curseforge-files.md

@@ -22,22 +22,27 @@ The following formats are supported in the list of project-file references:
 - Project ID, such as `238222`. _The newest applicable file will be automatically selected._
 - Project slug or ID, `:`, and a file ID, such as `jei:4593548` or `238222:4593548`
 - Project slug or ID, `@`, and a partial filename, such as `jei@10.2.1.1005`. This option is useful to refer to a version of the mod/plugin rather than looking up the file ID.
+- An `@` followed by the **container path** to a listing file
 
-An `@` followed by the container path to a listing file can also be provided as a project-file reference. Each line is processed as a reference where blank lines and comments that start with `#` are ignored.
+!!! info "More about listing files"
 
-For example, `CURSEFORGE_FILES` can be set to "@/extras/cf-mods.txt" where the container file `/extras/cf-mods.txt` contains
+    Each line in the listing file is processed as one of the references above; however, blank lines and comments that start with `#` are ignored.
+    
+    Make sure to place the listing file in a mounted directory/volume or declare an appropriate mount for it.
+    
+    For example, `CURSEFORGE_FILES` can be set to "@/extras/cf-mods.txt", assuming "/extras" has been added to `volumes` section, where the container file `/extras/cf-mods.txt` contains
+    
+    ```text
+    # This comment is ignored
+    jei:10.2.1.1005
+    
+    # This and previous blank line are ignore
+    geckolib
+    aquaculture
+    naturalist
+    ```
 
-```text
-# This comment is ignored
-jei:10.2.1.1005
-
-# This and previous blank line are ignore
-geckolib
-aquaculture
-naturalist
-```
-
-!!! tip "Docker Compose"
+!!! tip "Multi-line values in Docker Compose"
 
     Making use of the space delimited option, compose file declarations can be organized nicely with a [multi-line string](https://yaml-multiline.info/), such as
     
@@ -47,3 +52,7 @@ naturalist
             aquaculture
             naturalist
     ```
+
+## Dependencies
+
+The files processing can detect if a dependency is missing from the given list, but is not able to resolve the dependencies otherwise since their metadata only gives the mod ID and not the specific file version/ID that is needed.

docs/mods-and-plugins/index.md

@@ -1,10 +1,10 @@
 # Working with mods and plugins
 
-## Mod platforms
+## Modpack platforms
 
-By far the easiest way to work with mod and plugins, especially large numbers of them, is to utilize modpacks with [one of the supported mod platforms](../types-and-platforms/index.md).
+By far the easiest way to work with mod and plugins, especially large numbers of them, is to utilize modpacks with [one of the supported modpack platforms](../types-and-platforms/index.md).
 
-The following are some supported mod platforms:
+The following are some supported modpack platforms:
 
 - [Modrinth](../types-and-platforms/mod-platforms/modrinth-modpacks.md) 
 - [CurseForge](../types-and-platforms/mod-platforms/auto-curseforge.md)
@@ -23,7 +23,7 @@ The terms "mods" and "plugins" can be quite confusing. Generally, the rule of th
 There are optional volume paths that can be attached to supply content to be copied into the data area:
 
 `/plugins`
-: content in this directory is synchronized into `/data/plugins` for server types that use plugins, [as described above](#mods-vs-plugins). For special cases, the source can be changed by setting `COPY_PLUGINS_SRC` and destination by setting `COPY_PLUGINS_DEST`.
+: content in this directory is synchronized into `/data/plugins` for server types that use plugins, [as described above](#mods-vs-plugins). For special cases, the source can be changed by setting `COPY_PLUGINS_SRC` and destination by setting `COPY_PLUGINS_DEST`. If using a mod-based loader, such as Forge or Fabric, but a hybrid mod like [Cardboard](https://modrinth.com/mod/cardboard), then set `USES_PLUGINS` to have the automation utilize `/plugins` mount.
 
 `/mods`
 : content in this directory is synchronized into `/data/mods` for server types that use mods, [as described above](#mods-vs-plugins). For special cases, the source can be changed by setting `COPY_MODS_SRC` and destination by setting `COPY_MODS_DEST`.
@@ -76,11 +76,26 @@ would expand to `https://cdn.example.org/configs-v9.0.1.zip,https://cdn.example.
 
 If applying large generic packs, the update can be time-consuming. To skip the update set `SKIP_GENERIC_PACK_UPDATE_CHECK` to "true". Conversely, the generic pack(s) can be forced to be applied by setting `FORCE_GENERIC_PACK_UPDATE` to "true".
 
-The most time-consuming portion of the generic pack update is generating and comparing the SHA1 checksum. To skip the checksum generation, set `SKIP_GENERIC_PACK_CHECKSUM` to "true.
+The most time-consuming portion of the generic pack update is generating and comparing the SHA1 checksum. To skip the checksum generation, set `SKIP_GENERIC_PACK_CHECKSUM` to "true".
+
+To disable specific mods, which can be useful for conflicts between multiple generic packs, you can use the `GENERIC_PACKS_DISABLE_MODS` variable to specify mods to disable.
+
+Disabling mods with docker run:
+```shell
+docker run -d -e GENERIC_PACKS_DISABLE_MODS="mod1.jar mod2.jar" ...
+```
+
+Disabling mods within docker compose files:
+```yaml
+      GENERIC_PACKS_DISABLE_MODS: |
+        mod1.jar
+        mod2.jar
+```
 
 ## Mods/plugins list
 
 You may also download or copy over individual mods/plugins using the `MODS` or `PLUGINS` environment variables. Both are a comma or newline delimited list of
+
 - URL of a jar file
 - container path to a jar file
 - container path to a directory containing jar files
@@ -117,7 +132,7 @@ https://edge.forgecdn.net/files/2871/647/ToastControl-1.15.2-3.0.1.jar
 
     Blank lines and lines that start with a `#` will be ignored
 
-    [This compose file](https://github.com/itzg/docker-minecraft-server/blob/master/examples/docker-compose-mods-file.yml) shows another example of using this feature.
+    [This compose file](https://github.com/itzg/docker-minecraft-server/blob/master/examples/mods-file/docker-compose.yml) shows another example of using this feature.
 
 ## Remove old mods/plugins
 

docs/mods-and-plugins/modrinth.md

@@ -1,24 +1,26 @@
 # Auto-download from Modrinth
 
-[Modrinth](https://modrinth.com/) is an open source modding platform with a clean, easy to use website for finding [Fabric and Forge mods](https://modrinth.com/mods). At startup, the container will automatically locate and download the newest versions of mod/plugin files that correspond to the `TYPE` and `VERSION` in use. Older file versions downloaded previously will automatically be cleaned up.
+[Modrinth](https://modrinth.com/) is an open source modding platform with a clean, easy to use website for finding [Fabric, Forge, etc mods](https://modrinth.com/mods) and [Paper, etc plugins](https://modrinth.com/plugins), and [datapacks](https://modrinth.com/datapacks). At startup, the container will automatically locate and download the newest versions of mod/plugin files that correspond to the `TYPE` and `VERSION` in use. Older file versions downloaded previously will automatically be cleaned up.
 
-- **MODRINTH_PROJECTS** : comma or newline separated list of project slugs (short name) or IDs. The project ID is located in the "Technical information" section. The slug is the part of the page URL that follows `/mod/`:
+- **MODRINTH_PROJECTS** : comma or newline separated list of project slugs (short name) or IDs. The project ID is located in the "Technical information" section. The project slug is the part of the URL that follows `/mod/`, `/plugin/`, or `/datapack/`. For example:
   ```
     https://modrinth.com/mod/fabric-api
                              ----------
                               |
                               +-- project slug
   ```
-  Also, a specific version/type can be declared using colon symbol and version id/type after the project slug. The version id can be found in the 'Metadata' section. Valid version types are `release`, `beta`, `alpha`.
-
-!!! example
+  Also, a specific version (or release type) can be declared adding a colon and then the version id, version number/name, or release type after the project slug. The version ID or number can be found in the 'Metadata' section. Valid release types are `release`, `beta`, `alpha`.
+  
+  To select a datapack from a Modrinth project, prefix the entry with "datapack:". When running a vanilla server, this is optional since only datapacks will be available for vanilla servers to select.
         
-    | Description                     | Example               |
-    |---------------------------------|-----------------------|
-    | Select latest version           | `fabric-api`          |
-    | Select specific version         | `fabric-api:PbVeub96` |
-    | Select latest beta version      | `fabric-api:beta`     |
-    | Latest version using project ID | `P7dR8mSH`            |
+  | Description                     | Example projects entry     |
+  |---------------------------------|----------------------------|
+  | Select latest version           | `fabric-api`               |
+  | Select specific version         | `fabric-api:PbVeub96`      |
+  | Select latest beta version      | `fabric-api:beta`          |
+  | Latest version using project ID | `P7dR8mSH`                 |
+  | Latest version of datapack      | `datapack:terralith`       |
+  | Specific version of datapack    | `datapack:terralith:2.5.5` |
 
 ## Extra options
 
@@ -26,5 +28,5 @@
 : Can be set to `none` (the default), `required`, or `optional` to download required and/or optional dependencies.
 
 `MODRINTH_ALLOWED_VERSION_TYPE`
-: The version type is used to determine the newest version to use from each project. The allowed values are `release` (default), `beta`, `alpha`.
+: The version type is used to determine the newest version to use from each project. The allowed values are `release` (default), `beta`, `alpha`. Setting to `beta` will pick up both release and beta versions. Setting to `alpha` will pick up release, beta, and alpha versions.
 

docs/requirements.txt

@@ -1,9 +1,7 @@
-mkdocs == 1.5.3
-mkdocs-material-extensions == 1.3.1
-mkdocs-material == 9.5.4
-mkdocs-autorefs == 0.5.0
-mkdocstrings == 0.24.0
+mkdocs-material == 9.6.1
+mkdocs-autorefs == 1.3.0
+mkdocstrings == 0.27.0
 mkdocs-literate-nav == 0.6.1
 mdx-gh-links == 0.4
 mkdocs-click == 0.8.1
-mkdocs-static-i18n == 1.2.0
+mkdocs-static-i18n == 1.3.0

docs/types-and-platforms/index.md

@@ -1,4 +1,4 @@
-# Server Types and Mod Platforms
+# Server Types and Modpack Platforms
 
 Server types can be selected by setting the `TYPE` environment variable to one of the types described in these sections.
 
@@ -6,7 +6,7 @@ The default server type is [the official software provided by Mojang](https://ww
 
 **From the sections to the left...**
 
-The **mod platforms** take a modpack identifier, file, etc and use that to select and download the appropriate version of a mod loader, such as Forge or Fabric, downloading declared mods/plugins, and apply any additional files. The mod platforms are selected by setting `MOD_PLATFORM`; however, for ease of use and compatibility, the selection can be set in `TYPE`.
+The **modpack platforms** take a modpack identifier, file, etc and use that to select and download the appropriate version of a mod loader, such as Forge or Fabric, downloading declared mods/plugins, and apply any additional files. The modpack platforms are selected by setting `MODPACK_PLATFORM`; however, for ease of use and backward compatibility, the selection can be set in `TYPE` or `MOD_PLATFORM`.
 
 The individual **server types** allow for selecting the mod loader / server type and specific versions of those. 
 

docs/types-and-platforms/mod-platforms/auto-curseforge.md

@@ -1,6 +1,6 @@
 # Auto CurseForge
 
-To manage a CurseForge modpack automatically with upgrade support, pinned or latest version tracking, set `MOD_PLATFORM` or `TYPE` to "AUTO_CURSEFORGE". The appropriate mod loader (Forge / Fabric) version will be automatically installed as declared by the modpack. This mode will also take care of cleaning up unused files installed by previous versions of the modpack, but world data is never auto-removed.
+To manage a CurseForge modpack automatically with upgrade support, pinned or latest version tracking, set `MODPACK_PLATFORM`, `MOD_PLATFORM` or `TYPE` to "AUTO_CURSEFORGE". The appropriate mod loader (Forge / Fabric) version will be automatically installed as declared by the modpack. This mode will also take care of cleaning up unused files installed by previous versions of the modpack, but world data is never auto-removed.
 
 ## API Key
 
@@ -56,7 +56,9 @@ For example:
 -e TYPE=AUTO_CURSEFORGE -e CF_SLUG=all-the-mods-8
 ```
 
-The latest file will be located and used by default, but if a specific version is desired you can use one of the following options. With any of these options **do not select a server file** -- they lack the required manifest and defeat the ability to consistently automate startup.
+### Pinning modpack and mod loader versions
+
+The latest modpack file and its associated mod loader will be located and installed by default on startup (including automatic upgrading of both on subsequent startups, if a later version is found on CurseForge). If a specific version is desired instead, you can use one of the following options. With any of these options **do not select a server file** -- they lack the required manifest and defeat the ability to consistently automate startup.
 
 - Use `CF_PAGE_URL`, but include the full URL to a specific file
 - Set `CF_FILE_ID` to the numerical file ID
@@ -82,13 +84,15 @@ The following examples all refer to version 1.0.7 of ATM8:
   CF_FILENAME_MATCHER: 1.0.7
 ```
 
+Pinning modpack version also pins the mod loader (to the version specified by the modpack). Mod loader version cannot be pinned independently of the modpack.
+
 ## Manual Downloads
 
 For mod, modpacks, and world files that are not allowed for automated download, the container path `/downloads` can be attached and matching files will be retrieved from there. The subdirectories `mods`, `modpacks`, and `worlds` will also be checked accordingly. To change the source location of downloaded files, set `CF_DOWNLOADS_REPO` to an existing container path. To disable this feature, set `CF_DOWNLOADS_REPO` to an empty string.
 
-!!! note "Mods need download report"
+!!! warning "Download using a browser"
 
-    A file called `MODS_NEED_DOWNLOAD.txt` will be created in the `/data` directory that lists the mods that need to be manually downloaded and where to get them.
+    It's important to use a browser to download the files listed for manual download. If your Docker host is running without a graphical interface, then you can use `scp` or similar to transfer the files to it.
 
 !!! example
 
@@ -97,7 +101,7 @@ For mod, modpacks, and world files that are not allowed for automated download,
     1. Create a directory next to the `docker-compose.yml` file. The name doesn't matter, but "downloads" is the common convention
     2. From the "Mods Need Download" output, visit the download page of each, click on the file download and save that file into the directory created in the previous step
     3. Add a host directory mount to the volumes section where the container path **must be** `/downloads`. The snippet below shows how that will look
-    4. Re-run `docker composwe up -d` to apply the changes
+    4. Re-run `docker compose up -d` to apply the changes
     
     ```yaml
         volumes:
@@ -106,7 +110,7 @@ For mod, modpacks, and world files that are not allowed for automated download,
 
 ## Unpublished Modpacks
 
-If you wish to use a unpublished modpack zip, set the container path to the file in `CF_MODPACK_ZIP`. Similarly, the container path to a modpack manifest JSON can be passed to `CF_MODPACK_MANIFEST`.  In either case, **the modpack slug or page URL must still be provided**.
+If you wish to use an unpublished modpack zip, set the container path to the file in `CF_MODPACK_ZIP`. Similarly, the container path to a modpack manifest JSON can be passed to `CF_MODPACK_MANIFEST`.  In either case, **the modpack slug or page URL must still be provided**.
 
 !!! example
 
@@ -116,7 +120,7 @@ If you wish to use a unpublished modpack zip, set the container path to the file
         image: itzg/minecraft-server
         environment:
           EULA: true
-          MOD_PLATFORM: AUTO_CURSEFORGE
+          MODPACK_PLATFORM: AUTO_CURSEFORGE
           # allocate from https://console.curseforge.com/ and set in .env file
           CF_API_KEY: ${CF_API_KEY}
           CF_MODPACK_MANIFEST: /manifests/manifest.json
@@ -164,6 +168,11 @@ Quite often there are mods that need to be excluded, such as ones that did not p
 
 Mods can be excluded by passing a comma or space delimited list of **project** slugs or IDs via `CF_EXCLUDE_MODS`. Similarly, there are some mods that are incorrectly tagged as client only. For those, pass the **project** slugs or IDs via `CF_FORCE_INCLUDE_MODS`. These lists will be combined with the content of the exclude/include file, if given.
 
+!!! note
+    `CF_FORCE_INCLUDE_MODS` will not download additional mods.
+    
+    For additional mods, refer to [the `CURSEFORGE_FILES` variable](../../mods-and-plugins/curseforge-files.md).
+
 A mod's project ID can be obtained from the right hand side of the project page:
 ![cf-project-id](../../img/cf-project-id.png)
 
@@ -207,11 +216,36 @@ Ant-style paths can include the following globbing/wildcard symbols:
 ## World/Level Data
 
 Some modpacks come with world/save data via a worlds file and/or the overrides provided with the modpack. Either approach can be selected to set the `LEVEL` to the resulting saves directory by setting `CF_SET_LEVEL_FROM` to either:
+
 - `WORLD_FILE`
 - `OVERRIDES`
 
+## Ignore missing files
+
+Some mods use temporary files from the modpack and delete them when finished. Others will patch themselves and "disable" the original mod jar, such as gregtech. In order to avoid the installer from detecting the absent file(s) and re-installing, those files can be ignored by passing a comma or newline delimited list to `CF_IGNORE_MISSING_FILES`.
+
+!!! hint
+
+    A warning log will indicate what files were found to be missing from the previous installation run, such as
+
+    ```
+    Re-installing due to missing files from modpack: [mods/gregtech-2.6.2-beta.jar]
+    ```
+
+!!! example
+
+    In a Compose file
+    ```yaml
+      environment:
+        CF_IGNORE_MISSING_FILES: |
+          mods/gregtech-2.6.2-beta.jar
+    ```
+
+
 ## Extra options
 
 Other configuration available:
+
 - `CF_PARALLEL_DOWNLOADS` (default is 4): specify how many parallel mod downloads to perform
 - `CF_OVERRIDES_SKIP_EXISTING` (default is false): if set, files in the overrides that already exist in the data directory are skipped. **NOTE** world data is always skipped, if present.
+- `CF_FORCE_REINSTALL_MODLOADER` (default is false): this can be set to `true` to force the modpack's declared modloader, such as Forge, to be reinstalled. This is useful if some of the modloader's files become corrupted.

docs/types-and-platforms/mod-platforms/curseforge.md

@@ -4,7 +4,7 @@
 
     This mod platform type is deprecated. Please use [AUTO_CURSEFORGE](auto-curseforge.md) for new deployments.
 
-Enable this server mode by setting `MOD_PLATFORM` or `TYPE` to "CURSEFORGE" along with the following specific variables.
+Enable this server mode by setting `MODPACK_PLATFORM`, `MOD_PLATFORM` or `TYPE` to "CURSEFORGE" along with the following specific variables.
 
 You need to specify a modpack to run, using the `CF_SERVER_MOD` environment
 variable. A CurseForge server modpack is available together with its respective

docs/types-and-platforms/mod-platforms/ftb.md

@@ -3,7 +3,7 @@
 !!! note
     Requires one of the Ubuntu with Hotspot images listed in [the Java versions section](../../versions/java.md).
 
-[Feed the Beast application](https://www.feed-the-beast.com/) modpacks are supported by setting `MOD_PLATFORM` or `TYPE` to "FTBA"
+[Feed the Beast application](https://www.feed-the-beast.com/) modpacks are supported by setting `MODPACK_PLATFORM`, `MOD_PLATFORM` or `TYPE` to "FTBA"
 
 !!! note
     The "A" at the end of "FTBA" is important. The value "FTB" used to be an alias for "CURSEFORGE".

docs/types-and-platforms/mod-platforms/modrinth-modpacks.md

@@ -1,6 +1,6 @@
 # Modrinth Modpacks
 
-[Modrinth Modpacks](https://modrinth.com/modpacks) can automatically be installed along with the required mod loader (Forge or Fabric) by setting `MOD_PLATFORM` or `TYPE` to "MODRINTH". Upgrading (and downgrading) takes care of cleaning up old files and upgrading (and downgrading) the mod loader.
+[Modrinth Modpacks](https://modrinth.com/modpacks) can automatically be installed along with the required mod loader (Forge or Fabric) by setting `MODPACK_PLATFORM`, `MOD_PLATFORM` or `TYPE` to "MODRINTH". Upgrading (and downgrading) takes care of cleaning up old files and upgrading (and downgrading) the mod loader.
 
 ## Modpack project
 
@@ -59,4 +59,51 @@ To exclude client mods that are incorrectly declared by the modpack as server-co
         notenoughanimations
         lambdynamiclights
         euphoriapatcher
-    ```
+    ```
+
+## Force-include files
+
+To force include client mods, set `MODRINTH_FORCE_INCLUDE_FILES` to a comma or newline delimited list of partial file names. You may need to set `MODRINTH_FORCE_SYNCHRONIZE` to "true" while iterating on a compatible set of mods to use.
+
+!!! example
+
+    In a Compose file:
+    ```yaml
+      MODRINTH_FORCE_INCLUDE_FILES: |
+        yet-another-config-lib
+    ```
+
+## Default exclude/includes
+
+The image comes with a default set of exclude/includes, maintained [in the repo files area](https://github.com/itzg/docker-minecraft-server/blob/master/files/modrinth-exclude-include.json) and uses the same [JSON schema](https://github.com/itzg/mc-image-helper?tab=readme-ov-file#excludeinclude-file-schema) as Auto CurseForge. Those defaults can be disabled by setting the env var `MODRINTH_DEFAULT_EXCLUDE_INCLUDES` to an empty string.
+
+## Excluding Overrides Files
+
+Modrinth mrpack/zip files may include an `overrides` subdirectory that contains config files, world data, and extra mod files. All of those files will be extracted into the `/data` path of the container. If any of those files, such as incompatible mods, need to be excluded from extraction, then the `MODRINTH_OVERRIDES_EXCLUSIONS` variable can be set with a comma or newline delimited list of ant-style paths ([see below](#ant-style-paths)) to exclude, relative to the overrides (or `/data`) directory.
+
+### Ant-style paths
+
+Ant-style paths can include the following globbing/wildcard symbols:
+
+| Symbol | Behavior                                                |
+|--------|---------------------------------------------------------|
+| `*`    | Matches zero, one, or many characters except a slash    |
+| `**`   | Matches zero, one, or many characters including slashes |
+| `?`    | Matches one character                                   |
+
+!!! example
+
+    The following compose `environment` entries show how to exclude Iris and Sodium mods from the overrides
+    
+    ```yaml
+      MODRINTH_OVERRIDES_EXCLUSIONS: mods/NekosEnchantedBooks-*.jar,mods/citresewn-*.jar
+    ```
+    
+    or using newline delimiter, which improves maintainability
+    
+    ```yaml
+      MODRINTH_OVERRIDES_EXCLUSIONS: |
+        mods/NekosEnchantedBooks-*.jar
+        mods/citresewn-*.jar
+    ```
+

docs/types-and-platforms/server-types/bukkit-spigot.md

@@ -1,5 +1,9 @@
 # Bukkit/Spigot
 
+!!! failure "GetBukkit site no longer supports automated downloads"
+
+    The downloads provider <https://getbukkit.org> seems to no longer support automated downloads. As such, it is highly recommended to switch to [Paper](paper.md) instead since it is actively maintained and fully compatible with Bukkit/Spigot plugins.
+
 Run a Bukkit/Spigot server type by setting the environment variable `TYPE` to "BUKKIT" or "SPIGOT".
 
 !!! example

docs/types-and-platforms/server-types/forge.md

@@ -1,5 +1,13 @@
 A [Forge server](http://www.minecraftforge.net/) can be automatically downloaded, upgraded, and run by setting the environment variable `TYPE` to "FORGE".
 
+!!! note "A note from the installer"
+
+    > Please do not automate the download and installation of Forge.
+    Our efforts are supported by ads from the download page.
+    If you MUST automate this, please consider supporting the project through <https://www.patreon.com/LexManos/>
+
+    Since my project also relies on donations, please pass it along and consider contributing to the Patreon above.
+
 !!! example
 
     ```
@@ -14,6 +22,7 @@ A [Forge server](http://www.minecraftforge.net/) can be automatically downloaded
 
 The overall version is specified by `VERSION`, [as described in the section above](../../versions/minecraft.md) and provides the same benefits of upgrading as new versions are released. By default, the recommended version of Forge for that Minecraft version will be selected. The latest version can be selected instead by setting the environment variable `FORGE_VERSION` to "latest". You can also choose a specific Forge version by setting `FORGE_VERSION` with that version, such as "14.23.5.2854".
 
+
 !!! example
 
     ```
@@ -55,3 +64,22 @@ Support for [NeoForge](https://neoforged.net/) is also provided. A NeoForge serv
           VERSION: "1.20.4"
           NEOFORGE_VERSION: "beta"
     ```
+
+### Cleanroom
+
+[Cleanroom](https://github.com/CleanroomMC/Cleanroom) isn't fully automated, but can be utilized by...
+
+1. choose the desired release at https://github.com/CleanroomMC/Cleanroom/releases
+2. grab the link to the `*-installer.jar` file in that release
+3. with `TYPE` set to "FORGE", set `FORGE_INSTALLER_URL` to the installer jar's link
+
+!!! example
+
+    In docker compose `environment`
+    
+    ```yaml
+      TYPE: FORGE
+      FORGE_INSTALLER_URL: https://github.com/CleanroomMC/Cleanroom/releases/download/0.2.4-alpha/cleanroom-0.2.4-alpha-installer.jar
+    ```
+    
+    [Full example](https://github.com/itzg/docker-minecraft-server/tree/master/examples/cleanroom)

docs/types-and-platforms/server-types/hybrids.md

@@ -8,7 +8,7 @@ A [Magma](https://magmafoundation.org/) server, which is a combination of Forge
 
 !!! note
 
-    The Magma project [has been terminated](https://git.magmafoundation.org/magmafoundation/magma-1-20-x/-/commit/4e7abe37403c47d09b74b77bcfc26a19b18f5891). Please use Magma Maintained for 1.12.2, 1.18.2, 1.19.3, and 1.20.1, or Ketting for 1.20.2+.
+    The Magma project has been terminated ([original link died](https://git.magmafoundation.org/magmafoundation/magma-1-20-x/-/commit/4e7abe37403c47d09b74b77bcfc26a19b18f5891), [alternate statement on their discord](https://discord.com/channels/612695539729039411/647287352833605662/1174412642962649198) ). Please use Magma Maintained for 1.12.2, 1.18.2 and 1.19.3, or Ketting for 1.20.1+.
 
     There are limited base versions supported, so you will also need to  set `VERSION`, such as "1.12.2", "1.16.5", etc.
 
@@ -25,18 +25,15 @@ A [Magma Maintained](https://github.com/magmamaintained/) server, which is a alt
 
 ### Ketting
 
-A [Ketting](https://github.com/kettingpowered/Ketting-1-20-x) server, which is a alternative project of Magma 1.20.2+, can be used with
+A [Ketting](https://github.com/kettingpowered/Ketting-1-20-x) server, which is an alternative project of Magma 1.20.1+, can be used with
 
     -e TYPE=KETTING
 
-There are limited base versions supported, so you will also need to  set `VERSION`, such as "1.20.2" or later.
-
-In addition, `FORGE_VERSION` and `KETTING_VERSION` must be specified. You can find the supported `FORGE_VERSION` in the [project page](https://github.com/kettingpowered/Ketting-1-20-x), and `KETTING_VERSION` in the [release page](https://github.com/kettingpowered/Ketting-1-20-x/releases).
-
-!!! note
-
-    The length of `KETTING_VERSION` is 8, not 7 since it is taken from an abbreviated git commit hash. The value can be found in a jar file link on an Assets section for each releases.
+There are limited base versions supported, so you will also need to  set `VERSION`, such as "1.20.1" or later.
 
+`FORGE_VERSION` and `KETTING_VERSION` may be specified; however, they will be defaulted by the [Ketting launcher](https://github.com/kettingpowered/kettinglauncher) otherwise.
+Available Ketting Versions may be found at [https://reposilite.c0d3m4513r.com/#/Ketting-Server-Releases/org/kettingpowered/server/forge](https://reposilite.c0d3m4513r.com/#/Ketting-Server-Releases/org/kettingpowered/server/forge).
+The Version structure is `MinecraftVersion-ForgeVersion-KettingVersion` (e.g. `1.20.1-47.2.20-0.1.4` is for Minecraft `1.20.1`, Forge `47.2.20` and Ketting `0.1.4`).
 
 ### Mohist
 

docs/types-and-platforms/server-types/paper.md

@@ -1,10 +1,50 @@
-Enable Paper server mode by adding a `-e TYPE=PAPER` to your command-line.
+A [PaperMC server](https://papermc.io/) can be automatically downloaded, upgraded, and run by setting the environment variable TYPE to "PAPER".
 
-By default, the container will run the latest build of [Paper server](https://papermc.io/downloads) but you can also choose to run a specific build with `-e PAPERBUILD=205`.
+By default, the container will find and download the latest build for the `VERSION` chosen. If `VERSION` is not specified, then the latest Minecraft version released by PaperMC is selected. Along with a specific `VERSION`, a specific Paper build can be selected by setting the environment variable `PAPER_BUILD`. 
 
-    docker run -d -v /path/on/host:/data \
-        -e TYPE=PAPER \
-        -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
+To allow for the selection of experimental builds, set `PAPER_CHANNEL` to "experimental", otherwise only release/default channel builds are selected.
+
+!!! example
+
+    Using `docker run` command line
+    
+    ```
+    docker run ... -e TYPE=PAPER ... 
+    
+    docker run ... -e TYPE=PAPER -e VERSION=1.20.6 ... 
+    
+    docker run ... -e TYPE=PAPER -e VERSION=1.20.6 -e PAPER_BUILD=140 ... 
+    
+    docker run ... -e TYPE=PAPER -e PAPER_CHANNEL=experimental ... 
+    ```
+    
+    Using a compose file:
+    
+    ```yaml
+    environment:
+      TYPE: PAPER
+    ```
+    
+    ```yaml
+    environment:
+      TYPE: PAPER
+      VERSION: 1.20.6
+      PAPER_BUILD: 140
+    ```
+    
+    ```yaml
+    environment:
+      TYPE: PAPER
+      PAPER_CHANNEL: experimental
+    ```
+
+!!! tip
+
+    If you see the following error, it likely means you need to set the env var `PAPER_CHANNEL` to "experimental"
+    
+    ```
+    No build found for version 1.21 with channel 'default'
+    ```
 
 If you are hosting your own copy of Paper you can override the download URL with `PAPER_DOWNLOAD_URL=<url>`.
 
@@ -47,13 +87,19 @@ Extra variables:
 
 ### Folia
 
-Enable Folia server mode by adding a `-e TYPE=FOLIA` to your command-line.
+A [Folia server](https://papermc.io/software/folia) can be used by setting the environment variable `TYPE` to "FOLIA".
 
-By default, the container will run the latest build of [Folia server](https://papermc.io/downloads), but you can also choose to run a specific build with `-e FOLIABUILD=26`.
+By default, the container will run the latest experimental build of [Folia server](https://papermc.io/downloads), but you can also choose to run a specific build with `-e FOLIABUILD=26`. The release channel can be changed with the variable `FOLIA_CHANNEL`; however, only experimental builds are available at this time.
 
+!!! example
+
+    Using `docker run`
+    
+    ```
     docker run -d -v /path/on/host:/data \
         -e TYPE=FOLIA \
         -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
+    ```
 
 If you are hosting your own copy of Folia you can override the download URL with `FOLIA_DOWNLOAD_URL=<url>`.
 

docs/variables.md

@@ -558,40 +558,40 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
         </tr>
         <tr>
             <td><code>BROADCAST_RCON_TO_OPS</code></td>
-            <td>Should RCON be enabled</td>
+            <td>Sets broadcast-rcon-to-ops server property</td>
             <td><code>false</code></td>
             <td>⬜️</td>
         </tr>
         <tr>
-            <td><code>RCON_CMDS_STARTUP</code></td>
-            <td>RCON commands can be configured to execute when the server starts, a client connects, or a client disconnects</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>RCON_CMDS_ON_CONNECT</code></td>
-            <td>RCON commands can be configured to execute when the server starts, a client connects, or a client disconnects</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>RCON_CMDS_ON_DISCONNECT</code></td>
-            <td>RCON commands can be configured to execute when the server starts, a client connects, or a client disconnects</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>RCON_CMDS_LAST_DISCONNECT</code></td>
-            <td>RCON commands can be configured to execute when the server starts, a client connects, or a client disconnects</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>RCON_CMDS_STARTUP</code></td>
-            <td>RCON commands can be configured to execute when the server starts, a client connects, or a client disconnects</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
+			<td><code>RCON_CMDS_STARTUP</code></td>
+			<td>RCON commands to execute when the server starts.</td>
+			<td><code></code></td>
+			<td>⬜️</td>
+		</tr>
+		<tr>
+			<td><code>RCON_CMDS_ON_CONNECT</code></td>
+			<td>RCON commands to execute whenever a client connects to the server.</td>
+			<td><code></code></td>
+			<td>⬜️</td>
+		</tr>
+		<tr>
+			<td><code>RCON_CMDS_FIRST_CONNECT</code></td>
+			<td>RCON commands to execute on the first client connection to the server.</td>
+			<td><code></code></td>
+			<td>⬜️</td>
+		</tr>
+		<tr>
+			<td><code>RCON_CMDS_ON_DISCONNECT</code></td>
+			<td>RCON commands to execute whenever a client disconnects from the server.</td>
+			<td><code></code></td>
+			<td>⬜️</td>
+		</tr>
+		<tr>
+			<td><code>RCON_CMDS_LAST_DISCONNECT</code></td>
+			<td>RCON commands to execute when the last client disconnects from the server.</td>
+			<td><code></code></td>
+			<td>⬜️</td>
+		</tr>
     </tbody>
 </table>
 

docs/versions/java.md

@@ -1,52 +1,128 @@
-## Running Minecraft server on different Java version
+## Image tags
 
-!!! note
+Image references can either omit the tag, which implies the tag `latest`, such as
 
-    For Forge versions less than 1.18, you _must_ use the `java8-multiarch` (or other java8) image tag.
+    itzg/minecraft-server
 
-    In general, if you see the following line in a server startup failure, then it means you need to be using Java 8 instead of the latest image Java version:
+or explicitly include the tag, such as
 
-    ```
-    Caused by: java.lang.ClassCastException: class jdk.internal.loader.ClassLoaders$AppClassLoader 
-       cannot be cast to class java.net.URLClassLoader
-    ```
+    itzg/minecraft-server:<tag>
 
-When using the image `itzg/minecraft-server` without a tag, the `latest` image tag is implied from the table below. To use a different version of Java, please use an alternate tag to run your Minecraft server container. The `stable` tag is similar to `latest`; however, it tracks [the most recent repository release/tag](https://github.com/itzg/docker-minecraft-server/releases/latest).
+where `<tag>` refers to the first column of this table:
 
-| Tag name         | Java version | Linux  | JVM Type       | Architecture      |
-|------------------|--------------|--------|----------------|-------------------|
-| latest           | 17           | Ubuntu | Hotspot        | amd64,arm64,armv7 |
-| stable           | 17           | Ubuntu | Hotspot        | amd64,arm64,armv7 |
-| java8            | 8            | Alpine | Hotspot        | amd64             |
-| java8-jdk        | 8            | Ubuntu | Hotspot+JDK    | amd64             |
-| java8-multiarch  | 8            | Ubuntu | Hotspot        | amd64,arm64,armv7 |
-| java8-openj9     | 8            | Debian | OpenJ9         | amd64             |
-| java8-graalvm-ce | 8            | Oracle | GraalVM CE     | amd64             |
-| java11           | 11           | Ubuntu | Hotspot        | amd64,arm64,armv7 |
-| java11-jdk       | 11           | Ubuntu | Hotspot+JDK    | amd64,arm64,armv7 |
-| java11-openj9    | 11           | Debian | OpenJ9         | amd64             |
-| java17           | 17           | Ubuntu | Hotspot        | amd64,arm64,armv7 |
-| java17-jdk       | 17           | Ubuntu | Hotspot+JDK    | amd64,arm64,armv7 |
-| java17-openj9    | 17           | Debian | OpenJ9         | amd64             |
-| java17-graalvm   | 17           | Oracle | Oracle GraalVM | amd64,arm64       |   
-| java17-alpine    | 17           | Alpine | Hotspot        | amd64             |
-| java21-alpine    | 21           | Alpine | Hotspot        | amd64             |
-| java21           | 21           | Ubuntu | Hotspot        | amd64,arm64       |
-| java21-graalvm   | 21           | Oracle | Oracle GraalVM | amd64,arm64       |   
+| Tag              | Java version | Linux  | JVM Type           | Architecture        |
+|------------------|--------------|--------|--------------------|---------------------|
+| latest           | 21           | Ubuntu | Hotspot            | amd64, arm64        |
+| stable           | 21           | Ubuntu | Hotspot            | amd64, arm64        |
+| java23           | 23           | Ubuntu | Hotspot            | amd64, arm64        |
+| java23-graalvm   | 23           | Oracle | Oracle GraalVM[^1] | amd64, arm64        |   
+| java21           | 21           | Ubuntu | Hotspot            | amd64, arm64        |
+| java21-jdk       | 21           | Ubuntu | Hotspot+JDK        | amd64, arm64        |
+| java21-alpine    | 21           | Alpine | Hotspot            | amd64, arm64        |
+| java21-graalvm   | 21           | Oracle | Oracle GraalVM[^1] | amd64, arm64        |   
+| java17           | 17           | Ubuntu | Hotspot            | amd64, arm64, armv7 |
+| java17-graalvm   | 17           | Oracle | Oracle GraalVM[^1] | amd64, arm64        |   
+| java17-alpine    | 17           | Alpine | Hotspot            | amd64  (1)          |
+| java11           | 11           | Ubuntu | Hotspot            | amd64, arm64, armv7 |
+| java8            | 8            | Ubuntu | Hotspot            | amd64, arm64, armv7 |
+| java8-jdk        | 8            | Ubuntu | Hotspot+JDK        | amd64               |
+| java8-openj9     | 8            | Debian | OpenJ9             | amd64               |
+| java8-graalvm-ce | 8            | Oracle | GraalVM CE         | amd64               |
 
-For example, to use Java version 8 on any supported architecture:
+1. Why no arm64 for Java 17 Alpine? That is because the base images, such as [elipse-temurin](https://hub.docker.com/_/eclipse-temurin/tags?page=&page_size=&ordering=&name=17-jre-alpine) do not provide support for that. Use the Ubuntu based images instead.
 
-    docker run --name mc itzg/minecraft-server:java8-multiarch
+!!! example "Example using java8"
 
-!!! note
-
-    Keep in mind that some versions of Minecraft server, such as Forge before 1.17, can't work on the newest versions of Java. Instead, one of the Java 8 images should be used. Also, FORGE doesn't support openj9 JVM implementation.
+    With docker run command-line
     
-    Some versions of vanilla Minecraft, such as 1.10, also do not run correctly with Java 17. If in doubt, use `java8-multiarch` for any version less than 1.17.
+    ```
+    docker run -it -e EULA=true itzg/minecraft-server:java8
+    ```
+    
+    or in a compose file
+    
+    ```yaml
+    services:
+      mc:
+        image: itzg/minecraft-server:java8
+    ```
 
-### Deprecated Image Tags
+!!! note "Latest"
+
+    The "latest" tag shifts to include not only the latest features and bug fixes, but also the latest Java version that Mojang requires for the latest Minecraft version.
+
+!!! tip "Class File Version"
+
+    If the Minecraft startup is logging an error about a "class file version", then refer [to this table](https://javaalmanac.io/bytecode/versions/) to identify the JDK/Java version corresponding to each class file version.
+
+### Release versions
+
+Since the tags referenced above will shift as the newest image build brings in new features and bug fixes, released variants of those can also be used to pin a specific build of the image.
+
+The syntax of released image tags is:
+
+    itzg/minecraft-server:<release>-<java tag>
+
+where `java tag` still refers to the first column of the table above and `release` refers to [one of the image releases](https://github.com/itzg/docker-minecraft-server/releases).
+
+!!! example
+
+    For example, the 2024.4.0 release of the Java 17 image would be
+    
+    ```
+    itzg/minecraft-server:2024.4.0-java17
+    ```
+
+### Stable image tag
+
+The `stable` image tag combines the benefits of `latest` and [release versions](#release-versions) since it shifts to refer to the most recently released version.
+
+## Version compatibilities
+
+[This section in the Minecraft wiki](https://minecraft.wiki/w/Tutorials/Update_Java#Why_update?) lists out versions of **vanilla** Minecraft versions and the corresponding Java version that is required.
+
+### Class file version 65.0
+
+If encountering a startup failure similar to the following examples, then ensure that the latest image has been re-pulled to use a Java 21. Alternatively, set the image tag specifically to `itzg/minecraft-server:java21`.
+
+> Exception in thread "ServerMain" java.lang.UnsupportedClassVersionError: org/bukkit/craftbukkit/Main has been compiled by a more recent version of the Java Runtime (class file version 65.0), this version of the Java Runtime only recognizes class file versions up to 61.0
+
+or
+
+> Error: LinkageError occurred while loading main class net.minecraft.bundler.Main
+java.lang.UnsupportedClassVersionError: net/minecraft/bundler/Main has been compiled by a more recent version of the Java Runtime (class file version 65.0), this version of the Java Runtime only recognizes class file versions up to 61.0
+
+
+### Forge versions
+
+Forge and its mods sometimes utilize non-public APIs of the JVM and as such are suspceptible to becoming broken with newer Java versions.
+
+#### Java 21
+
+Some mods even up to Minecraft 1.21 require Java 17 and will not run on the latest Java version. If you see an error like the following then be sure to explicitly use a Java 17 tagged image:
+
+```
+Caused by: org.spongepowered.asm.mixin.throwables.ClassMetadataNotFoundException: java.util.List
+	at MC-BOOTSTRAP/org.spongepowered.mixin/org.spongepowered.asm.mixin.transformer.MixinPreProcessorStandard.transformMethod(MixinPreProcessorStandard.java:754)
+```
+
+#### Java 8
+
+For Forge versions less than 1.18, you _must_ use the `java8-multiarch` (or other java8) image tag.
+
+In general, if you see the following line in a server startup failure, then it means you need to be using Java 8 instead of the latest image Java version:
+
+```
+Caused by: java.lang.ClassCastException: class jdk.internal.loader.ClassLoaders$AppClassLoader 
+   cannot be cast to class java.net.URLClassLoader
+```
+
+Forge also doesn't support openj9 JVM implementation.
+
+## Deprecated Image Tags
 
 The following image tags have been deprecated and are no longer receiving updates:
+
 - java19
 - adopt13
 - adopt14
@@ -55,4 +131,9 @@ The following image tags have been deprecated and are no longer receiving update
 - multiarch-latest
 - java16/java16-openj9
 - java17-graalvm-ce
+- java17-openj9
 - java20-graalvm, java20, java20-alpine
+- java8-multiarch is still built and pushed, but please move to java8 instead
+- java8-alpine
+
+[^1]: Based on the [Oracle GraalMV images](https://blogs.oracle.com/java/post/new-oracle-graalvm-container-images), which as of JDK 17, are now under the [GraalVM Free License](https://blogs.oracle.com/java/post/graalvm-free-license) incorporating what used to be known as the GraalVM Enterprise. 

examples/aof7/docker-compose.yml

@@ -3,8 +3,11 @@ services:
     image: itzg/minecraft-server
     environment:
       EULA: true
-      MOD_PLATFORM: AUTO_CURSEFORGE
-      # from .env
+      MODPACK_PLATFORM: AUTO_CURSEFORGE
+      # Allocate API key from https://console.curseforge.com/
+      # and set in .env file making sure to double up dollar signs, such as
+      # CF_API_KEY=$$2a$$10$$....
+      # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
       CF_API_KEY: ${CF_API_KEY}
       CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-of-fabric-7
 #      CF_FILENAME_MATCHER: 1.2.2
@@ -16,21 +19,6 @@ services:
       - "25565:25565"
     volumes:
       - mc-data:/data
-      - ./downloads:/downloads
-      # Manually download the following and put into the 'downloads' directory next to this compose file
-      #
-      #  Mod                          Filename                                   Download page
-      #  ===========================  =========================================  ====================================================================================
-      #  Fish of Thieves              [Fabric 1.20.1] Fish of Thieves v3.0.3     https://www.curseforge.com/minecraft/mc-mods/fish-of-thieves/files/4958329
-      #  Only Hammers [FORGE/FABRIC]  OnlyHammers-1.20.1-0.6-Fabric              https://www.curseforge.com/minecraft/mc-mods/only-hammers-forge-fabric/files/4832068
-      #  Sprinklerz                   sprinklerz-0.5_fabric.jar                  https://www.curseforge.com/minecraft/mc-mods/sprinklerz/files/4835664
-      #  Frog Legs (Fabric/Forge)     FrogLegs-v2.0.0-1.20.1-Fabric.jar          https://www.curseforge.com/minecraft/mc-mods/froglegs/files/4917818
-      #  TrimsEffects                 [FABRIC] TrimsEffects - MC 1.20.X - 1.1.0  https://www.curseforge.com/minecraft/mc-mods/trimseffects/files/4954156
-      #  Display Case                 Display Case-fabric-1.20-1.0.8.jar         https://www.curseforge.com/minecraft/mc-mods/displaycase/files/4921333
-      #  Structory: Towers            Structory Towers 1.20.4 v1.0.6             https://www.curseforge.com/minecraft/mc-mods/structory-towers/files/4937875
-      #  Packet Fixer                 Packet Fixer Fabric 1.2.1                  https://www.curseforge.com/minecraft/mc-mods/packet-fixer/files/4884316
-      #  Perfect Plushies             Perfect Plushies 1.9.0 [Fabric]            https://www.curseforge.com/minecraft/mc-mods/perfect-plushies/files/4985767
-      #  Structory                    Structory 1.20.2 v1.3.4                    https://www.curseforge.com/minecraft/mc-mods/structory/files/4937872
 
 volumes:
   mc-data: {}

examples/atm10/docker-compose.yml

@@ -0,0 +1,28 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    tty: true
+    stdin_open: true
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: true
+      MOD_PLATFORM: AUTO_CURSEFORGE
+      # Allocate API key from https://console.curseforge.com/
+      # and set in .env file making sure to double up dollar signs, such as
+      # CF_API_KEY=$$2a$$10$$....
+      # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
+      CF_API_KEY: ${CF_API_KEY}
+      CF_SLUG: all-the-mods-10
+      # Optional: select a specific version/file
+      # CF_FILENAME_MATCHER: "1.17"
+      MEMORY: 4G
+      CF_OVERRIDES_EXCLUSIONS: |
+        shaderpacks/**
+    volumes:
+      # Use managed volume by default, but can change to a relative path like
+      # ./data:/data
+      # to use a host directory
+      - mc-data:/data
+volumes:
+  mc-data:

examples/atm8/docker-compose.yml

@@ -1,21 +1,21 @@
-version: "3.8"
-
 services:
   mc:
-    image: itzg/minecraft-server
+    image: itzg/minecraft-server:java17
     ports:
       - "25565:25565"
     environment:
       EULA: "true"
-      MOD_PLATFORM: AUTO_CURSEFORGE
-      # allocate from https://console.curseforge.com/ and set in .env file
+      MODPACK_PLATFORM: AUTO_CURSEFORGE
+      # Allocate API key from https://console.curseforge.com/
+      # and set in .env file making sure to double up dollar signs, such as
+      # CF_API_KEY=$$2a$$10$$....
+      # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
       CF_API_KEY: ${CF_API_KEY}
       CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-the-mods-8
-      CF_FILENAME_MATCHER: "1.0.6"
+#      CF_FILENAME_MATCHER: "1.1.0"
       MEMORY: 4G
     volumes:
       - mc-data:/data
-      - ../downloads:/downloads
   # Since Docker's default volume driver creates volumes owned by root, this
   # init container will change ownership to match final UID of mc service, above
   init-filebrowser:

examples/atm9/docker-compose.yml

@@ -1,5 +1,3 @@
-version: "3.8"
-
 services:
   mc:
     image: itzg/minecraft-server
@@ -7,8 +5,11 @@ services:
       - "25565:25565"
     environment:
       EULA: "true"
-      MOD_PLATFORM: AUTO_CURSEFORGE
-      # allocate from https://console.curseforge.com/ and set in .env file
+      MODPACK_PLATFORM: AUTO_CURSEFORGE
+      # Allocate API key from https://console.curseforge.com/
+      # and set in .env file making sure to double up dollar signs, such as
+      # CF_API_KEY=$$2a$$10$$....
+      # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
       CF_API_KEY: ${CF_API_KEY}
       CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-the-mods-9
       # Optional: select a specific version/file
@@ -16,7 +17,6 @@ services:
       MEMORY: 4G
     volumes:
       - mc-data:/data
-      - ./downloads:/downloads
 
 volumes:
   mc-data: {}

examples/auto-cf/modpack-manifest/docker-compose.yml

@@ -3,8 +3,11 @@ services:
     image: itzg/minecraft-server
     environment:
       EULA: true
-      MOD_PLATFORM: AUTO_CURSEFORGE
-      # allocate from https://console.curseforge.com/ and set in .env file
+      MODPACK_PLATFORM: AUTO_CURSEFORGE
+      # Allocate API key from https://console.curseforge.com/
+      # and set in .env file making sure to double up dollar signs, such as
+      # CF_API_KEY=$$2a$$10$$....
+      # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
       CF_API_KEY: ${CF_API_KEY}
       CF_MODPACK_MANIFEST: /manifests/manifest.json
       CF_SLUG: "custom"

examples/auto-cf/using-excludes/docker-compose.yml

@@ -1,51 +1,20 @@
-version: "3.8"
-
 services:
   mc:
-    image: itzg/minecraft-server:java8-multiarch
+    image: itzg/minecraft-server:java8
     ports:
       - "25565:25565"
     environment:
       EULA: "true"
-      MOD_PLATFORM: AUTO_CURSEFORGE
-      # allocate from https://console.curseforge.com/ and set in .env file
+      MODPACK_PLATFORM: AUTO_CURSEFORGE
+      # Allocate API key from https://console.curseforge.com/
+      # and set in .env file making sure to double up dollar signs, such as
+      # CF_API_KEY=$$2a$$10$$....
+      # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
       CF_API_KEY: ${CF_API_KEY}
       CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/minecraft-eternal/files/4102634
-      CF_EXCLUDE_MODS: |
-        cherished-worlds
-        controlling
-        ctm
-        custom-main-menu
-        ding
-        minecraft-rich-presence
-        enchantment-descriptions
-        just-enough-harvestcraft
-        just-enough-resources-jer
-        menumobs
-        more-overlays
-        mouse-tweaks
-        oldjavawarning
-        overloaded-armor-bar
-        reauth
-        thaumic-jei
-        tips
-        armor-toughness-bar
-        waila-harvestability
-        ambientsounds
-        biomeinfo
-        block-drops-jei-addon
-        loot-capacitor-tooltips
-        no-recipe-book
-        packmodemenu
-        resource-reloader
-
-#        blockdrops
-
-      CF_FORCE_SYNCHRONIZE: "true"
       MEMORY: 4G
     volumes:
       - mc-data:/data
-      - ./downloads:/downloads
 
 volumes:
   mc-data: {}

examples/autopause/compose.yml

@@ -1,5 +1,3 @@
-version: '3.8'
-
 services:
   minecraft:
     image: itzg/minecraft-server
@@ -9,8 +7,8 @@ services:
       - "mc:/data"
     environment:
       EULA: "TRUE"
+      TYPE: PAPER
       ENABLE_AUTOPAUSE: "TRUE"
-      OVERRIDE_SERVER_PROPERTIES: "TRUE"
       MAX_TICK_TIME: "-1"
       # More aggressive settings for demo purposes
       AUTOPAUSE_TIMEOUT_INIT: "30"

examples/bettermc/docker-compose.yml

@@ -1,19 +1,19 @@
-version: "3.8"
-
 services:
   mc:
     image: itzg/minecraft-server
     environment:
       EULA: true
-      MOD_PLATFORM: AUTO_CURSEFORGE
-      # Set CF_API_KEY=... in a .env file next to this compose file and don't source control that file
+      MODPACK_PLATFORM: AUTO_CURSEFORGE
+      # Allocate API key from https://console.curseforge.com/
+      # and set in .env file making sure to double up dollar signs, such as
+      # CF_API_KEY=$$2a$$10$$....
+      # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
       CF_API_KEY: ${CF_API_KEY}
       CF_SLUG: better-mc-fabric-bmc1
-      CF_FILENAME_MATCHER: v18.5
+#      CF_FILENAME_MATCHER: v18.5
       MEMORY: 4G
     volumes:
       - mc:/data
-      - ../downloads:/downloads
     ports:
       - "25565:25565"
 

examples/bmc4/docker-compose.yml

@@ -0,0 +1,20 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: true
+      MODPACK_PLATFORM: MODRINTH
+      MODRINTH_MODPACK: https://modrinth.com/modpack/better-mc-forge-bmc4/version/v32.5
+      MODRINTH_EXCLUDE_FILES: |
+        XaeroPlus
+        XaerosWorldMap
+      MODRINTH_OVERRIDES_EXCLUSIONS: |
+        mods/citresewn-*.jar
+        **/datapacks/BE_default_endgen_fix*
+      MODRINTH_FORCE_SYNCHRONIZE: true
+      MEMORY: 4G
+    ports:
+      - "25565:25565"
+    # declare /data volume mapping as desired
+#    volumes:
+#      - ./data:/data

examples/canyon/compose.yml

@@ -0,0 +1,13 @@
+services:
+  mc:
+    image: itzg/minecraft-server:java8
+    environment:
+      EULA: true
+      TYPE: canyon
+      VERSION: b1.7.3
+    ports:
+      - "25565:25565"
+    volumes:
+      - mc-data:/data
+volumes:
+  mc-data:

examples/cleanroom/compose.yml

@@ -0,0 +1,15 @@
+# Provides an example of running CleanroomMC from https://github.com/CleanroomMC/Cleanroom,
+# which is a Forge fork
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: true
+      TYPE: FORGE
+      FORGE_INSTALLER_URL: https://github.com/CleanroomMC/Cleanroom/releases/download/0.2.4-alpha/cleanroom-0.2.4-alpha-installer.jar
+    ports:
+      - "25565:25565"
+    volumes:
+      - mc-data:/data
+volumes:
+  mc-data:

examples/craftoria/docker-compose.yml

@@ -0,0 +1,38 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    tty: true
+    stdin_open: true
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: true
+      ALLOW_FLIGHT: true
+      MOD_PLATFORM: AUTO_CURSEFORGE
+      # Allocate API key from https://console.curseforge.com/
+      # and set in .env file making sure to double up dollar signs, such as
+      # CF_API_KEY=$$2a$$10$$....
+      # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
+      CF_API_KEY: ${CF_API_KEY}
+      CF_SLUG: craftoria
+      MEMORY: 8G
+      # TODO: replace with slugs and see if already excluded by cf-exclude-include.json
+      CF_EXCLUDE_MODS: |
+        737481
+        363363
+        394468
+        986380
+        844662
+        568563
+        915902
+        690971
+        455508
+        1089803
+        511319
+    volumes:
+      # Use managed volume by default, but can change to a relative path like
+      # ./data:/data
+      # to use a host directory
+      - mc-data:/data
+volumes:
+  mc-data:

examples/curseforge-files/docker-compose.yml

@@ -1,12 +1,13 @@
-version: "3.8"
-
 services:
   mc:
     image: itzg/minecraft-server
     environment:
       EULA: true
       TYPE: FORGE
-      # allocate from https://console.curseforge.com/ and set in .env file
+      # Allocate API key from https://console.curseforge.com/
+      # and set in .env file making sure to double up dollar signs, such as
+      # CF_API_KEY=$$2a$$10$$....
+      # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
       CF_API_KEY: ${CF_API_KEY}
       VERSION: 1.19.2
       CURSEFORGE_FILES: |

examples/docker-compose-autostop.yml

@@ -1,5 +1,3 @@
-version: '3.8'
-
 services:
   minecraft:
     image: itzg/minecraft-server

examples/docker-compose-big.yml

@@ -1,5 +1,3 @@
-version: '3.8'
-
 services:
   minecraft:
     ports:

examples/docker-compose-curseforge-atm7.yaml

@@ -1,5 +1,3 @@
-version: '3.8'
-
 ####################################################################
 #                         CURSEFORGE                               #
 #                                                                  #

examples/docker-compose-curseforge.yml

@@ -1,5 +1,3 @@
-version: '3.8'
-
 services:
   mc:
     image: itzg/minecraft-server:${IMAGE_TAG:-java8}

examples/docker-compose-forge-bettermcplus

@@ -1,5 +1,3 @@
-version: '3.8'
-
 ####################################################################
 #                       FORGE_GENERIC_PACK                         #
 #                                                                  #

examples/docker-compose-forge.yml

@@ -1,5 +1,3 @@
-version: "3.8"
-
 services:
   mc:
     image: itzg/minecraft-server

examples/docker-compose-generic-pack-tnp5.yml

@@ -1,5 +1,3 @@
-version: '3.8'
-
 ####################################################################
 #                         FORGE GENERIC_PACK                       #
 #                                                                  #

examples/docker-compose-generic-pack.yml

@@ -1,5 +1,3 @@
-version: '3.8'
-
 services:
   mc:
     image: itzg/minecraft-server:${IMAGE_TAG:-latest}

examples/docker-compose-magma.yml

@@ -1,5 +1,3 @@
-version: "3.8"
-
 services:
   mc:
     image: itzg/minecraft-server:java8

examples/docker-compose-modrinth.yml

@@ -1,5 +1,3 @@
-version: "3.8"
-
 services:
   mc:
     image: itzg/minecraft-server

examples/docker-compose-mods-mount.yml

@@ -1,10 +1,8 @@
-version: '3.8'
-
 services:
   minecraft:
     image: itzg/minecraft-server
     volumes:
-      - data:/data
+      - ./data:/data
       - ./mods:/mods
     ports:
       - "25565:25565"
@@ -12,10 +10,5 @@ services:
       EULA: "true"
       TYPE: "FORGE"
       VERSION: "1.19.2"
-      DEBUG: "true"
-      SETUP_ONLY: "true"
-    tty: True
-    stdin_open: True
-
-volumes:
-  data: {}
+    tty: true
+    stdin_open: true

examples/docker-compose-mohist.yml

@@ -1,5 +1,3 @@
-version: "3.8"
-
 services:
   mc:
     image: itzg/minecraft-server

examples/docker-compose-ngrok.yml

@@ -1,5 +1,3 @@
-version: "3.8"
-
 services:
   mc:
     image: itzg/minecraft-server
@@ -15,8 +13,11 @@ services:
       - ./data:/data
 
   ngrok:
-    image: shkoliar/ngrok:latest
-    ports:
-      - 4551:4551
+    image: ngrok/ngrok:latest
+    command:
+      - "tcp"
+      - "mc:25565"
     environment:
-      - PARAMS=tcp -region=us -authtoken=YourAuthTokenHere mc:25565
+      NGROK_AUTHTOKEN: <YourAuthTokenHere>
+    ports:
+      - 4551:4551

examples/docker-compose-paper.yml

@@ -1,4 +1,3 @@
-version: '3.8'
 services:
   mc:
     image: itzg/minecraft-server

examples/docker-compose-proxied.yml

@@ -1,5 +1,3 @@
-version: '3.8'
-
 services:
   mc:
 #    build: .

examples/docker-compose-rconcmd.yml

@@ -1,5 +1,3 @@
-version: '3'
-
 services:
   minecraft:
     image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
@@ -14,7 +12,10 @@ services:
       CURSEFORGE_FILES: |
         fabric-api
         chunky-pregenerator
-      # allocate from https://console.curseforge.com/ and set in .env file
+      # Allocate API key from https://console.curseforge.com/
+      # and set in .env file making sure to double up dollar signs, such as
+      # CF_API_KEY=$$2a$$10$$....
+      # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
       CF_API_KEY: ${CF_API_KEY}
       # YAML Heredoc, be sure to use '|-' this will remove the first newline and final new line.
       # This is versus '|' that will leaving with two empty strings at top and bottom.

examples/docker-compose-rlcraft.yml

@@ -1,5 +1,3 @@
-version: '3.8'
-
 services:
   mc:
     image: itzg/minecraft-server:java8

examples/docker-compose-simple.yml

@@ -1,5 +1,3 @@
-version: "3.8"
-
 services:
   mc:
     image: itzg/minecraft-server

examples/docker-compose-spongeforge.yml

@@ -1,4 +1,3 @@
-version: '3.8'
 # Forge with Sponge API support. THIS REQUIRES DOWNLOADING SPONGEFORGE.
 # Place the SpongeForge jar file in /data/mods. Other Forge mods go here as well.
 # Place Sponge mods in /data/mods/plugins. Yes, this is a directory inside the Forge mod directory. Do NOT use /data/plugins.

examples/docker-compose-tailscale.yml

@@ -0,0 +1,35 @@
+services:
+  tailscale-client:
+    image: tailscale/tailscale:latest
+    container_name: tailscale
+    hostname: tailscale-minecraft # This name will be the one on the tailscale network
+    environment:
+      TS_AUTHKEY: "tskey-auth-PLACE-YOUR-KEY-HERE"
+      TS_STATE_DIR: "/var/lib/tailscale"
+      TS_USERSPACE: "FALSE" # If not using Auto-pause it can be set as true
+    volumes:
+      - ./ts-minecraft/state:/var/lib/tailscale
+      - /dev/net/tun:/dev/net/tun
+    cap_add:
+      - net_admin
+      - sys_module
+    restart: unless-stopped
+    # ports: # Not needed, tailscale is directly linking to the container.
+      # - "25565:25565"
+  minecraft-server:
+    image: itzg/minecraft-server
+    network_mode: container:tailscale
+    stdin_open: true
+    tty: true
+    environment:
+      EULA: "TRUE"
+      # ENABLE_AUTOPAUSE: "TRUE"
+      # AUTOPAUSE_KNOCK_INTERFACE: "tailscale0"
+      # MAX_TICK_TIME: "-1"
+    volumes:
+      - minecraftserver:/data
+    restart: unless-stopped
+
+    
+volumes:
+  minecraftserver:

examples/docker-compose-world-download.yml

@@ -1,5 +1,3 @@
-version: "3.8"
-
 services:
   mc:
     image: itzg/minecraft-server

examples/docker-compose.yml

@@ -1,16 +1,12 @@
-version: '3'
-# Other docker-compose examples in /examples
-
 services:
   minecraft:
     image: itzg/minecraft-server
+    stdin_open: true
+    tty: true
     ports:
       - "25565:25565"
     volumes:
-      - "mc:/data"
+      - ./data:/data
     environment:
       EULA: "TRUE"
-    restart: always
-
-volumes:
-  mc: {}
+    restart: unless-stopped

examples/fabric-cardboard/compose.yml

@@ -0,0 +1,20 @@
+services:
+  mc:
+    image: itzg/minecraft-server:latest
+    tty: true
+    stdin_open: true
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: "TRUE"
+      TYPE: "FABRIC"
+      MEMORY: 4G
+      MODRINTH_PROJECTS: |
+        fabric-api
+        cardboard:beta
+      USES_PLUGINS: true
+    volumes:
+      - mc-data:/data
+      - ./plugins:/plugins:ro
+volumes:
+  mc-data:

examples/fabric/compose.yml

@@ -1,11 +1,12 @@
-version: "3"
-
 services:
   mc:
     image: itzg/minecraft-server
     environment:
       EULA: "true"
       TYPE: FABRIC
+#      VERSION: 1.21.4
+#      FABRIC_INSTALLER_VERSION: 1.0.1
+#      FABRIC_LOADER_VERSION: 0.16.10
     ports:
       - "25565:25565"
     volumes:

examples/ftb-evolution/compose.yaml

@@ -0,0 +1,25 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    tty: true
+    stdin_open: true
+    ports:
+      # Game port
+      - "25565:25565/tcp"
+    environment:
+      EULA: "TRUE"
+      TYPE: AUTO_CURSEFORGE
+      # Allocate API key from https://console.curseforge.com/
+      # and set in .env file making sure to double up dollar signs, such as
+      # CF_API_KEY=$$2a$$10$$....
+      # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
+      CF_API_KEY: ${CF_API_KEY}
+      CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/ftb-evolution
+      # This modpack includes an override client-side only mod that will prevent the server from starting.
+      # For more information on override exclusions see: 
+      # https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#excluding-overrides-files
+      CF_OVERRIDES_EXCLUSIONS: mods/rgp_client*.jar
+      MEMORY: 6G
+    volumes:
+      # attach the relative directory 'data' to the container's /data path
+      - ./data:/data

examples/ftba/compose.yml

@@ -1,24 +1,21 @@
-version: "3.8"
-
 services:
   mc:
-    # FTBA support is only available in non-Alpine images
-    image: itzg/minecraft-server:${IMAGE_TAG:-java8-multiarch}
+    image: itzg/minecraft-server
     ports:
       # expose the Minecraft server port outside of container
-      - 25565:25565
+      - "25565:25565"
     environment:
       # REQUIRED for all types
       EULA: "TRUE"
       # Set server type (vs the default of vanilla)
       TYPE: FTBA
-      # Use Pack ID from https://ftb.neptunepowered.org/pack/ftb-presents-direwolf20-1-12/
-      FTB_MODPACK_ID: "31"
-      FTB_MODPACK_VERSION_ID: ""
+      # Use Pack ID from https://www.feed-the-beast.com/modpacks/119-ftb-presents-direwolf20-120?tab=about
+      FTB_MODPACK_ID: "119"
+#      FTB_MODPACK_VERSION_ID: ""
     volumes:
       # use a named, managed volume for data volume
-      - ftba:/data
+      - data:/data
 
 volumes:
   # declared the named volume, but use default/local storage engine
-  ftba: {}
+  data: {}

examples/geyser/docker-compose.yml

@@ -1,5 +1,3 @@
-version: "3.8"
-
 services:
   mc:
     image: itzg/minecraft-server

examples/gtnh/docker-compose.yaml

@@ -0,0 +1,25 @@
+services:
+  mc:
+    # make sure this java version matches with pack java version
+    image: itzg/minecraft-server:java21
+    tty: true
+    stdin_open: true
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: "TRUE"
+      TYPE: CUSTOM
+      GENERIC_PACKS: GT_New_Horizons_2.7.2_Server_Java_17-21
+      GENERIC_PACKS_SUFFIX: .zip
+      GENERIC_PACKS_PREFIX: https://downloads.gtnewhorizons.com/ServerPacks/
+      # if this isn't true, then the container tries to download the modpack every run
+      SKIP_GENERIC_PACK_UPDATE_CHECK: "true"
+      MEMORY: 6G
+      # Make sure that this matches what is in your pack's startserver bash file
+      JVM_OPTS: -Dfml.readTimeout=180 @java9args.txt
+      CUSTOM_JAR_EXEC: -jar lwjgl3ify-forgePatches.jar nogui
+    volumes:
+      # attach a managed volume, change to a relative or absolute host directory if needed
+      - mc-data:/data
+volumes:
+  mc-data:

examples/ketting/docker-compose.yml

@@ -0,0 +1,15 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: true
+      TYPE: KETTING
+      VERSION: 1.20.1
+      # Allocate API key from https://console.curseforge.com/
+      # and set in .env file making sure to double up dollar signs, such as
+      # CF_API_KEY=$$2a$$10$$....
+      # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
+      CF_API_KEY: "${CF_API_KEY}"
+      CURSEFORGE_FILES: https://www.curseforge.com/minecraft/mc-mods/aquaculture
+    ports:
+      - "25565:25565"

examples/lazymc/docker_compose.yml

@@ -0,0 +1,40 @@
+services:
+  lazymc:
+    container_name: lazymc
+    image: ghcr.io/joesturge/lazymc-docker-proxy:latest
+    environment:
+      # Point to the service name of the Minecraft server
+      SERVER_ADDRESS: mc:25565
+      # Required to find the container to manage it
+      LAZYMC_GROUP: mc
+    restart: unless-stopped
+    volumes:
+      # you should mount the minecraft server dir under /server, using read only.
+      - data:/server:ro
+      # you need to supply the docker socket, so that the container can run docker command
+      - /var/run/docker.sock:/var/run/docker.sock:ro
+    ports:
+      # lazymc-docker-proxy acts as a proxy, so there is
+      # no need to expose the server port on the Minecraft container
+      - "25565:25565"
+
+  # Standard Docker Minecraft server, also works with other server types
+  mc:
+    image: itzg/minecraft-server:java21
+    container_name: minecraft-server
+    # We need to add a label here so that lazymc-docker-proxy knows which
+    # container to manage
+    labels:
+      - lazymc.group=mc
+    tty: true
+    stdin_open: true
+    # This container should be managed solely by the lazymc container
+    # so set restart to no, or else the container will start again...
+    restart: no
+    environment:
+      EULA: "TRUE"
+    volumes:
+      - data:/data
+
+volumes:
+  data:

examples/lazytainer/docker_compose.yml

@@ -1,10 +1,8 @@
-version: "3"
 services:
   lazytainer:
-    container_name: lazytainer
     image: ghcr.io/vmorganp/lazytainer:master
     environment:
-      - VERBOSE=false
+      VERBOSE: false
     ports:
       - 25565:25565
     volumes:
@@ -19,13 +17,11 @@ services:
   mc:
     image: itzg/minecraft-server
     environment:
-      - EULA=TRUE
-      - TYPE=PURPUR
-      - MEMORY=4G
-      - TZ=Europe/Berlin
-      - OVERRIDE_SERVER_PROPERTIES=TRUE
+      EULA: TRUE
+      TYPE: PAPER
+      MEMORY: 4G
     volumes:
-      - /opt/container_volumes/minecraft/data:/data
+      - ./data:/data
     labels:
       - lazytainer.group=minecraft
     depends_on:
@@ -34,4 +30,3 @@ services:
     tty: true
     stdin_open: true
     restart: unless-stopped
-networks: {}

examples/modrinth-modpack/docker-compose.yml

@@ -1,5 +1,3 @@
-version: "3.8"
-
 services:
   mc:
     image: itzg/minecraft-server
@@ -9,7 +7,7 @@ services:
       - "25565:25565"
     environment:
       EULA: "TRUE"
-      MOD_PLATFORM: MODRINTH
+      MODPACK_PLATFORM: MODRINTH
       MODRINTH_MODPACK: https://modrinth.com/modpack/cobblemon-fabric/version/1.3.2
       # or for auto-upgrading to latest
       # MODRINTH_MODPACK: https://modrinth.com/modpack/cobblemon-fabric

examples/modrinth-paper/docker-compose.yml

@@ -1,5 +1,3 @@
-version: "3"
-
 services:
   mc:
     image: itzg/minecraft-server

examples/modrinth/local-modpack/docker-compose.yml

@@ -3,13 +3,15 @@ services:
     image: itzg/minecraft-server
     environment:
       EULA: true
-      MOD_PLATFORM: MODRINTH
+      MODPACK_PLATFORM: MODRINTH
       # Download the mrpack file from https://modrinth.com/modpack/cobblemon-fabric/version/1.4.1 and place in
       # modpacks directory next to this compose file.
       MODRINTH_MODPACK: /modpacks/Cobblemon Modpack [Fabric] 1.4.1.mrpack
+    ports:
+      -  "25565:25565"
     volumes:
       - mc-data:/data
       - ./modpacks:/modpacks:ro
 
 volumes:
-  mc-data: {}
+  mc-data: {}

examples/mods-file/docker-compose.yml

@@ -1,5 +1,3 @@
-version: '3.8'
-
 services:
   mc:
     image: itzg/minecraft-server

examples/multi-project/dbs/docker-compose.yml

@@ -1,5 +1,3 @@
-version: "3.8"
-
 services:
   mariadb:
     image: mariadb:10

examples/multi-project/servers/docker-compose.yml

@@ -1,8 +1,6 @@
-version: "3.8"
-
 services:
   proxy:
-    image: itzg/bungeecord
+    image: itzg/mc-proxy
     environment:
       TYPE: WATERFALL
     ports:
@@ -10,7 +8,16 @@ services:
     volumes:
       - waterfall:/server
       - ./waterfall-config:/config
-
+# If you want to use Velocity here is a premade version that supports Velocity
+#  velocity-proxy:
+#    image: itzg/mc-proxy
+#    environment:
+#      TYPE: VELOCITY
+#    ports:
+#      - "25565:25577"
+#    volumes:
+#      - velocity:/server
+#      - ./velocity-config:/config
   mc:
     image: itzg/minecraft-server
     environment:
@@ -38,4 +45,4 @@ networks:
   dbs:
     # declared in ../dbs
     external: true
-    name: dbs_default
+    name: dbs_default

examples/multi-project/servers/velocity-config/velocity.toml

@@ -0,0 +1,155 @@
+# Config version. Do not change this
+config-version = "2.6"
+
+# What port should the proxy be bound to? By default, we'll bind to all addresses on port 25565.
+bind = "0.0.0.0:25565"
+
+# What should be the MOTD? This gets displayed when the player adds your server to
+# their server list. Only MiniMessage format is accepted.
+motd = "<#09add3>A Velocity Server"
+
+# What should we display for the maximum number of players? (Velocity does not support a cap
+# on the number of players online.)
+show-max-players = 500
+
+# Should we authenticate players with Mojang? By default, this is on.
+online-mode = true
+
+# Should the proxy enforce the new public key security standard? By default, this is on.
+force-key-authentication = true
+
+# If client's ISP/AS sent from this proxy is different from the one from Mojang's
+# authentication server, the player is kicked. This disallows some VPN and proxy
+# connections but is a weak form of protection.
+prevent-client-proxy-connections = false
+
+# Should we forward IP addresses and other data to backend servers?
+# Available options:
+# - "none":        No forwarding will be done. All players will appear to be connecting
+#                  from the proxy and will have offline-mode UUIDs.
+# - "legacy":      Forward player IPs and UUIDs in a BungeeCord-compatible format. Use this
+#                  if you run servers using Minecraft 1.12 or lower.
+# - "bungeeguard": Forward player IPs and UUIDs in a format supported by the BungeeGuard
+#                  plugin. Use this if you run servers using Minecraft 1.12 or lower, and are
+#                  unable to implement network level firewalling (on a shared host).
+# - "modern":      Forward player IPs and UUIDs as part of the login process using
+#                  Velocity's native forwarding. Only applicable for Minecraft 1.13 or higher.
+player-info-forwarding-mode = "NONE"
+
+# If you are using modern or BungeeGuard IP forwarding, configure a file that contains a unique secret here.
+# The file is expected to be UTF-8 encoded and not empty.
+forwarding-secret-file = "forwarding.secret"
+
+# Announce whether or not your server supports Forge. If you run a modded server, we
+# suggest turning this on.
+# 
+# If your network runs one modpack consistently, consider using ping-passthrough = "mods"
+# instead for a nicer display in the server list.
+announce-forge = false
+
+# If enabled (default is false) and the proxy is in online mode, Velocity will kick
+# any existing player who is online if a duplicate connection attempt is made.
+kick-existing-players = false
+
+# Should Velocity pass server list ping requests to a backend server?
+# Available options:
+# - "disabled":    No pass-through will be done. The velocity.toml and server-icon.png
+#                  will determine the initial server list ping response.
+# - "mods":        Passes only the mod list from your backend server into the response.
+#                  The first server in your try list (or forced host) with a mod list will be
+#                  used. If no backend servers can be contacted, Velocity won't display any
+#                  mod information.
+# - "description": Uses the description and mod list from the backend server. The first
+#                  server in the try (or forced host) list that responds is used for the
+#                  description and mod list.
+# - "all":         Uses the backend server's response as the proxy response. The Velocity
+#                  configuration is used if no servers could be contacted.
+ping-passthrough = "DISABLED"
+
+# If not enabled (default is true) player IP addresses will be replaced by <ip address withheld> in logs
+enable-player-address-logging = true
+
+[servers]
+# Configure your servers here. Each key represents the server's name, and the value
+# represents the IP address of the server to connect to.
+lobby = "127.0.0.1:30066"
+factions = "127.0.0.1:30067"
+minigames = "127.0.0.1:30068"
+
+# In what order we should try servers when a player logs in or is kicked from a server.
+try = [
+    "lobby"
+]
+
+[forced-hosts]
+# Configure your forced hosts here.
+"lobby.example.com" = [
+    "lobby"
+]
+"factions.example.com" = [
+    "factions"
+]
+"minigames.example.com" = [
+    "minigames"
+]
+
+[advanced]
+# How large a Minecraft packet has to be before we compress it. Setting this to zero will
+# compress all packets, and setting it to -1 will disable compression entirely.
+compression-threshold = 256
+
+# How much compression should be done (from 0-9). The default is -1, which uses the
+# default level of 6.
+compression-level = -1
+
+# How fast (in milliseconds) are clients allowed to connect after the last connection? By
+# default, this is three seconds. Disable this by setting this to 0.
+login-ratelimit = 3000
+
+# Specify a custom timeout for connection timeouts here. The default is five seconds.
+connection-timeout = 5000
+
+# Specify a read timeout for connections here. The default is 30 seconds.
+read-timeout = 30000
+
+# Enables compatibility with HAProxy's PROXY protocol. If you don't know what this is for, then
+# don't enable it.
+haproxy-protocol = false
+
+# Enables TCP fast open support on the proxy. Requires the proxy to run on Linux.
+tcp-fast-open = false
+
+# Enables BungeeCord plugin messaging channel support on Velocity.
+bungee-plugin-message-channel = true
+
+# Shows ping requests to the proxy from clients.
+show-ping-requests = false
+
+# By default, Velocity will attempt to gracefully handle situations where the user unexpectedly
+# loses connection to the server without an explicit disconnect message by attempting to fall the
+# user back, except in the case of read timeouts. BungeeCord will disconnect the user instead. You
+# can disable this setting to use the BungeeCord behavior.
+failover-on-unexpected-server-disconnect = true
+
+# Declares the proxy commands to 1.13+ clients.
+announce-proxy-commands = true
+
+# Enables the logging of commands
+log-command-executions = false
+
+# Enables logging of player connections when connecting to the proxy, switching servers
+# and disconnecting from the proxy.
+log-player-connections = true
+
+[query]
+# Whether to enable responding to GameSpy 4 query responses or not.
+enabled = false
+
+# If query is enabled, on what port should the query protocol listen on?
+port = 25565
+
+# This is the map name that is reported to the query services.
+map = "Velocity"
+
+# Whether plugins should be shown in query response by default or not
+show-plugins = false