docs: add service annotation patching to example kustomization (#3020)

Co-authored-by: Geoff Bourne <itzgeoff@gmail.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:
@@ -20,20 +22,17 @@ jobs:
         variant:
           - java21-graalvm
           - java21
+          - java21-jdk
           - java21-alpine
           - java17
           - java17-graalvm
-          - java17-jdk
-          - java17-openj9
           - java17-alpine
           - java8
           - java8-graalvm-ce
-          - java8-multiarch
           - java8-openj9
           - java8-jdk
+          - java8-alpine
           - java11
-          - java11-openj9
-          - java11-jdk
         include:
         # JAVA 21:
           - variant: java21-graalvm
@@ -44,47 +43,39 @@ jobs:
             baseImage: eclipse-temurin:21-jre
             platforms: linux/amd64,linux/arm64
             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
+            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: latest
+            mcVersion: 1.20.4
           - variant: java17-graalvm
             baseImage: container-registry.oracle.com/graalvm/jdk:17-ol8
             platforms: linux/amd64,linux/arm64
-            mcVersion: latest
-          - variant: java17-jdk
-            baseImage: eclipse-temurin:17-focal
-            platforms: linux/amd64,linux/arm/v7,linux/arm64
-            mcVersion: latest
-          - variant: java17-openj9
-            baseImage: ibm-semeru-runtimes:open-17-jre
-            platforms: linux/amd64,linux/arm64
-            mcVersion: latest
+            mcVersion: 1.20.4
           - variant: java17-alpine
             baseImage: eclipse-temurin:17-jre-alpine
             platforms: linux/amd64
-            mcVersion: latest
+            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: eclipse-temurin:8u312-b07-jre-focal
+            platforms: linux/amd64,linux/arm/v7,linux/arm64
+            mcVersion: 1.12.2
+          - variant: java8-alpine
             baseImage: openjdk:8-jre-alpine3.9
             platforms: linux/amd64
             mcVersion: 1.12.2
@@ -92,10 +83,6 @@ jobs:
             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,13 +92,13 @@ 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.1.7
         with:
           # for build-files step
           fetch-depth: 0
@@ -136,6 +123,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 +133,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.4.0
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3.0.0
+        uses: docker/setup-qemu-action@v3.1.0
 
       - name: Build for test
-        uses: docker/build-push-action@v5.1.0
+        uses: docker/build-push-action@v6.4.1
         with:
           platforms: linux/amd64
           tags: ${{ env.IMAGE_TO_TEST }}
@@ -173,14 +162,14 @@ jobs:
           tests/test.sh
 
       - name: Login to DockerHub
-        uses: docker/login-action@v3.0.0
+        uses: docker/login-action@v3.2.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.2.0
         if: env.HAS_IMAGE_REPO_ACCESS
         with:
           registry: ghcr.io
@@ -188,7 +177,7 @@ jobs:
           password: ${{ github.token }}
 
       - name: Build and push
-        uses: docker/build-push-action@v5.1.0
+        uses: docker/build-push-action@v6.4.1
         if: github.actor == github.repository_owner
         with:
           platforms: ${{ matrix.platforms }}

.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: 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: latest
-          - variant: java17-alpine
-            baseImage: eclipse-temurin:17-jre-alpine
-            platforms: linux/amd64
-            mcVersion: latest
-          - 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.1.7
         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.4.0
 
       - name: Confirm multi-arch build
-        uses: docker/build-push-action@v5.1.0
+        uses: docker/build-push-action@v6.4.1
         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.4.1
         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,6 @@
 # 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 +9,12 @@ 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
+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 +23,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.7
 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.4
 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.6.7
 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.8
+ARG MC_MONITOR_VERSION=0.12.13
 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.2
 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.11
+ARG MC_HELPER_VERSION=1.39.9
 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

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/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,7 @@
 set -e
 set -o pipefail
 
+# Install necessary packages
 apk add --no-cache -U \
     openssl \
     imagemagick \
@@ -14,7 +15,8 @@ apk add --no-cache -U \
     procps \
     shadow \
     bash \
-    curl iputils \
+    curl \
+    iputils \
     git \
     jq \
     mysql-client \
@@ -29,8 +31,15 @@ apk add --no-cache -U \
     libwebp \
     libcap
 
-# 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,27 @@ 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
+dnf install -y \
+  ImageMagick \
   file \
   sudo \
   net-tools \
@@ -40,10 +46,26 @@ dnf install -y ImageMagick \
   findutils \
   which
 
+# 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,8 @@ export TARGET
 
 set -euo pipefail
 
+# Update and install packages
 apt-get update
-
 DEBIAN_FRONTEND=noninteractive \
 apt-get install -y \
   imagemagick \
@@ -26,14 +26,26 @@ apt-get install -y \
   zstd \
   lbzip2 \
   nfs-common \
-  libpcap0.8 \
-  webp
+  libpcap0.8
 
+# 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/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

@@ -66,7 +66,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/misc-options.md

@@ -55,6 +55,14 @@ 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.
 
+## 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
 
@@ -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

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

@@ -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:

docs/misc/autopause-autostop/autopause.md

@@ -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/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:
@@ -33,13 +32,11 @@ Monitors network traffic to the Minecraft containers. If there is traffic, the c
 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 +51,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 +64,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/mods-and-plugins/curseforge-files.md

@@ -47,3 +47,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

@@ -76,7 +76,7 @@ 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".
 
 ## Mods/plugins list
 
@@ -117,7 +117,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

@@ -26,5 +26,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,8 +1,7 @@
-mkdocs == 1.5.3
-mkdocs-material == 9.5.7
-mkdocs-autorefs == 0.5.0
-mkdocstrings == 0.24.0
+mkdocs-material == 9.5.29
+mkdocs-autorefs == 1.0.1
+mkdocstrings == 0.25.1
 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.2.3

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

@@ -207,12 +207,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/modrinth-modpacks.md

@@ -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/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://github.com/kettingpowered/Ketting-1-20-x/packages/2041866/versions](https://github.com/kettingpowered/Ketting-1-20-x/packages/2041866/versions).
+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,28 @@
-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
+
+    ```
+    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 ... 
+    ```
+
+!!! 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>`.
 

docs/variables.md

@@ -558,7 +558,7 @@ 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>

docs/versions/java.md

@@ -1,53 +1,127 @@
-## 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[^1] | 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[^1] | amd64,arm64       |   
+| Tag              | Java version | Linux  | JVM Type           | Architecture        |
+|------------------|--------------|--------|--------------------|---------------------|
+| latest           | 21           | Ubuntu | Hotspot            | amd64, arm64        |
+| stable           | 21           | Ubuntu | Hotspot            | 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-alpine     | 8            | Alpine | Hotspot            | amd64  (1)          |
+| 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
@@ -56,6 +130,8 @@ 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
 
 [^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

@@ -16,21 +16,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/atm8/docker-compose.yml

@@ -1,8 +1,6 @@
-version: "3.8"
-
 services:
   mc:
-    image: itzg/minecraft-server
+    image: itzg/minecraft-server:java17
     ports:
       - "25565:25565"
     environment:
@@ -11,11 +9,10 @@ services:
       # allocate from https://console.curseforge.com/ and set in .env file
       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
@@ -16,7 +14,6 @@ services:
       MEMORY: 4G
     volumes:
       - mc-data:/data
-      - ./downloads:/downloads
 
 volumes:
   mc-data: {}

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

@@ -1,8 +1,6 @@
-version: "3.8"
-
 services:
   mc:
-    image: itzg/minecraft-server:java8-multiarch
+    image: itzg/minecraft-server:java8
     ports:
       - "25565:25565"
     environment:
@@ -45,7 +43,6 @@ services:
       MEMORY: 4G
     volumes:
       - mc-data:/data
-      - ./downloads:/downloads
 
 volumes:
   mc-data: {}

examples/bettermc/docker-compose.yml

@@ -1,5 +1,3 @@
-version: "3.8"
-
 services:
   mc:
     image: itzg/minecraft-server
@@ -9,11 +7,10 @@ services:
       # Set CF_API_KEY=... in a .env file next to this compose file and don't source control that file
       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,22 @@
+services:
+  mc:
+    image: itzg/minecraft-server:java17
+    environment:
+      DEBUG: true
+      SETUP_ONLY: true
+      EULA: true
+      TYPE: MODRINTH
+      VERSION: 1.20.1
+      MEMORY: 4G
+      MODRINTH_MODPACK: better-mc-forge-bmc4
+      MODRINTH_VERSION: v28
+      MODRINTH_OVERRIDES_EXCLUSIONS: |
+        mods/NekosEnchantedBooks-*.jar
+        mods/citresewn-*.jar
+    volumes:
+      - data:/data
+    ports:
+      - "25565:25565"
+
+volumes:
+  data: {}

examples/curseforge-files/docker-compose.yml

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

examples/docker-compose-autopause.yml

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

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-fabric.yml

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

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-ftba.yml

@@ -1,5 +1,3 @@
-version: "3.8"
-
 services:
   mc:
     # FTBA support is only available in non-Alpine images

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

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}

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/geyser/docker-compose.yml

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

examples/ketting/docker-compose.yml

@@ -0,0 +1,11 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: true
+      TYPE: KETTING
+      VERSION: 1.20.1
+      CF_API_KEY: "${CF_API_KEY}"
+      CURSEFORGE_FILES: https://www.curseforge.com/minecraft/mc-mods/aquaculture
+    ports:
+      - "25565:25565"

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

examples/modrinth-paper/docker-compose.yml

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

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:
@@ -12,7 +10,7 @@ services:
       - ./waterfall-config:/config
 # If you want to use Velocity here is a premade version that supports Velocity
 #  velocity-proxy:
-#    image: itzg/bungeecord
+#    image: itzg/mc-proxy
 #    environment:
 #      TYPE: VELOCITY
 #    ports:

examples/multiline-motd/docker-compose.yml

@@ -0,0 +1,12 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: true
+      MOTD: |
+        line one
+        line two
+# or
+#      MOTD: "line one\nline two"
+    ports:
+      - "25565:25565"

examples/one-block-modded/docker-compose.yml

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

examples/paper-build-plugins/docker-compose.yml

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

examples/pixelmon/docker-compose.yml

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

examples/prominence2/docker-compose.yml

@@ -0,0 +1,18 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: "true"
+      MOD_PLATFORM: AUTO_CURSEFORGE
+      # allocate from https://console.curseforge.com/ and set in .env file
+      CF_API_KEY: ${CF_API_KEY}
+      CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/prominence-2-rpg
+      CF_FILENAME_MATCHER: "2.8.7"
+      MEMORY: 4G
+    volumes:
+      - mc-data:/data
+
+volumes:
+  mc-data: {}

examples/quilt/docker-compose.yml

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

examples/rad2/compose.yaml

@@ -0,0 +1,33 @@
+# This runs the most recent version of Roguelike Adventures and Dungeons 2. Version 1.11 as of writing.
+services:
+  mc:
+    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
+      CF_API_KEY: ${CF_API_KEY}
+      CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/roguelike-adventures-and-dungeons-2
+      # Optional: select a specific version/file
+      #CF_FILENAME_MATCHER: "0.2.34"
+      CF_EXCLUDE_MODS: |
+        controlling
+        craftpresence
+        creative-core
+        default-options
+        equipment-compare
+        item-borders
+        itemphysic-lite
+        konkrete
+        oauth
+        sound-filters
+        toast-control
+      CF_FORCE_SYNCHRONIZE: "true"
+      MEMORY: 4G
+    volumes:
+      - mc-data:/data
+
+volumes:
+  mc-data: {}

examples/rlcraft/docker-compose.yml

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

examples/skript/docker-compose.yml

@@ -0,0 +1,10 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: true
+      TYPE: PAPER
+      PLUGINS: https://github.com/SkriptLang/Skript/releases/download/2.8.4/Skript.jar
+      SPIGET_RESOURCES: 103749
+    ports:
+      - "25565:25565"

examples/spiget/docker-compose.yml

@@ -1,11 +1,8 @@
 # NOTE
-# This file is named spiget with an "e"
-# since it provides an example of the 
+# This file is purposely named spiget with an "e" since it provides an example of the
 # feature https://docker-minecraft-server.readthedocs.io/en/latest/mods-and-plugins/spiget/
 # which uses the Spiget API at https://spiget.org/
 
-version: "3"
-
 services:
   mc:
     image: itzg/minecraft-server
@@ -15,8 +12,6 @@ services:
       EULA: "TRUE"
       TYPE: PAPER
       SPIGET_RESOURCES: 34315,3836
+      REMOVE_OLD_MODS: true
     volumes:
-      - data:/data
-
-volumes:
-  data: {}
+      - ./data:/data

examples/spigot/docker-compose.yml

@@ -0,0 +1,13 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: true
+      TYPE: SPIGOT
+      VERSION: 1.20.4
+    ports:
+      - "25565:25565"
+    volumes:
+      - data:/data
+volumes:
+  data: {}

examples/valhelsia2/docker-compose.yml

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

examples/valhesia5/docker-compose.yml

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

examples/vanilla-tweaks/docker-compose.yml

@@ -1,5 +1,3 @@
-version: "3.3"
-
 services:
   vanillatweaks_file:
     restart: "no"

examples/vault-hunters-1-18-2/docker-compose.yml

@@ -1,5 +1,3 @@
-version: "3.8"
-
 services:
   mc:
     image: itzg/minecraft-server
@@ -18,10 +16,6 @@ services:
       ENABLE_COMMAND_BLOCK: true
       DIFFICULTY: hard
     volumes:
-      # Need to place non-distributable mods in ./downloads/mods
-      # As of Update-10.0.0
-      # - Neon Craft 2 v2.2: https://www.curseforge.com/minecraft/mc-mods/neon-craft-2-mod/files/3726051
-      - ./downloads:/downloads
       - mc-data:/data
 
 volumes:

files/auto/autopause-daemon.sh

@@ -45,7 +45,12 @@ if isTrue "${DEBUG_AUTOPAUSE}"; then
   knockdArgs+=(-D)
 fi
 
-sudo /usr/local/sbin/knockd "${knockdArgs[@]}"
+if isTrue "${SKIP_SUDO}"; then
+  /usr/local/sbin/knockd "${knockdArgs[@]}"
+else
+  sudo /usr/local/sbin/knockd "${knockdArgs[@]}"
+fi
+
 if [ $? -ne 0 ] ; then
   logAutopause "Failed to start knockd daemon."
   logAutopause "Probable cause: Unable to attach to interface \"$AUTOPAUSE_KNOCK_INTERFACE\"."
@@ -124,11 +129,7 @@ do
         STATE=E
       else
         TIME_THRESH=$(($(current_uptime)+$AUTOPAUSE_TIMEOUT_KN))
-        from=unknown
-        if [ -e /var/log/knocked-source ]; then
-          from=$(cat /var/log/knocked-source)
-        fi
-        logAutopause "Server was knocked from $from - waiting for clients or timeout"
+        logAutopause "Server was knocked - waiting for clients or timeout"
         STATE=K
       fi
     fi

files/auto/autopause-fcns.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+# shellcheck source=../scripts/start-utils
+. "${SCRIPTS:-/}start-utils"
 current_uptime() {
   awk '{print $1}' /proc/uptime | cut -d . -f 1
 }
@@ -16,14 +18,20 @@ rcon_client_exists() {
   [[ -n "$(ps -ax -o comm | grep 'rcon-cli')" ]]
 }
 
+use_proxy() {
+  if isTrue "$USES_PROXY_PROTOCOL"; then
+    echo "--use-proxy"
+  fi
+}
+
 mc_server_listening() {
-  mc-monitor status --host localhost --port "$SERVER_PORT" --timeout 10s >& /dev/null
+  mc-monitor status $(use_proxy) --host "${SERVER_HOST:-localhost}" --port "$SERVER_PORT" --timeout 10s >&/dev/null
 }
 
 java_clients_connections() {
   local connections
-  if java_running ; then
-    if ! connections=$(mc-monitor status --host localhost --port "$SERVER_PORT" --show-player-count); then
+  if java_running; then
+    if ! connections=$(mc-monitor status $(use_proxy) --host "${SERVER_HOST:-localhost}" --port "$SERVER_PORT" --show-player-count); then
       # consider it a non-zero player count if the ping fails
       # otherwise a laggy server with players connected could get paused
       connections=1

files/auto/resume.sh

@@ -6,8 +6,6 @@ if isTrue "${DEBUG_AUTOPAUSE}"; then
 fi
 
 if [[ $( ps -ax -o stat,comm | grep 'java' | awk '{ print $1 }') =~ ^T.*$ ]] ; then
-  logAutopauseAction "Knocked from $1, resuming Java process"
-  echo "$1" > /var/log/knocked-source
   pkill -CONT java
 
   # remove .paused file from data directory

files/cf-exclude-include.json

@@ -1,28 +1,66 @@
 {
   "globalExcludes": [
     "ambientsounds",
+    "auudio-forge",
+    "ambience-music-mod",
+    "appleskin",
+    "armor-chroma",
     "armor-toughness-bar",
+    "beehivetooltips",
+    "better-advancements",
+    "betterf3",
+    "betterfps",
+    "better-foliage",
+    "better-placement",
+    "better-sprinting",
+    "better-tips-nbt-tag",
+    "better-third-person",
     "biomeinfo",
     "block-drops-jei-addon",
+    "blur-forge",
     "cherished-worlds",
+    "chunk-animator",
+    "clickable-advancements",
+    "configured",
     "controlling",
     "ctm",
     "custom-main-menu",
     "defensive-measures",
     "ding",
+    "drippy-loading-screen",
     "dynamiclights-reforged",
+    "dynamic-surroundings",
+    "easiervillagertrading",
+    "effective-forge",
     "embeddium",
+    "embeddium-extension",
+    "embeddium-extras",
     "enchantment-descriptions",
+    "entity-collision-fps-fix",
     "entity-texture-features-fabric",
     "entityculling",
     "extreme-sound-muffler",
+    "ezzoom",
+    "fading-night-vision",
+    "falling-leaves-forge",
+    "fancymenu",
+    "faster-ladder-climbing",
+    "foamfix-optimization-mod",
+    "free-cam",
+    "ftb-backups-2",
+    "fullscreen-windowed-borderless-for-minecraft",
+    "hwyla",
     "ignitioncoil",
     "inmisaddon",
     "irisshaders",
     "iris-flywheel-compat",
+    "itemphysic-lite",
+    "item-obliterator",
+    "itemzoom",
     "just-enough-harvestcraft",
     "just-enough-resources-jer",
     "legendary-tooltips",
+    "lootbeams",
     "loot-capacitor-tooltips",
     "magnesium-extras",
     "menumobs",
@@ -32,6 +70,7 @@
     "neat",
     "nekos-enchanted-books",
     "no-recipe-book",
+    "no-nv-flash",
     "not-enough-animations",
     "oculus",
     "oldjavawarning",
@@ -41,13 +80,30 @@
     "resource-reloader",
     "rubidium",
     "rubidium-extra",
+    "ryoamiclights",
+    "schematica",
+    "searchables",
+    "shulkerboxviewer",
     "skin-layers-3d",
+    "smart-hud",
+    "smooth-font",
+    "smoothwater",
     "sodium",
+    "sound-filters",
+    "sound-physics-remastered",
+    "stellar-sky",
+    "swingthroughgrass",
+    "textrues-embeddium-options",
     "textrues-rubidium-options",
     "thaumic-jei",
     "tips",
     "torohealth-damage-indicators",
-    "waila-harvestability"
+    "true-darkness",
+    "ungrab-mouse-mod",
+    "vanillafix",
+    "visuality",
+    "waila-harvestability",
+    "zume"
   ],
   "modpacks": {
     "all-of-fabric-6": {
@@ -59,6 +115,11 @@
       "excludes": [
         "modernfix"
       ]
+    },
+    "create-arcane-engineering": {
+      "forceIncludes": [
+        "just-enough-resources-jer"
+      ]
     }
   }
 }

files/modrinth-exclude-include.json

@@ -0,0 +1,79 @@
+{
+  "globalExcludes": [
+    "3dskinlayers",
+    "ae2-emi-crafting",
+    "AmbientSounds",
+    "amecs",
+    "Animation_Overhaul",
+    "appleskin",
+    "auudio",
+    "axolotlbuckets",
+    "BadOptimizations",
+    "BetterAdvancements",
+    "betterbeds",
+    "BetterThirdPerson",
+    "BHMenu",
+    "blur",
+    "Boat-Item-View",
+    "bobby",
+    "cat_jam",
+    "chat_heads",
+    "chatanimation",
+    "cherishedworlds",
+    "citresewn",
+    "clickadv",
+    "connector",
+    "DisableCustomWorldsAdvice",
+    "drippyloadingscreen",
+    "eating-animation",
+    "emiffect",
+    "emitrades",
+    "entity_model_features",
+    "entity_texture_features",
+    "entityculling",
+    "euphoriapatcher",
+    "fallingleaves",
+    "fancymenu",
+    "fast-ip-ping",
+    "FauxCustomEntityData",
+    "GeckoLibIrisCompat",
+    "gpumemleakfix",
+    "Highlighter",
+    "ImmediatelyFast",
+    "indium",
+    "iris",
+    "iris-flywheel",
+    "ItemBorders",
+    "ItemLocks",
+    "language-reload",
+    "lazy-language-loader",
+    "LegendaryTooltips",
+    "loadmyresources",
+    "lootbeams",
+    "MindfulDarkness",
+    "MouseTweaks",
+    "nicer-skies",
+    "notenoughanimations",
+    "oculus",
+    "OverflowingBars",
+    "PickUpNotifier",
+    "PresenceFootsteps",
+    "Prism",
+    "reeses_sodium_options",
+    "ResourcePackOverrides",
+    "ryoamiclights",
+    "Searchables",
+    "seasonhud",
+    "ShoulderSurfing",
+    "skinlayers3d",
+    "sodium",
+    "sorted_enchantments",
+    "visuality",
+    "VR-Combat",
+    "YeetusExperimentus",
+    "yungsmenutweaks",
+    "Zoomify"
+  ],
+  "globalForceIncludes": [],
+  "modpacks": {}
+}

kustomize/README.md

@@ -13,10 +13,24 @@ configMapGenerator:
   - name: mc
     envs:
       - mc.env
+patches:
+  # Example of using a patch to set external service name for mc-router to pick up
+  - path: set-external-servername.yml
 ```
 
 ### mc.env
 ```
 EULA=true
 TYPE=FORGE
+```
+
+###
+
+```yaml
+apiVersion: v1
+kind: Service
+metadata:
+  name: mc
+  annotations:
+    mc-router.itzg.me/externalServerName: forge.example.com
 ```

mkdocs.yml

@@ -15,6 +15,27 @@ theme:
     - navigation.top
     - navigation.indexes
   locale: en
+  palette:
+
+    # Palette toggle for automatic mode
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
 
   highlightjs: true
   hljs_languages:

scripts/start-configuration

@@ -57,6 +57,9 @@ fi
 # Setup RCON password
 
 if isTrue "${ENABLE_RCON:-true}"; then
+  # turn off debug output
+  set +x
+
   if [[ -v RCON_PASSWORD_FILE ]]; then
     if [ ! -e "${RCON_PASSWORD_FILE}" ]; then
       log ""
@@ -78,11 +81,12 @@ if isTrue "${ENABLE_RCON:-true}"; then
   # For rcon-cli access running via exec, which by default is running as root
   echo "password=${RCON_PASSWORD}" > "$HOME/.rcon-cli.env"
   echo "password: \"${RCON_PASSWORD}\"" > "$HOME/.rcon-cli.yaml"
+
+  isDebugging && set -x
 else
   rm -f "$HOME/.rcon-cli.env" "$HOME/.rcon-cli.yaml"
 fi
 
-
 ##########################################
 # Auto-pause/stop
 
@@ -225,32 +229,26 @@ case "${TYPE^^}" in
   ;;
 
   CUSTOM)
-    evaluateJavaCompatibilityForForge
     exec "${SCRIPTS:-/}start-deployCustom" "$@"
   ;;
 
   MAGMA)
-    evaluateJavaCompatibilityForForge
     exec "${SCRIPTS:-/}start-deployMagma" "$@"
   ;;
 
   MAGMA_MAINTAINED)
-    evaluateJavaCompatibilityForForge
     exec "${SCRIPTS:-/}start-deployMagmaMaintained" "$@"
   ;;
 
   KETTING)
-    evaluateJavaCompatibilityForForge
     exec "${SCRIPTS:-/}start-deployKetting" "$@"
   ;;
 
   MOHIST)
-    evaluateJavaCompatibilityForForge
     exec "${SCRIPTS:-/}start-deployMohist" "$@"
   ;;
 
   CATSERVER)
-    evaluateJavaCompatibilityForForge
     exec "${SCRIPTS:-/}start-deployCatserver" "$@"
   ;;