cf: resolve remaining exclude/include slugs after first unknown mod (#3909)

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

.gitattributes

@@ -1,2 +0,0 @@
-# Auto detect text files and perform LF normalization
-* text=lf

.github/workflows/auto-release.yml

@@ -0,0 +1,15 @@
+name: Auto release
+on:
+  schedule:
+    - cron: "0 14 * * *"
+  workflow_dispatch:
+jobs:
+  auto-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: zenengeo/github-auto-release-action@main
+        with:
+          stable-duration: 3d
+          force-duration: 14d
+          token: '${{ secrets.GH_TOKEN }}'
+  

.github/workflows/build.yml

@@ -12,6 +12,11 @@ on:
       - "examples/**"
       - "notes/**"
       - "kustomize/**"
+      - "docker-compose.yml"
+      - "images.json"
+      - "compose-docs.yml"
+      - "zensical.toml"
+      - ".readthedocs.yaml"
 
 jobs:
   build:
@@ -20,24 +25,27 @@ jobs:
       matrix:
         # NOTE: the "latest" variant is identified in the Docker meta step's 'latest' config
         variant:
-          - java21-graalvm
+          - java25
+          - java25-jdk
           - java21
-          - java21-jdk
           - java21-alpine
+          - java21-jdk
           - java17
-          - java17-graalvm
-          - java17-alpine
-          - java8
-          - java8-graalvm-ce
-          - java8-openj9
-          - java8-jdk
+          - java16
           - java11
+          - java8
+          - java8-jdk
         include:
-        # JAVA 21:
-          - variant: java21-graalvm
-            baseImage: container-registry.oracle.com/graalvm/jdk:21-ol8
+        # JAVA 25
+          - variant: java25
+            baseImage: eclipse-temurin:25-jre
             platforms: linux/amd64,linux/arm64
             mcVersion: latest
+          - variant: java25-jdk
+            baseImage: eclipse-temurin:25
+            platforms: linux/amd64,linux/arm64
+            mcVersion: latest
+        # JAVA 21:
           - variant: java21
             baseImage: eclipse-temurin:21-jre
             platforms: linux/amd64,linux/arm64
@@ -56,51 +64,44 @@ jobs:
             baseImage: eclipse-temurin:17-jre-focal
             platforms: linux/amd64,linux/arm/v7,linux/arm64
             mcVersion: 1.20.4
-          - variant: java17-graalvm
-            baseImage: container-registry.oracle.com/graalvm/jdk:17-ol8
-            platforms: linux/amd64,linux/arm64
-            mcVersion: 1.20.4
-          - variant: java17-alpine
-            baseImage: eclipse-temurin:17-jre-alpine
-            platforms: linux/amd64
-            mcVersion: 1.20.4
-        # JAVA 11:
+        # JAVA 16
+          - variant: java16
+            baseImage: adoptopenjdk:16-jre-hotspot
+            platforms: linux/amd64,linux/arm/v7,linux/arm64
+            mcVersion: 1.16.5
+        # JAVA 11
           - variant: java11
             baseImage: adoptopenjdk:11-jre-hotspot
             platforms: linux/amd64,linux/arm/v7,linux/arm64
-            mcVersion: 1.16.5
+            mcVersion: 1.16.4
         # 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-graalvm-ce
-            baseImage: ghcr.io/graalvm/graalvm-ce:java8
-            platforms: linux/amd64
-            mcVersion: 1.12.2
+            # Pin version for Java 8
+            mcHelperVersion: 1.51.1
           - variant: java8-jdk
             baseImage: eclipse-temurin:8u312-b07-jdk-focal
             platforms: linux/amd64,linux/arm64
             mcVersion: 1.12.2
-          - variant: java8-openj9
-            baseImage: ibm-semeru-runtimes:open-8u312-b07-jre
-            platforms: linux/amd64,linux/arm64
-            mcVersion: 1.12.2
+            # Pin version for Java 8
+            mcHelperVersion: 1.51.1
     env:
       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: java21
+      MAIN_VARIANT: java25
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v4.2.2
+        uses: actions/checkout@v6.0.2
         with:
           # for build-files step
           fetch-depth: 0
 
       - name: Docker meta
         id: meta
-        uses: docker/metadata-action@v5.6.1
+        uses: docker/metadata-action@v5.10.0
         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.
@@ -108,16 +109,18 @@ jobs:
             ${{ github.repository_owner }}/minecraft-server
             ghcr.io/${{ github.repository_owner }}/minecraft-server
           tags: |
-            # For the "main" variant, it gets the tag as-is, without suffix
-            type=ref,event=tag,enable=${{ matrix.variant == env.MAIN_VARIANT }}
-            # and each variant (including main one) gets the tag with the variant suffix, such as 2023.1.1-java17
-            type=ref,event=tag,suffix=-${{ matrix.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 the "main" variant, it gets the tag as-is
+            type=pep440,pattern={{version}},enable=${{ matrix.variant == env.MAIN_VARIANT }}
+            # ...and all variants (including main one) get the tag with the variant suffix, such as 2023.1.1-java17
+            type=pep440,pattern={{version}},suffix=-${{ matrix.variant }}
+            # latest tag gets a moving 'stable' image tag applied to the main variant
+            type=pep440,pattern=stable,enable=${{ matrix.variant == env.MAIN_VARIANT }}
+            # ...and qualified stable for all variants
+            type=pep440,pattern=stable,suffix=-${{ matrix.variant }}
             # for building test/* branch images
             type=ref,event=branch,suffix=-${{ matrix.variant }},enable=${{ github.ref_name != github.event.repository.default_branch }}
-            # latest repo tag gets a moving 'stable' image tag applied to the main variant
-            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
@@ -128,13 +131,13 @@ jobs:
             org.opencontainers.image.authors=Geoff Bourne <itzgeoff@gmail.com>
 
       - name: Setup Docker Buildx
-        uses: docker/setup-buildx-action@v3.8.0
+        uses: docker/setup-buildx-action@v3.12.0
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3.3.0
+        uses: docker/setup-qemu-action@v3.7.0
 
       - name: Build for test
-        uses: docker/build-push-action@v6.12.0
+        uses: docker/build-push-action@v6.18.0
         with:
           platforms: linux/amd64
           tags: ${{ env.IMAGE_TO_TEST }}
@@ -145,6 +148,7 @@ jobs:
           push: false
           build-args: |
             BASE_IMAGE=${{ matrix.baseImage }}
+            ${{ matrix.mcHelperVersion && format('MC_HELPER_VERSION={0}', matrix.mcHelperVersion) }}
           cache-from: type=gha,scope=${{ matrix.variant }}
           # no cache-to to avoid cross-cache update from next build step
 
@@ -153,18 +157,19 @@ jobs:
           MINECRAFT_VERSION: ${{ matrix.mcVersion }}
           VARIANT: ${{ matrix.variant }}
           CF_API_KEY: ${{ secrets.CF_API_KEY }}
+          GH_TOKEN: ${{ github.token }}
         run: |
           tests/test.sh
 
       - name: Login to DockerHub
-        uses: docker/login-action@v3.3.0
+        uses: docker/login-action@v3.7.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.3.0
+        uses: docker/login-action@v3.7.0
         if: env.HAS_IMAGE_REPO_ACCESS
         with:
           registry: ghcr.io
@@ -172,7 +177,7 @@ jobs:
           password: ${{ github.token }}
 
       - name: Build and push
-        uses: docker/build-push-action@v6.12.0
+        uses: docker/build-push-action@v6.18.0
         if: github.actor == github.repository_owner
         with:
           platforms: ${{ matrix.platforms }}
@@ -196,5 +201,9 @@ jobs:
           build-args: |
             BASE_IMAGE=${{ matrix.baseImage }}
             BUILD_FILES_REV=${{ steps.build-files-rev.outputs.REV }}
+            BUILDTIME=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.created'] }}
+            VERSION=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.version'] }}
+            REVISION=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.revision'] }}
+            ${{ matrix.mcHelperVersion && format('MC_HELPER_VERSION={0}', matrix.mcHelperVersion) }}
           cache-from: type=gha,scope=${{ matrix.variant }}
           cache-to: type=gha,mode=max,scope=${{ matrix.variant }}

.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.16.2
+        uses: SethCohen/github-releases-to-discord@v1.19.0
         with:
           webhook_url: ${{ secrets.DISCORD_WEBHOOK }}
       - name: on-success

.github/workflows/stale-check.yml

@@ -12,7 +12,7 @@ jobs:
       pull-requests: write
     steps:
       - name: Process Stale Issues
-        uses: actions/stale@v9
+        uses: actions/stale@v10
         with:
           stale-issue-label: status/stale
           stale-pr-label: status/stale

.github/workflows/verify-pr.yml

@@ -1,16 +1,19 @@
 name: Verify PR
 on:
   pull_request:
-    branches: [ master ]
-    types: [assigned, opened, synchronize, labeled]
+    branches:
+      - master
     paths-ignore:
       - "*.md"
       - "docs/**"
       - "examples/**"
       - "notes/**"
       - "kustomize/**"
-      - "docker-compose*.yml"
-      - "mkdocs.yml"
+      - "docker-compose.yml"
+      - "images.json"
+      - "compose-docs.yml"
+      - "zensical.toml"
+      - ".readthedocs.yaml"
 
 jobs:
   build:
@@ -18,14 +21,14 @@ jobs:
       fail-fast: false
       matrix:
         variant:
-          - java21
+          - java25
           - java21-alpine
           - java17
           - java8
         include:
-        # JAVA 21:
-          - variant: java21
-            baseImage: eclipse-temurin:21-jre
+        # JAVA 21/25:
+          - variant: java25
+            baseImage: eclipse-temurin:25-jre
             platforms: linux/amd64,linux/arm64
             mcVersion: latest
           - variant: java21-alpine
@@ -42,31 +45,34 @@ jobs:
             baseImage: eclipse-temurin:8u312-b07-jre-focal
             platforms: linux/amd64
             mcVersion: 1.12.2
+            # Pin version for Java 8
+            mcHelperVersion: 1.51.1
     env:
       IMAGE_TO_TEST: ${{ github.repository_owner }}/minecraft-server:test-${{ matrix.variant }}-${{ github.run_id }}
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v4.2.2
+        uses: actions/checkout@v6.0.2
         with:
           # for build-files step
           fetch-depth: 0
 
       - name: Setup Docker Buildx
-        uses: docker/setup-buildx-action@v3.8.0
+        uses: docker/setup-buildx-action@v3.12.0
 
       - name: Confirm multi-arch build
-        uses: docker/build-push-action@v6.12.0
+        uses: docker/build-push-action@v6.18.0
         with:
           platforms: ${{ matrix.platforms }}
           # ensure latest base image is used
           pull: true
           build-args: |
             BASE_IMAGE=${{ matrix.baseImage }}
+            ${{ matrix.mcHelperVersion && format('MC_HELPER_VERSION={0}', matrix.mcHelperVersion) }}
           cache-from: type=gha,scope=${{ matrix.variant }}
 
       - name: Build for test
-        uses: docker/build-push-action@v6.12.0
+        uses: docker/build-push-action@v6.18.0
         with:
           # Only build single platform since loading multi-arch image into daemon fails with
           # "docker exporter does not currently support exporting manifest lists"
@@ -79,6 +85,7 @@ jobs:
           push: false
           build-args: |
             BASE_IMAGE=${{ matrix.baseImage }}
+            ${{ matrix.mcHelperVersion && format('MC_HELPER_VERSION={0}', matrix.mcHelperVersion) }}
           cache-from: type=gha,scope=${{ matrix.variant }}
 
       - name: Run tests
@@ -87,5 +94,6 @@ jobs:
           VARIANT: ${{ matrix.variant }}
           CF_API_KEY: ${{ secrets.CF_API_KEY }}
           DEBUG: ${{ runner.debug }}
+          GH_TOKEN: ${{ github.token }}
         run: |
           tests/test.sh

.gitignore

@@ -4,3 +4,4 @@
 *.iml
 /gh-md-toc
 personal-build-and-develop.*
+site/

.readthedocs.yaml

@@ -1,14 +1,22 @@
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-version: 2
-
-build:
-  os: ubuntu-22.04
-  tools:
-    python: "3.11"
-
-mkdocs:
-  configuration: mkdocs.yml
-
-python:
-  install:
-    - requirements: docs/requirements.txt
+version: 2
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: latest
+  jobs:
+    # We recommend using a requirements file for reproducible builds.
+    # This is just a quick example to get started.
+    # https://docs.readthedocs.io/page/guides/reproducible-builds.html
+    install:
+      - pip install zensical
+    build:
+      html:
+        - zensical build
+    post_build:
+      - mkdir -p $READTHEDOCS_OUTPUT/html/
+      - cp --recursive site/* $READTHEDOCS_OUTPUT/html/

Dockerfile

@@ -1,80 +1,96 @@
-ARG BASE_IMAGE=eclipse-temurin:21-jre
-FROM ${BASE_IMAGE}
-
-# hook into docker BuildKit --platform support
-# see https://docs.docker.com/engine/reference/builder/#automatic-platform-args-in-the-global-scope
-ARG TARGETOS
-ARG TARGETARCH
-ARG TARGETVARIANT
-
-# 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 \
-    TARGET=${TARGETARCH}${TARGETVARIANT} \
-    /build/run.sh install-packages
-
-RUN --mount=target=/build,source=build \
-    /build/run.sh setup-user
-
-COPY --chmod=644 files/sudoers* /etc/sudoers.d
-
-EXPOSE 25565
-
-ARG APPS_REV=1
-ARG GITHUB_BASEURL=https://github.com
-
-ARG EASY_ADD_VERSION=0.8.8
-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.5
-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.9
-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.15.0
-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.12.3
-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.40.11
-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
-RUN curl -fsSL ${MC_HELPER_BASE_URL}/mc-image-helper-${MC_HELPER_VERSION}.tgz \
-  | tar -C /usr/share -zxf - \
-  && ln -s /usr/share/mc-image-helper-${MC_HELPER_VERSION}/bin/mc-image-helper /usr/bin
-
-VOLUME ["/data"]
-WORKDIR /data
-
-STOPSIGNAL SIGTERM
-
-# End user MUST set EULA and change RCON_PASSWORD
-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/
-COPY --chmod=755 bin/mc-health /health.sh
-COPY --chmod=644 files/* /image/
-COPY --chmod=755 files/auto /auto
-
-RUN curl -fsSL -o /image/Log4jPatcher.jar https://github.com/CreeperHost/Log4jPatcher/releases/download/v1.0.1/Log4jPatcher-1.0.1.jar
-
-RUN dos2unix /start* /auto/*
-
-ENTRYPOINT [ "/start" ]
-HEALTHCHECK --start-period=2m --retries=2 --interval=30s CMD mc-health
+ARG BASE_IMAGE=eclipse-temurin:25-jre
+FROM ${BASE_IMAGE}
+
+# hook into docker BuildKit --platform support
+# see https://docs.docker.com/engine/reference/builder/#automatic-platform-args-in-the-global-scope
+ARG TARGETOS
+ARG TARGETARCH
+ARG TARGETVARIANT
+
+# 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 \
+    TARGET=${TARGETARCH}${TARGETVARIANT} \
+    /build/run.sh install-packages
+COPY --from=tianon/gosu /gosu /usr/local/bin/
+
+RUN --mount=target=/build,source=build \
+    /build/run.sh setup-user
+
+EXPOSE 25565
+
+ARG APPS_REV=1
+ARG GITHUB_BASEURL=https://github.com
+
+ARG EASY_ADD_VERSION=0.8.11
+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.11
+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.7.3
+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.16.0
+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.14.1
+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.53.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
+RUN curl -fsSL ${MC_HELPER_BASE_URL}/mc-image-helper-${MC_HELPER_VERSION}.tgz \
+  | tar -C /usr/share -zxf - \
+    && ln -s /usr/share/mc-image-helper-${MC_HELPER_VERSION}/ /usr/share/mc-image-helper \
+    && ln -s /usr/share/mc-image-helper/bin/mc-image-helper /usr/bin
+
+VOLUME ["/data"]
+WORKDIR /data
+
+STOPSIGNAL SIGTERM
+
+# End user MUST set EULA and change RCON_PASSWORD
+ENV TYPE=VANILLA VERSION=LATEST EULA="" UID=1000 GID=1000 LC_ALL=en_US.UTF-8
+
+COPY --chmod=755 scripts/start* /image/scripts/
+
+# Backward compatible shim for those with legacy entrypoint
+COPY --chmod=755 <<EOF /start
+#!/bin/bash
+exec /image/scripts/start
+EOF
+
+COPY --chmod=755 scripts/auto/* /image/scripts/auto/
+COPY --chmod=755 scripts/shims/* /image/scripts/shims/
+RUN ln -s /image/scripts/shims/* /usr/local/bin/
+COPY --chmod=755 files/* /image/
+
+RUN curl -fsSL -o /image/Log4jPatcher.jar https://github.com/CreeperHost/Log4jPatcher/releases/download/v1.0.1/Log4jPatcher-1.0.1.jar
+
+RUN dos2unix /image/scripts/start* /image/scripts/auto/*
+
+ENTRYPOINT [ "/image/scripts/start" ]
+HEALTHCHECK --start-period=2m --retries=2 --interval=30s CMD mc-health
+
+ARG BUILDTIME=local
+ARG VERSION=local
+ARG REVISION=local
+COPY <<EOF /etc/image.properties
+buildtime=${BUILDTIME}
+version=${VERSION}
+revision=${REVISION}
+EOF

README.md

@@ -1,8 +1,8 @@
-[![Docker Pulls](https://img.shields.io/docker/pulls/itzg/minecraft-server.svg)](https://hub.docker.com/r/itzg/minecraft-server/)
-[![Docker Stars](https://img.shields.io/docker/stars/itzg/minecraft-server.svg?maxAge=2592000)](https://hub.docker.com/r/itzg/minecraft-server/)
+[![Docker Pulls](https://img.shields.io/docker/pulls/itzg/minecraft-server.svg?logo=docker)](https://hub.docker.com/r/itzg/minecraft-server/)
+[![Docker Stars](https://img.shields.io/docker/stars/itzg/minecraft-server.svg?logo=docker)](https://hub.docker.com/r/itzg/minecraft-server/)
 [![GitHub Issues](https://img.shields.io/github/issues-raw/itzg/docker-minecraft-server.svg)](https://github.com/itzg/docker-minecraft-server/issues)
 [![Discord](https://img.shields.io/discord/660567679458869252?label=Discord&logo=discord)](https://discord.gg/DXfKpjB)
-[![Build and Publish](https://github.com/itzg/docker-minecraft-server/actions/workflows/build-multiarch.yml/badge.svg)](https://github.com/itzg/docker-minecraft-server/actions/workflows/build-multiarch.yml)
+[![Build and Publish](https://github.com/itzg/docker-minecraft-server/actions/workflows/build.yml/badge.svg)](https://github.com/itzg/docker-minecraft-server/actions/workflows/build.yml)
 [![](https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-orange.svg)](https://www.buymeacoffee.com/itzg)
 [![Documentation Status](https://readthedocs.org/projects/docker-minecraft-server/badge/?version=latest)](https://docker-minecraft-server.readthedocs.io/en/latest/?badge=latest)
 

build/alpine/install-packages.sh

@@ -10,7 +10,6 @@ apk add --no-cache -U \
     imagemagick \
     file \
     lsof \
-    su-exec \
     coreutils \
     findutils \
     procps \

build/ol/install-gosu.sh

@@ -1,22 +0,0 @@
-#!/bin/bash
-
-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,16 +4,18 @@ export TARGET
 
 set -euo pipefail
 
+os_major_version=$(awk -F'[= ."]+' '/^VERSION_ID=/{ print $2 }' /etc/os-release)
+
 # Install and configure dnf
 microdnf install dnf -y
 dnf install 'dnf-command(config-manager)' -y
-dnf config-manager --set-enabled ol8_codeready_builder
+dnf config-manager --set-enabled ol${os_major_version}_codeready_builder
 
 # Add EPEL repository
-tee /etc/yum.repos.d/ol8-epel.repo <<EOF
-[ol8_developer_EPEL]
+tee /etc/yum.repos.d/ol${os_major_version}-epel.repo <<EOF
+[ol${os_major_version}_developer_EPEL]
 name=Oracle Linux \$releasever EPEL (\$basearch)
-baseurl=https://yum.oracle.com/repo/OracleLinux/OL8/developer/EPEL/\$basearch/
+baseurl=https://yum.oracle.com/repo/OracleLinux/OL${os_major_version}$([ "$os_major_version" -ge 10 ] && echo '/0' || echo '')/developer/EPEL/\$basearch/
 gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-oracle
 gpgcheck=1
 enabled=1
@@ -24,6 +26,7 @@ dnf update -y
 
 # Install necessary packages
 # shellcheck disable=SC2086
+# shellcheck disable=SC2046
 dnf install -y \
   ImageMagick \
   file \
@@ -34,37 +37,43 @@ dnf install -y \
   git \
   jq \
   dos2unix \
-  mysql \
+  $([ "$os_major_version" -ge 10 ] && echo 'mysql8.4' || echo 'mysql') \
   procps-ng \
   tzdata \
   rsync \
   nano \
   unzip \
   zstd \
-  lbzip2 \
+  $([ "$os_major_version" -ge 10 ] && echo 'bzip2' || echo 'lbzip2') \
   libpcap \
   libwebp \
   findutils \
   which \
   glibc-langpack-en \
+  $([ "$os_major_version" -ge 10 ] && echo 'git-lfs' || echo '') \
+  $([ "$os_major_version" -ge 10 ] && echo 'openssl' || echo '') \
   ${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
+# Install Git LFS through third party repository for older OL releases
+if [ "$os_major_version" -lt 10 ]; then
+  curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.rpm.sh | sudo bash
+  dnf update -y
+  dnf install -y git-lfs
+fi
 
 # 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
+cat <<EOF > /usr/local/sbin/knockd
+#!/bin/sh
 
-# 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
+echo "Auto-pause (using knockd) is currently unavailable on graalvm image variants"
+echo "Consider using a different image variant https://docker-minecraft-server.readthedocs.io/en/latest/versions/java/"
+echo "or mc-router's auto scale up/down feature https://github.com/itzg/mc-router#docker-auto-scale-updown"
+exit 2
+EOF
+chmod 755 /usr/local/sbin/knockd
+# TODO restore retrieval from https://github.com/Metalcape/knock when tar's "Cannot open: Invalid argument" is solved
 
 # Set git credentials globally
 cat <<EOF >> /etc/gitconfig

build/ubuntu/install-packages.sh

@@ -11,7 +11,6 @@ DEBIAN_FRONTEND=noninteractive \
 apt-get install -y \
   imagemagick \
   file \
-  gosu \
   sudo \
   net-tools \
   iputils-ping \

compose-docs.yml

@@ -0,0 +1,16 @@
+# This composition can be used to serve up the rendered mkdocs for local authoring.
+#
+# docker compose -f compose-docs.yml -p zensical up
+#
+# and then access http://localhost:8000
+
+services:
+  zensical:
+    build:
+      context: .
+      dockerfile: docs/Dockerfile
+    volumes:
+      - ./zensical.toml:/docs/zensical.toml
+      - ./docs:/docs/docs
+    ports:
+      - "8000:8000"

docker-compose-mkdocs.yml

@@ -1,19 +0,0 @@
-# This composition can be used to serve up the rendered mkdocs for local authoring.
-#
-# docker compose -f docker-compose-mkdocs.yml -p mkdocs up
-#
-# and then access http://localhost:8000
-
-services:
-  mkdocs:
-    build:
-      context: .
-      dockerfile: docs/Dockerfile
-    volumes:
-      - ./mkdocs.yml:/mkdocs/mkdocs.yml
-      - ./docs:/mkdocs/docs
-    command:
-      - serve
-      - --dev-addr=0.0.0.0:8000
-    ports:
-      - "8000:8000"

docs/Dockerfile

@@ -1,10 +1,4 @@
-FROM python:3.9
-
-RUN pip install --upgrade pip
-
-WORKDIR /mkdocs
-
-RUN --mount=target=/build/requirements.txt,source=docs/requirements.txt \
-    pip install -r /build/requirements.txt
-
-ENTRYPOINT ["mkdocs"]
+FROM zensical/zensical
+
+RUN --mount=target=/build/requirements.txt,source=docs/requirements.txt \
+    pip install -r /build/requirements.txt

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`).
 
@@ -23,7 +19,7 @@ If you want to use a file's content for value, such as when using secrets mounte
 
 For example, a `my.cnf` file could contain:
 
-```
+```toml
 [client]
 password = ${CFG_DB_PASSWORD}
 ```
@@ -54,8 +50,7 @@ REPLACE_ENV_VARIABLES_EXCLUDE_PATHS="/data/plugins/Essentials/userdata /data/plu
 
 Here is a full example where we want to replace values inside a `database.yml`.
 
-```yml
-
+```yaml
 ---
 database:
   host: ${CFG_DB_HOST}
@@ -63,10 +58,10 @@ database:
   password: ${CFG_DB_PASSWORD}
 ```
 
-This is how your `docker-compose.yml` file could look like:
+This is how your `compose.yaml` file could look like:
 
-```yml
-# Other docker-compose examples in /examples
+```yaml title="compose.yaml"
+# Other docker compose examples in /examples
 
 services:
   minecraft:
@@ -138,8 +133,7 @@ The following example shows a patch-set file where various fields in the `paper.
 }
 ```
 
-Supports the file formats:
-
+Supports the file formats:
 - JSON
 - JSON5
 - Yaml

docs/configuration/jvm-options.md

@@ -1,132 +1,133 @@
-# JVM Options
-
-## Memory Limit
-
-By default, the image declares an initial and maximum Java memory-heap limit of 1 GB. There are several ways to adjust the memory settings:
-
-- `MEMORY`: "1G" by default, can be used to adjust both initial (`Xms`) and max (`Xmx`) memory heap settings of the JVM
-- `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]`. 
-
-!!! example "Using docker run"
- 
-    ```
-        -e MEMORY=2G
-    ```
-
-    or to use init and max memory:
-
-    ```
-        -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).
-
-## Extra JVM Options
-
-General JVM options can be passed to the Minecraft Server invocation by passing a `JVM_OPTS`
-environment variable. The JVM requires `-XX` options to precede `-X` options, so those can be declared in `JVM_XX_OPTS`. Both variables are space-delimited, raw JVM arguments.
-
-```
-docker run ... -e JVM_OPTS="-someJVMOption someJVMOptionValue" ...
-```
-
-**NOTE** When declaring `JVM_OPTS` in a compose file's `environment` section with list syntax, **do not** include the quotes:
-
-```yaml
-    environment:
-      - EULA=true
-      - JVM_OPTS=-someJVMOption someJVMOptionValue 
-```
-
-Using object syntax is recommended and more intuitive:
-
-```yaml
-    environment:
-      EULA: "true"
-      JVM_OPTS: "-someJVMOption someJVMOptionValue"
-# or
-#     JVM_OPTS: -someJVMOption someJVMOptionValue
-```
-
-As a shorthand for passing several system properties as `-D` arguments, you can instead pass a comma separated list of `name=value` or `name:value` pairs with `JVM_DD_OPTS`. (The colon syntax is provided for management platforms like Plesk that don't allow `=` inside a value.)
-
-For example, instead of passing
-
-```yaml
-  JVM_OPTS: -Dfml.queryResult=confirm -Dname=value
-```
-
-you can use
-
-```yaml
-  JVM_DD_OPTS: fml.queryResult=confirm,name=value
-```
-
-## Enable Remote JMX for Profiling
-
-To enable remote JMX, such as for profiling with VisualVM or JMC, set the environment variable `ENABLE_JMX` to "true", set `JMX_HOST` to the IP/host running the Docker container, and add a port forwarding of TCP port 7091, such as:
-
-!!! example
-
-    With `docker run`
-
-    ```
-    -e ENABLE_JMX=true -e JMX_HOST=$HOSTNAME -p 7091:7091
-    ```
-
-If needing to map to a different port, then also set the environment variable `JMX_PORT` to the desired host port.
-
-!!! example
-
-    With a compose file:
-    
-    ```yaml
-    environment:
-      ENABLE_JMX: true
-      JMX_HOST: ${HOSTNAME}
-      JMX_PORT: "7092"
-    ports:
-      - "7092:7092"
-    ```
-
-## Enable Aikar's Flags
-
-[Aikar has done some research](https://aikar.co/2018/07/02/tuning-the-jvm-g1gc-garbage-collector-flags-for-minecraft/) into finding the optimal JVM flags for GC tuning, which becomes more important as more users are connected concurrently. [PaperMC also has an explanation](https://docs.papermc.io/paper/aikars-flags) of what the JVM flags are doing.
-
-The set of flags documented there can be added using
-
-    -e USE_AIKAR_FLAGS=true
-
-When `MEMORY` is greater than or equal to 12G, then the Aikar flags will be adjusted according to the article.
+# JVM Options
+
+## Memory Limit
+
+By default, the image declares an initial and maximum Java memory-heap limit of 1 GB. There are several ways to adjust the memory settings:
+
+- `MEMORY`: "1G" by default, can be used to adjust both initial (`Xms`) and max (`Xmx`) memory heap settings of the JVM
+- `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]`.
+
+To have control over heap size, without relying on absolute memory sizes percentages are also supported using `<size>%`.
+
+!!! info "RAMPercentage parameters"
+    Percentage based heap sizing is enabled using `-XX:InitialRAMPercentage` for `INIT_MEMORY` and `-XX:MaxRAMPercentage` for `MAX_MEMORY`.
+    For details on the function of these parameters look [here](https://www.baeldung.com/java-jvm-parameters-rampercentage).
+
+!!! example "Using docker run"
+
+    ```
+        -e MEMORY=2G
+    ```
+
+    or to use init and max memory:
+
+    ```
+        -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.
+
+!!! 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).
+
+## Extra JVM Options
+
+General JVM options can be passed to the Minecraft Server invocation by passing a `JVM_OPTS`
+environment variable. If needing to set `-XX` options, then pass those with the `JVM_XX_OPTS` variable instead. Both variables accept space-delimited, raw JVM arguments.
+
+```
+docker run ... -e JVM_OPTS="-XsomeJVMOption -DpropName=value" ...
+```
+
+**NOTE** When declaring `JVM_OPTS` in a compose file's `environment` section with list syntax, **do not** include the quotes:
+
+```yaml
+    environment:
+      - EULA=true
+      - JVM_OPTS=-XsomeJVMOption -DpropName=value
+```
+
+Using object syntax is recommended and more intuitive:
+
+```yaml
+    environment:
+      EULA: "true"
+      JVM_OPTS: "-XsomeJVMOption -DpropName=value"
+# or without quotes
+#     JVM_OPTS: -XsomeJVMOption -DpropName=value
+```
+
+As a shorthand for passing several system properties as `-D` arguments, you can instead pass a comma separated list of `name=value` or `name:value` pairs with `JVM_DD_OPTS`. (The colon syntax is provided for management platforms like Plesk that don't allow `=` inside a value.)
+
+For example, instead of passing
+
+```yaml
+  JVM_OPTS: -Dfml.queryResult=confirm -Dname=value
+```
+
+you can use
+
+```yaml
+  JVM_DD_OPTS: fml.queryResult=confirm,name=value
+```
+
+## Enable Remote JMX for Profiling
+
+To enable remote JMX, such as for profiling with VisualVM or JMC, set the environment variable `ENABLE_JMX` to "true", set `JMX_HOST` to the IP/host running the Docker container, and add a port forwarding of TCP port 7091, such as:
+
+!!! example
+
+    With `docker run`
+
+    ```
+    -e ENABLE_JMX=true -e JMX_HOST=$HOSTNAME -p 7091:7091
+    ```
+
+If needing to map to a different port, then also set the environment variable `JMX_PORT` to the desired host port.
+
+!!! example
+
+    With a compose file:
+
+    ```yaml
+    environment:
+      ENABLE_JMX: true
+      JMX_HOST: ${HOSTNAME}
+      JMX_PORT: "7092"
+    ports:
+      - "7092:7092"
+    ```
+
+## Enable Aikar's Flags
+
+[Aikar has done some research](https://aikar.co/2018/07/02/tuning-the-jvm-g1gc-garbage-collector-flags-for-minecraft/) into finding the optimal JVM flags for GC tuning, which becomes more important as more users are connected concurrently. [PaperMC also has an explanation](https://docs.papermc.io/paper/aikars-flags) of what the JVM flags are doing.
+
+The set of flags documented there can be added using
+
+    -e USE_AIKAR_FLAGS=true
+
+When `MEMORY` is greater than or equal to 12G, then the Aikar flags will be adjusted according to the article.
+
+## Enable MeowIce's Flags
+
+[MeowIce has created an updated set of JVM flags](https://github.com/MeowIce/meowice-flags?tab=readme-ov-file#why-would-i-have-to-switch-) based on Aikar's flags but with support for optimizations for Java 17 and above
+
+The set of flags documented there can be added by setting the environment variable `USE_MEOWICE_FLAGS` to `true`. There is an optional `USE_MEOWICE_GRAALVM_FLAGS` variable to enable GraalVM specific optimizations, defaults to `FALSE`.

docs/configuration/misc-options.md

@@ -1,156 +1,239 @@
-
-## Running with a custom server JAR
-
-If you would like to run a custom server JAR, set `-e TYPE=CUSTOM` and pass the custom server
-JAR via `CUSTOM_SERVER`. It can either be a URL or a container path to an existing JAR file.
-
-If it is a URL, it will only be downloaded into the `/data` directory if it wasn't already. As
-such, if you need to upgrade or re-download the JAR, then you will need to stop the container,
-remove the file from the container's `/data` directory, and start again.
-
-## Force re-download of the server file
-
-For VANILLA, FORGE, BUKKIT, SPIGOT, PAPER, CURSEFORGE, SPONGEVANILLA server types, set
-`$FORCE_REDOWNLOAD` to some value (e.g. 'true) to force a re-download of the server file for
-the particular server type. by adding a `-e FORCE_REDOWNLOAD=true` to your command-line.
-
-For example, with PaperSpigot, it would look something like this:
-
-```
-docker run -d -v /path/on/host:/data \
-    -e TYPE=PAPER -e FORCE_REDOWNLOAD=true \
-    -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
-```
-
-## Running as alternate user/group ID
-
-By default, the container will switch to user ID 1000 and group ID 1000;
-however, you can override those values by setting `UID` and/or `GID` as environmental entries, during the `docker run` command.
-
-    -e UID=1234
-    -e GID=1234
-
-The container will also skip user switching if the `--user`/`-u` argument
-is passed to `docker run`.
-
-## Extra Arguments
-
-Arguments that would usually be passed to the jar file (those which are written after the filename) can be passed via the `EXTRA_ARGS` environment variable.
-
-See [Custom worlds directory path](../misc/world-data.md#custom-worlds-directory-path) for an example.
-
-## Interactive and Color Console
-
-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.
-
-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
-
-To allow time for players to finish what they're doing during a graceful server shutdown, set `STOP_SERVER_ANNOUNCE_DELAY` to a number of seconds to delay after an announcement is posted by the server.
-
-!!! warning "Increase stop grace period"
-
-    The Docker stop grace period must be increased to a value longer than the announce delay. The value to use that is longer than announce delay will vary based upon the amount of time it takes for final world data saving. If the container exits with exit code 137, then that indicates a longer grace period is needed. 
-    
-    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:
-
-- `-e TUNE_VIRTUALIZED=TRUE` : enables the option to
-  [optimize for virtualized environments](https://www.eclipse.org/openj9/docs/xtunevirtualized/)
-- `-e TUNE_NURSERY_SIZES=TRUE` : configures nursery sizes where the initial size is 50%
-  of the `MAX_MEMORY` and the max size is 80%.
-
-## Enabling rolling logs
-
-By default the vanilla log file will grow without limit. The logger can be reconfigured to use a rolling log files strategy by using:
-
-```
-  -e ENABLE_ROLLING_LOGS=true
-```
-
-> **NOTE** this will interfere with interactive/color consoles [as described in the section above](#interactive-and-color-console)
-
-## Timezone Configuration
-
-You can configure the timezone to match yours by setting the `TZ` environment variable:
-
-        -e TZ=Europe/London
-
-such as:
-
-        docker run -d -it -e TZ=Europe/London -p 25565:25565 --name mc itzg/minecraft-server
-
-Or mounting `/etc/timezone` as readonly (not supported on Windows):
-
-        -v /etc/timezone:/etc/timezone:ro
-
-such as:
-
-        docker run -d -it -v /etc/timezone:/etc/timezone:ro -p 25565:25565 --name mc itzg/minecraft-server
-
-## HTTP Proxy
-
-You may configure the use of an HTTP/HTTPS proxy by passing the proxy's URL via the `PROXY`
-environment variable. In [the example compose file](https://github.com/itzg/docker-minecraft-server/blob/master/examples/docker-compose-proxied.yml) it references
-a companion squid proxy by setting the equivalent of
-
-    -e PROXY=proxy:3128
-
-## Using "noconsole" option
-
-Some older versions (pre-1.14) of Spigot required `--noconsole` to be passed when detaching stdin, which can be done by setting `-e CONSOLE=FALSE`.
-
-## Explicitly disable GUI
-
-Some older servers get confused and think that the GUI interface is enabled. You can explicitly
-disable that by passing `-e GUI=FALSE`.
-
-## Stop Duration
-
-When the container is signalled to stop, the Minecraft process wrapper will attempt to send a "stop" command via RCON or console and waits for the process to gracefully finish. By default it waits 60 seconds, but that duration can be configured by setting the environment variable `STOP_DURATION` to the number of seconds.
-
-## Setup only
-
-If you are using a host-attached data directory, then you can have the image setup the Minecraft server files and stop prior to launching the server process by setting `SETUP_ONLY` to `true`. 
-    
-## Enable Flare Flags
-    
-To enable the JVM flags required to fully support the [Flare profiling suite](https://blog.airplane.gg/flare), set the following variable:
-    
-    -e USE_FLARE_FLAGS=true
-    
-Flare is built-in to Pufferfish/Purpur, and is available in [plugin form](https://github.com/TECHNOVE/FlarePlugin) for other server types.
-
-## Enable support for optimized SIMD operations
-
-To enable support for optimized SIMD operations, the JVM flag can be set with the following variable:
-
-    -e USE_SIMD_FLAGS=true
-
-SIMD optimized operations are supported by Pufferfish and Purpur.
-
-## Enable timestamps in init logs
-
-Before the container starts the Minecraft Server its output is prefixed with `[init]`, such as
-
-```
-[init] Starting the Minecraft server...
-```
-
-To also include the timestamp with each log, set `LOG_TIMESTAMP` to "true". The log output will then look like:
-
-```
-[init] 2022-02-05 16:58:33+00:00 Starting the Minecraft server...
-```
+## Running with a custom server JAR
+
+If you would like to run a custom server JAR, set `-e TYPE=CUSTOM` and pass the custom server
+JAR via `CUSTOM_SERVER`. It can either be a URL or a container path to an existing JAR file.
+
+If it is a URL, it will only be downloaded into the `/data` directory if it wasn't already. As
+such, if you need to upgrade or re-download the JAR, then you will need to stop the container,
+remove the file from the container's `/data` directory, and start again.
+
+## Force re-download of the server file
+
+For VANILLA, FORGE, BUKKIT, SPIGOT, PAPER, CURSEFORGE, SPONGEVANILLA server types, set
+`$FORCE_REDOWNLOAD` to some value (e.g. 'true) to force a re-download of the server file for
+the particular server type. by adding a `-e FORCE_REDOWNLOAD=true` to your command-line.
+
+For example, with Paper, it would look something like this:
+
+```
+docker run -d --pull=always \
+    -v /path/on/host:/data \
+    -e TYPE=PAPER -e FORCE_REDOWNLOAD=true \
+    -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
+```
+
+## Running as alternate user/group ID
+
+By default, the container will switch to and run the Minecraft server as user ID 1000 and group ID 1000; however, that can be changed by setting the environment variables `UID` and `GID`.
+
+The startup will also skip user switching if the `--user`/`-u` argument is passed to `docker run` or `user` is set on the compose service.
+
+## Extra Arguments
+
+Arguments that would usually be passed to the jar file (those which are written after the filename) can be passed via the `EXTRA_ARGS` environment variable.
+
+See [Custom worlds directory path](../misc/world-data.md#custom-worlds-directory-path) for an example.
+
+## Interactive and Color Console
+
+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.
+
+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
+
+To allow time for players to finish what they're doing during a graceful server shutdown, set `STOP_SERVER_ANNOUNCE_DELAY` to a number of seconds to delay after an announcement is posted by the server.
+
+!!! warning "Increase stop grace period"
+
+    The Docker stop grace period must be increased to a value longer than the announce delay. The value to use that is longer than announce delay will vary based upon the amount of time it takes for final world data saving. If the container exits with exit code 137, then that indicates a longer grace period is needed. 
+    
+    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:
+
+- `-e TUNE_VIRTUALIZED=TRUE` : enables the option to
+  [optimize for virtualized environments](https://www.eclipse.org/openj9/docs/xtunevirtualized/)
+- `-e TUNE_NURSERY_SIZES=TRUE` : configures nursery sizes where the initial size is 50%
+  of the `MAX_MEMORY` and the max size is 80%.
+
+## Customize Minecraft server logging
+
+The image can use a templated log4j2 configuration based on PaperMC's logging setup, which is automatically applied for versions that don't require Log4j security patches. This configuration provides rolling logs and advanced logging features by default.
+
+Set the environment variable `GENERATE_LOG4J2_CONFIG` to "true" to enable the following features.
+
+!!! note
+
+    This configures the server logging only. To diagnose container startup, set the `DEBUG` environment variable to "true".
+
+### Customization via environment variables
+
+You can customize various aspects of the logging behavior using environment variables:
+
+- `LOG_LEVEL` : Root logger level (default: `info`)
+  ```
+  -e LOG_LEVEL=debug
+  ```
+
+- `ROLLING_LOG_FILE_PATTERN` : Pattern for rolled log file names (default: `logs/%d{yyyy-MM-dd}-%i.log.gz`)
+  ```
+  -e ROLLING_LOG_FILE_PATTERN="logs/archive/%d{yyyy-MM-dd}-%i.log.gz"
+  ```
+
+- `ROLLING_LOG_MAX_FILES` : Maximum number of archived log files to keep (default: `1000`)
+  ```
+  -e ROLLING_LOG_MAX_FILES=30
+  ```
+
+### Customizing log message formats
+
+For full control over how log messages are formatted, you can customize the Log4j2 pattern layouts using these variables. These use [Log4j2 Pattern Layout syntax](https://logging.apache.org/log4j/2.x/manual/layouts.html#PatternLayout):
+
+- `LOG_CONSOLE_FORMAT` : Format for console output (what you see in `docker logs`)
+  Default: `[%d{HH:mm:ss}] [%t/%level]: %msg%n`
+
+- `LOG_FILE_FORMAT` : Format for file logs (written to `logs/latest.log`)
+  Default: `[%d{HH:mm:ss}] [%t/%level]: %msg%n`
+
+- `LOG_TERMINAL_FORMAT` : Format for interactive terminal console (used with `docker attach`)
+  Default: `[%d{HH:mm:ss} %level]: %msg%n`
+
+### Example configurations
+
+Simple timestamp customization (most common use case):
+```yaml
+environment:
+  # What you see in docker logs
+  LOG_CONSOLE_FORMAT: "[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%t/%level]: %msg%n"
+  # What gets written to logs/latest.log
+  LOG_FILE_FORMAT: "[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%t/%level]: %msg%n"
+```
+
+Advanced customization:
+```yaml
+environment:
+  LOG_LEVEL: debug
+  # Custom ISO8601 format with logger names
+  LOG_CONSOLE_FORMAT: "%d{ISO8601} %-5level [%t] %logger{36} - %msg%n"
+  LOG_FILE_FORMAT: "%d{ISO8601} %-5level [%t] %logger{36} - %msg%n"
+  ROLLING_LOG_MAX_FILES: 50
+```
+
+### Legacy ENABLE_ROLLING_LOGS option
+
+The `ENABLE_ROLLING_LOGS` environment variable is no longer needed for most use cases, as rolling logs are now enabled by default through the templated configuration. This option is maintained for backward compatibility but is only checked for error reporting when rolling logs cannot be used due to Log4j security patches.
+
+> **NOTE** The templated log4j2 configuration may interfere with interactive/color consoles [as described in the section above](#interactive-and-color-console)
+
+## Timezone Configuration
+
+You can configure the timezone to match yours by setting the `TZ` environment variable:
+
+        -e TZ=Europe/London
+
+such as:
+
+        docker run -d -it --pull=always -e TZ=Europe/London -p 25565:25565 --name mc itzg/minecraft-server
+
+Or mounting `/etc/timezone` as readonly (not supported on Windows):
+
+        -v /etc/timezone:/etc/timezone:ro
+
+such as:
+
+        docker run -d -it --pull=always -v /etc/timezone:/etc/timezone:ro -p 25565:25565 --name mc itzg/minecraft-server
+
+## HTTP Proxy
+
+You may configure the use of an HTTP/HTTPS proxy by passing the proxy's "host:port" via the environment variable `PROXY`. In [the example compose file](https://github.com/itzg/docker-minecraft-server/blob/master/examples/docker-compose-proxied.yml) it references a Squid proxy. The host and port can be separately passed via the environment variables `PROXY_HOST` and `PROXY_PORT`. A `|` delimited list of hosts to exclude from proxying can be passed via `PROXY_NON_PROXY_HOSTS`.
+
+## Using "noconsole" option
+
+Some older versions (pre-1.14) of Spigot required `--noconsole` to be passed when detaching stdin, which can be done by setting `-e CONSOLE=FALSE`.
+
+## Explicitly disable GUI
+
+Some older servers get confused and think that the GUI interface is enabled. You can explicitly
+disable that by passing `-e GUI=FALSE`.
+
+## Stop Duration
+
+When the container is signaled to stop, the Minecraft process wrapper will attempt to send a "stop" command via RCON or console and waits for the process to gracefully finish. By default, it waits 60 seconds, but that duration can be configured by setting the environment variable `STOP_DURATION` to the number of seconds.
+
+Be sure to also increase the shutdown timeout described [here for docker compose down](https://docs.docker.com/reference/cli/docker/compose/down/#options) and [here for docker stop](https://docs.docker.com/reference/cli/docker/container/stop/#options).
+
+## Setup only
+
+If you are using a host-attached data directory, then you can have the image setup the Minecraft server files and stop prior to launching the server process by setting `SETUP_ONLY` to `true`. 
+    
+## Enable Flare Flags
+    
+To enable the JVM flags required to fully support the [Flare profiling suite](https://blog.airplane.gg/flare), set the following variable:
+    
+    -e USE_FLARE_FLAGS=true
+    
+Flare is built-in to Pufferfish/Purpur, and is available in [plugin form](https://github.com/TECHNOVE/FlarePlugin) for other server types.
+
+## Enable support for optimized SIMD operations
+
+To enable support for optimized SIMD operations, the JVM flag can be set with the following variable:
+
+    -e USE_SIMD_FLAGS=true
+
+SIMD optimized operations are supported by Pufferfish and Purpur.
+
+For example, to download configuration files for plugins:
+
+```yaml
+environment:
+  DOWNLOAD_EXTRA_CONFIGS: |
+    plugins/WorldEdit<https://raw.githubusercontent.com/EngineHub/WorldEdit/refs/heads/version/7.3.x/worldedit-bukkit/src/main/resources/defaults/config.yml
+    plugins/EssentialsX<https://raw.githubusercontent.com/EssentialsX/Essentials/refs/heads/2.x/Essentials/src/main/resources/config.yml
+```
+
+Or as a single line:
+
+```yaml
+environment:
+  DOWNLOAD_EXTRA_CONFIGS: "plugins/WorldEdit<https://example.com/worldedit.yml,config<https://example.com/another.yml"
+```
+
+The files will be downloaded to `/data/` relative paths, so `plugins/WorldEdit` will be saved as `/data/plugins/WorldEdit/config.yml`.
+
+!!! note 
+    The downloaded files can be further processed using [environment variable replacement](interpolating.md) or [patch definitions](interpolating.md#patching-existing-files)
+
+## Enable timestamps in init logs
+
+Before the container starts the Minecraft Server its output is prefixed with `[init]`, such as
+
+```
+[init] Starting the Minecraft server...
+```
+
+To also include the timestamp with each log, set `LOG_TIMESTAMP` to "true". The log output will then look like:
+
+```
+[init] 2022-02-05 16:58:33+00:00 Starting the Minecraft server...
+```

docs/configuration/server-properties.md

@@ -1,4 +1,8 @@
-In order to unify management of the Minecraft server container, all of the [`server.properties`](https://minecraft.wiki/w/Server.properties) entries can be managed by the environment variables described in the sections below. Some of the mappings provide additional functionality above and beyond the properties file.
+To unify management of the Minecraft server container, all known [`server.properties`](https://minecraft.wiki/w/Server.properties) entries can be managed by the environment variables described in the sections below. Some mappings provide additional functionality above and beyond the properties file and will be described in the sections below.
+
+!!! warning "Version compatibility"
+
+    Not all server properties are supported by all versions of Minecraft. Since this image supports a wide range of versions, please consult the [server properties documentation](https://minecraft.wiki/w/Server.properties) for the version you are using.
 
 If you prefer to manually manage the `server.properties` file, set `OVERRIDE_SERVER_PROPERTIES` to "false". Similarly, you can entirely skip the startup script's creation of `server.properties` by setting `SKIP_SERVER_PROPERTIES` to "true".
 
@@ -84,9 +88,19 @@ To produce a multi-line MOTD, embed a newline character as `\n` in the string, s
     #      MOTD: "line one\nline two"
     ```
 
-!!! tip
+The following example combines a multi-line MOTD with [placeholders](#placeholders) from the latest version of the installed modpack:
 
-    You can also embed configured and resolved environment variables using [placeholders](#placeholders).
+!!! example
+
+    ```yaml
+    MOD_PLATFORM: AUTO_CURSEFORGE
+    CF_SLUG: craftoria
+    MOTD: |
+      A %TYPE% server on %VERSION%
+      running %MODPACK_NAME% %MODPACK_VERSION%
+    ```
+    
+    ![](../img/motd-with-placeholders.png)
 
 ### Difficulty
 
@@ -197,26 +211,77 @@ New to [22W42A](https://www.minecraft.net/en-us/article/minecraft-snapshot-22w42
 
 ### Server icon
 
-A server icon can be configured using the `ICON` variable. The image will be automatically
-downloaded, scaled, and converted from any other image format:
+A server icon can be configured by setting the `ICON` variable to a URL to download or a container path. The image will be automatically downloaded (if a URL), scaled, and converted from any other image format:
 
+!!! example
+
+    Using `docker run`:
+    
+    ```
     docker run -d -e ICON=http://..../some/image.png ...
+    ```
+    
+    In compose file:
+    
+    ```yaml
+    environment:
+      ICON: http://..../some/image.png
+    ```
+    
+    Using a file from host filesystem:
+    
+    ```yaml
+    environment:
+      ICON: /icon.png
+      OVERRIDE_ICON: true
+    volumes:
+      ./icon.png:/icon.png
+    ```
 
-The server icon which has been set doesn't get overridden by default. It can be changed and overridden by setting `OVERRIDE_ICON` to `TRUE`.
-
-    docker run -d -e ICON=http://..../some/other/image.png -e OVERRIDE_ICON=TRUE...
+By default an existing `server-icon.png` file will not be replaced, that can be changed by setting `OVERRIDE_ICON` to "true".
 
 ### RCON
 
-RCON is **enabled by default** to allow for graceful shut down the server and coordination of save state during backups. RCON can be disabled by setting `ENABLE_RCON` to "false".
+RCON is **enabled by default** to allow for graceful shut down of the server and coordination of save state during backups. RCON can be disabled by setting `ENABLE_RCON` to "false".
 
 !!! warning
 
     Disabling RCON will remove and limit some features, such as interactive and color console support.
 
-The default password is randomly generated on each startup; however, a specific one can be set with `RCON_PASSWORD`.
+#### RCON Password
 
-**DO NOT MAP THE RCON PORT EXTERNALLY** unless you are aware of all the consequences and have set a **secure password** with `RCON_PASSWORD`. 
+The default password is randomly generated on each startup. However, you can specify a password using one of the following environment variables:
+
+* Set `RCON_PASSWORD` to your desired password.
+* Set `RCON_PASSWORD_FILE` to the path of a file containing the password.
+
+Using `RCON_PASSWORD_FILE` is the recommended method for managing sensitive data, as it allows full support for [Docker Secrets](https://docs.docker.com/compose/how-tos/use-secrets/).
+
+??? example
+    ```yaml title="compose.yaml"
+    services:
+      mc:
+        image: itzg/minecraft-server:latest
+        pull_policy: daily
+        tty: true
+        stdin_open: true
+        ports:
+          - "25565:25565"
+        environment:
+          EULA: "TRUE"
+          RCON_PASSWORD_FILE: /run/secrets/rcon_pass # Points to the path where the secret is mounted
+        volumes:
+          # attach the relative directory 'data' to the container's /data path
+          - ./data:/data
+        secrets:
+          - rcon_pass
+    
+    secrets:
+      rcon_pass:
+        file: ./rcon_password # local file containing the password
+    ```
+!!! warning
+    **BE CAUTIOUS OF MAPPING THE RCON PORT EXTERNALLY** unless you are aware of all the consequences and have set a **secure password**.
 
 !!! info 
 
@@ -226,125 +291,26 @@ By default, the server listens for RCON on port 25575 within the container. It c
 
 ### Query
 
-Enabling this will enable the gamespy query protocol.
-By default the query port will be `25565` (UDP) but can easily be changed with the `QUERY_PORT` variable.
-
-    docker run -d -e ENABLE_QUERY=true
-
-### Max players
-
-By default max players is 20, you can increase this with the `MAX_PLAYERS` variable.
-
-    docker run -d -e MAX_PLAYERS=50
-
-### Max world size
-
-This sets the maximum possible size in blocks, expressed as a radius, that the world border can obtain.
-
-    docker run -d -e MAX_WORLD_SIZE=10000
-
-### Allow Nether
-
-Allows players to travel to the Nether.
-
-    docker run -d -e ALLOW_NETHER=true
-
-### Announce Player Achievements
-
-Allows server to announce when a player gets an achievement.
-
-    docker run -d -e ANNOUNCE_PLAYER_ACHIEVEMENTS=true
-
-### Enable Command Block
-
-Enables command blocks
-
-     docker run -d -e ENABLE_COMMAND_BLOCK=true
-
-### Force Gamemode
-
-Force players to join in the default game mode.
-
-- false - Players will join in the gamemode they left in.
-- true - Players will always join in the default gamemode.
-
-  `docker run -d -e FORCE_GAMEMODE=false`
-
-### Generate Structures
-
-Defines whether structures (such as villages) will be generated.
-
-- false - Structures will not be generated in new chunks.
-- true - Structures will be generated in new chunks.
-
-  `docker run -d -e GENERATE_STRUCTURES=true`
-
-### Hardcore
-
-If set to true, players will be set to spectator mode if they die.
-
-    docker run -d -e HARDCORE=false
-
-### Snooper
-
-If set to false, the server will not send data to snoop.minecraft.net server.
-
-    docker run -d -e SNOOPER_ENABLED=false
-
-### Max Build Height
-
-The maximum height in which building is allowed.
-Terrain may still naturally generate above a low height limit.
-
-    docker run -d -e MAX_BUILD_HEIGHT=256
-
-### Max Tick Time
-
-The maximum number of milliseconds a single tick may take before the server watchdog stops the server with the message, A single server tick took 60.00 seconds (should be max 0.05); Considering it to be crashed, server will forcibly shutdown. Once this criteria is met, it calls System.exit(1).
-Setting this to -1 will disable watchdog entirely
-
-    docker run -d -e MAX_TICK_TIME=60000
-
-### Spawn Animals
-
-Determines if animals will be able to spawn.
-
-    docker run -d -e SPAWN_ANIMALS=true
-
-### Spawn Monsters
-
-Determines if monsters will be spawned.
-
-    docker run -d -e SPAWN_MONSTERS=true
-
-### Spawn NPCs
-
-Determines if villagers will be spawned.
-
-    docker run -d -e SPAWN_NPCS=true
-
-### Set spawn protection
-
-Sets the area that non-ops can not edit (0 to disable)
-
-    docker run -d -e SPAWN_PROTECTION=0
-
-### View Distance
-
-Sets the amount of world data the server sends the client, measured in chunks in each direction of the player (radius, not diameter).
-It determines the server-side viewing distance.
-
-    docker run -d -e VIEW_DISTANCE=10
+Set the environment variable `ENABLE_QUERY` to "true" to enable the gamespy query protocol. Maps to the server property [enable-query](https://minecraft.wiki/w/Server.properties#enable-query). By default, the query port will be `25565` (UDP) but can be changed with the `QUERY_PORT` environment variable.
 
 ### Level Seed
 
-If you want to create the Minecraft level with a specific seed, use `SEED`, such as
-
-    -e SEED=1785852800490497919
+If you want to create the Minecraft level with a specific seed, set the environment variable `SEED`, which maps to the [level-seed](https://minecraft.wiki/w/Server.properties#level-seed) property.
 
 If using a negative value for the seed, make sure to quote the value such as:
 
+!!! example "Using docker run"
+
+    ``` 
     -e SEED="-1785852800490497919"
+    ```
+
+!!! example "Using compose"
+
+    ```yaml
+    environment:
+      SEED: "-1785852800490497919"
+    ```
 
 ### Game Mode
 
@@ -362,13 +328,6 @@ For example:
 
     docker run -d -e MODE=creative ...
 
-### PVP Mode
-
-By default, servers are created with player-vs-player (PVP) mode enabled. You can disable this with the `PVP`
-environment variable set to `false`, such as
-
-    docker run -d -e PVP=false ...
-
 ### Level Type and Generator Settings
 
 By default, a standard world is generated with hills, valleys, water, etc. A different level type can
@@ -376,7 +335,7 @@ be configured by setting `LEVEL_TYPE` to [an expected type listed here](https://
 
 For some of the level types, `GENERATOR_SETTINGS` can be used to further customize the world generation.
 
-To configure the `GENERATOR_SEETINGS` you need to add the appropriate `GeneratorOptions` JSON configuration. In the case of a superflat world, you may omit the `flat_world_options`.
+To configure the `GENERATOR_SETTINGS` you need to add the appropriate `GeneratorOptions` JSON configuration. In the case of a superflat world, you may omit the `flat_world_options`.
 
 The layers are applied from -64 and up and are added in the order of the list
 
@@ -388,29 +347,28 @@ Example for a superflat world:
 - Desert biome
 
 ```yaml
-LEVEL_TYPE: FLAT
-GENERATOR_SETTINGS: >-4
-    {
-        "layers": [
-            {
-                "block": "minecraft:bedrock",
-                "height": 1
-            },
-            {
-                "block": "minecraft:stone",
-                "height": 2
-            },
-            {
-                "block": "minecraft:sandstone",
-                "height": 15
-            }
-        ],
-        "biome": "minecraft:desert"
-    }
-
-
+environment:
+  LEVEL_TYPE: FLAT
+  GENERATOR_SETTINGS: >-
+      {
+          "layers": [
+              {
+                  "block": "minecraft:bedrock",
+                  "height": 1
+              },
+              {
+                  "block": "minecraft:stone",
+                  "height": 2
+              },
+              {
+                  "block": "minecraft:sandstone",
+                  "height": 15
+              }
+          ],
+          "biome": "minecraft:desert"
+      }
 ```
-For more details, check the [official wiki](https://minecraft.wiki/w/Java_Edition_level_format#generatorOptions_tag_format).
+For more details, refer to the Minecraft Wiki sections for [Superflat Multiplayer](https://minecraft.wiki/w/Superflat#Multiplayer) and [generator options tag format](https://minecraft.wiki/w/Java_Edition_level_format#generatorOptions_tag_format).
 
 ### Custom Server Resource Pack
 
@@ -432,31 +390,24 @@ where the default is "world":
 
 > **INFO** Refer to the [data directory](../data-directory.md) section for a visual description of where the `$LEVEL` directory is situated.
 
-### Online mode
-
-By default, server checks connecting players against Minecraft's account database. If you want to create an offline server or your server is not connected to the internet, you can disable the server to try connecting to minecraft.net to authenticate players with environment variable `ONLINE_MODE`, like this
-
-    docker run -d -e ONLINE_MODE=FALSE ...
-
-### Allow flight
-
-Allows users to use flight on your server while in Survival mode, if they have a mod that provides flight installed.
-
-    -e ALLOW_FLIGHT=TRUE|FALSE
-
-### Server name
-
-The server name (e.g. for bungeecord) can be set like:
-
-    docker run -d -e SERVER_NAME=MyServer ...
-
 ### Server port
 
-> **WARNING:** only change this value if you know what you're doing. It is only needed when using host networking and it is rare that host networking should be used. Use `-p` port mappings instead.
+> **WARNING:** only change this value if you know what you're doing. It only needs to be changed when using host-networking and it is rare that host networking should be used. Use `-p` port mappings instead.
 
 If you must, the server port can be set like:
 
+!!! example "Using docker run"
+
+    ```
     docker run -d -e SERVER_PORT=25566 ...
+    ```
+
+!!! example "Using compose"
+
+    ```yaml
+    environment:
+      SERVER_PORT: 25566
+    ```
 
 **however**, be sure to change your port mapping accordingly and be prepared for some features to break.
 
@@ -480,26 +431,67 @@ When using `docker run` from a bash shell, the entries must be quoted with the `
 
 ### Other server property mappings
 
-| Environment Variable              | Server Property                   |
-|-----------------------------------|-----------------------------------|
-| BROADCAST_CONSOLE_TO_OPS          | broadcast-console-to-ops          |
-| BROADCAST_RCON_TO_OPS             | broadcast-rcon-to-ops             |
-| ENABLE_STATUS                     | enable-status                     |
-| ENFORCE_SECURE_PROFILE            | enforce-secure-profile            |
-| ENTITY_BROADCAST_RANGE_PERCENTAGE | entity-broadcast-range-percentage |
-| FUNCTION_PERMISSION_LEVEL         | function-permission-level         |
-| NETWORK_COMPRESSION_THRESHOLD     | network-compression-threshold     |
-| OP_PERMISSION_LEVEL               | op-permission-level               |
-| PLAYER_IDLE_TIMEOUT               | player-idle-timeout               |
-| PREVENT_PROXY_CONNECTIONS         | prevent-proxy-connections         |
-| 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          |
+!!! warning "Version compatibility"
+
+    Not all server properties are supported by all versions of Minecraft. Since this image supports a wide range of versions, please consult the [server properties documentation](https://minecraft.wiki/w/Server.properties) for the version you are using.
+
+| Environment Variable                    | Server Property                                                                                                               |
+|-----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
+| ACCEPTS_TRANSFERS                       | [accepts-transfers](https://minecraft.wiki/w/Server.properties#accepts-transfers)                                             |
+| ALLOW_FLIGHT                            | [allow-flight](https://minecraft.wiki/w/Server.properties#allow-flight)                                                       |
+| ALLOW_NETHER                            | [allow-nether](https://minecraft.wiki/w/Server.properties#allow-nether)                                                       |
+| ANNOUNCE_PLAYER_ACHIEVEMENTS            | [announce-player-achievements](https://minecraft.wiki/w/Server.properties#announce-player-achievements)                       |
+| BROADCAST_CONSOLE_TO_OPS                | [broadcast-console-to-ops](https://minecraft.wiki/w/Server.properties#broadcast-console-to-ops)                               |
+| BROADCAST_RCON_TO_OPS                   | [broadcast-rcon-to-ops](https://minecraft.wiki/w/Server.properties#broadcast-rcon-to-ops)                                     |
+| BUG_REPORT_LINK                         | [bug-report-link](https://minecraft.wiki/w/Server.properties#bug-report-link)                                                 |
+| ENABLE_COMMAND_BLOCK                    | [enable-command-block](https://minecraft.wiki/w/Server.properties#enable-command-block)                                       |
+| ENABLE_STATUS                           | [enable-status](https://minecraft.wiki/w/Server.properties#enable-status)                                                     |
+| ENFORCE_SECURE_PROFILE                  | [enforce-secure-profile](https://minecraft.wiki/w/Server.properties#enforce-secure-profile)                                   |
+| ENTITY_BROADCAST_RANGE_PERCENTAGE       | [entity-broadcast-range-percentage](https://minecraft.wiki/w/Server.properties#entity-broadcast-range-percentage)             |
+| FORCE_GAMEMODE                          | [force-gamemode](https://minecraft.wiki/w/Server.properties#force-gamemode)                                                   |
+| FUNCTION_PERMISSION_LEVEL               | [function-permission-level](https://minecraft.wiki/w/Server.properties#function-permission-level)                             |
+| GENERATE_STRUCTURES                     | [generate-structures](https://minecraft.wiki/w/Server.properties#generate-structures)                                         |
+| GENERATOR_SETTINGS                      | [generator-settings](https://minecraft.wiki/w/Server.properties#generator-settings)                                           |                                                                                                                    
+| HARDCORE                                | [hardcore](https://minecraft.wiki/w/Server.properties#hardcore)                                                               |
+| HIDE_ONLINE_PLAYERS                     | [hide-online-players](https://minecraft.wiki/w/Server.properties#hide-online-players)                                         |
+| LOG_IPS                                 | [log-ips](https://minecraft.wiki/w/Server.properties#log-ips)                                                                 |
+| MANAGEMENT_SERVER_ALLOWED_ORIGINS       | [management-server-allowed-origins](https://minecraft.wiki/w/Server.properties#management-server-allowed-origins)             |
+| MANAGEMENT_SERVER_ENABLED               | [management-server-enabled](https://minecraft.wiki/w/Server.properties#management-server-enabled)                             |
+| MANAGEMENT_SERVER_HOST                  | [management-server-host](https://minecraft.wiki/w/Server.properties#management-server-host)                                   |
+| MANAGEMENT_SERVER_PORT                  | [management-server-port](https://minecraft.wiki/w/Server.properties#management-server-port)                                   |
+| MANAGEMENT_SERVER_SECRET                | [management-server-secret](https://minecraft.wiki/w/Server.properties#management-server-secret)                               |
+| MANAGEMENT_SERVER_TLS_ENABLED           | [management-server-tls-enabled](https://minecraft.wiki/w/Server.properties#management-server-tls-enabled)                     |
+| MANAGEMENT_SERVER_TLS_KEYSTORE          | [management-server-tls-keystore](https://minecraft.wiki/w/Server.properties#management-server-tls-keystore)                   |
+| MANAGEMENT_SERVER_TLS_KEYSTORE_PASSWORD | [management-server-tls-keystore-password](https://minecraft.wiki/w/Server.properties#management-server-tls-keystore-password) |
+| MAX_BUILD_HEIGHT                        | [max-build-height](https://minecraft.wiki/w/Server.properties#max-build-height)                                               |
+| MAX_COMMAND_CHAIN_LENGTH                | [max-command-chain-length](https://minecraft.wiki/w/Server.properties#max-command-chain-length)                               |
+| MAX_ENTITY_CRAMMING                     | [max-entity-cramming](https://minecraft.wiki/w/Server.properties#max-entity-cramming)                                         |
+| MAX_ENTITY_COLLISION_RADIUS             | [max-entity-collision-radius](https://minecraft.wiki/w/Server.properties#max-entity-collision-radius)                         |
+| MAX_FUNCTION_CHAIN_DEPTH                | [max-function-chain-depth](https://minecraft.wiki/w/Server.properties#max-function-chain-depth)                               |
+| MAX_NEIGHBORS                           | [max-neighbors](https://minecraft.wiki/w/Server.properties#max-neighbors)                                                     |
+| MAX_CHAINED_NEIGHBOR_UPDATES            | [max-chained-neighbor-updates](https://minecraft.wiki/w/Server.properties#max-chained-neighbor-updates)                       |
+| MAX_PLAYERS                             | [max-players](https://minecraft.wiki/w/Server.properties#max-players)                                                         |
+| MAX_TICK_TIME                           | [max-tick-time](https://minecraft.wiki/w/Server.properties#max-tick-time)                                                     |
+| MAX_WORLD_SIZE                          | [max-world-size](https://minecraft.wiki/w/Server.properties#max-world-size)                                                   |
+| NETWORK_COMPRESSION_THRESHOLD           | [network-compression-threshold](https://minecraft.wiki/w/Server.properties#network-compression-threshold)                     |
+| ONLINE_MODE                             | [online-mode](https://minecraft.wiki/w/Server.properties#online-mode)                                                         |
+| OP_PERMISSION_LEVEL                     | [op-permission-level](https://minecraft.wiki/w/Server.properties#op-permission-level)                                         |
+| PAUSE_WHEN_EMPTY_SECONDS                | [pause-when-empty-seconds](https://minecraft.wiki/w/Server.properties#pause-when-empty-seconds)                               |
+| PLAYER_IDLE_TIMEOUT                     | [player-idle-timeout](https://minecraft.wiki/w/Server.properties#player-idle-timeout)                                         |
+| PREVENT_PROXY_CONNECTIONS               | [prevent-proxy-connections](https://minecraft.wiki/w/Server.properties#prevent-proxy-connections)                             |
+| PVP                                     | [pvp](https://minecraft.wiki/w/Server.properties#pvp)                                                                         |
+| RATE_LIMIT                              | [rate-limit](https://minecraft.wiki/w/Server.properties#rate-limit)                                                           |
+| REGION_FILE_COMPRESSION                 | [region-file-compression](https://minecraft.wiki/w/Server.properties#region-file-compression)                                 |
+| RESOURCE_PACK_ID                        | [resource-pack-id](https://minecraft.wiki/w/Server.properties#resource-pack-id)                                               |
+| RESOURCE_PACK_PROMPT                    | [resource-pack-prompt](https://minecraft.wiki/w/Server.properties#resource-pack-prompt)                                       |
+| SERVER_NAME                             | [server-name](https://minecraft.wiki/w/Server.properties#server-name)                                                         |
+| SIMULATION_DISTANCE                     | [simulation-distance](https://minecraft.wiki/w/Server.properties#simulation-distance)                                         |
+| SNOOPER_ENABLED                         | [snooper-enabled](https://minecraft.wiki/w/Server.properties#snooper-enabled)                                                 |
+| SPAWN_ANIMALS                           | [spawn-animals](https://minecraft.wiki/w/Server.properties#spawn-animals)                                                     |
+| SPAWN_MONSTERS                          | [spawn-monsters](https://minecraft.wiki/w/Server.properties#spawn-monsters)                                                   |
+| SPAWN_NPCS                              | [spawn-npcs](https://minecraft.wiki/w/Server.properties#spawn-npcs)                                                           |
+| SPAWN_PROTECTION                        | [spawn-protection](https://minecraft.wiki/w/Server.properties#spawn-protection)                                               |
+| STATUS_HEARTBEAT_INTERVAL               | [status-heartbeat-interval](https://minecraft.wiki/w/Server.properties#status-heartbeat-interval)                             |
+| SYNC_CHUNK_WRITES                       | [sync-chunk-writes](https://minecraft.wiki/w/Server.properties#sync-chunk-writes)                                             |
+| USE_NATIVE_TRANSPORT                    | [use-native-transport](https://minecraft.wiki/w/Server.properties#use-native-transport)                                       |
+| VIEW_DISTANCE                           | [view-distance](https://minecraft.wiki/w/Server.properties#view-distance)                                                     |

docs/data-directory.md

@@ -28,13 +28,14 @@ When attached in this way you can stop the server, edit the configuration under
 
     There might be a safer/better way to accommodate these systems. Please post an issue or PR if you have more information.
     
-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.
+With Docker Compose, setting up a host attached directory is even easier since relative paths can be configured. For example, with the following `compose.yaml` Docker will automatically create/attach the relative directory `minecraft-data` to the container.
 
-``` yaml title="docker-compose.yml"
+```yaml title="compose.yaml"
 
 services:
   mc:
-    image: itzg/minecraft-server
+    image: itzg/minecraft-server:latest
+    pull_policy: daily
     ports:
       - 25565:25565
     environment:

docs/index.md

@@ -15,7 +15,28 @@ To simply use the latest stable version, run
 
     docker run -d -it -p 25565:25565 -e EULA=TRUE itzg/minecraft-server
 
-where, in this case, the standard server port 25565, will be exposed on your host machine.
+where, in this case, the standard server port 25565 will be exposed on your host machine.
+
+!!! important "Persistent Data"
+
+    The Minecraft server will store its data in the container's `/data` directory. This directory can be [mounted](https://docs.docker.com/storage/volumes/) from the host machine or a managed volume.
+
+    Using `docker run` add a `-v` option somewhere before the image name:
+    
+    ```
+    ... -v /path/on/host:/data itzg/minecraft-server
+    ```
+    
+    Using docker compose, add a `volumes` section to the service definition:
+    
+    ```yaml
+    services:
+      mc:
+        # ... image and environment section
+        volumes:
+          # attach the relative directory 'data' to the container's /data path
+          - ./data:data
+    ```
 
 !!! note
 
@@ -25,24 +46,21 @@ where, in this case, the standard server port 25565, will be exposed on your hos
 
     Be sure to always include `-e EULA=TRUE` in your commands and container definitions, as Mojang/Microsoft requires EULA acceptance.
 
-!!! warning 
-
-    **DO NOT** port forward RCON on 25575 without first setting `RCON_PASSWORD` to a secure value. It is highly recommended to only use RCON within the container, such as with `rcon-cli`. 
-
-By default, the container will download the latest version of the "vanilla" [Minecraft: Java Edition server](https://www.minecraft.net/en-us/download/server) provided by Mojang. The [`VERSION`](versions/java.md) and the [`TYPE`](types-and-platforms/index.md) can be configured to create many variations of desired Minecraft server. 
+By default, the container will download the latest version of the "vanilla" [Minecraft: Java Edition server](https://www.minecraft.net/en-us/download/server) provided by Mojang. The [`VERSION`](versions/minecraft.md) and the [`TYPE`](types-and-platforms/index.md) can be configured to create many variations of desired Minecraft server. 
 
 ## Using [Docker Compose](https://docs.docker.com/compose/)
 
 1. Create a new directory
-2. Put the contents of the file below in a file called `docker-compose.yml`
+2. Put the contents of the file below in a file called `compose.yaml`
 3. Run `docker compose up -d` in that directory
 4. Done! Point your client at your host's name/IP address and port 25565.
 
-```yaml
+```yaml title="compose.yaml"
 
 services:
   mc:
-    image: itzg/minecraft-server
+    image: itzg/minecraft-server:latest
+    pull_policy: daily
     tty: true
     stdin_open: true
     ports:
@@ -58,8 +76,12 @@ 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.yaml` 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).
 
 !!! note "Deployment Examples"
     The [deployments page](misc/deployment/index.md) provides more examples of deployment with and beyond Docker Compose.
+

docs/misc/autopause-autostop/autopause.md

@@ -1,10 +1,14 @@
 # Auto-Pause
 
+!!! important
+
+    As of [1.21.2](https://minecraft.wiki/w/Java_Edition_1.21.2) it is not recommend to use this feature since Minecraft server natively auto-pauses when the server is empty. That is configured via the enivironment variable `PAUSE_WHEN_EMPTY_SECONDS`, which maps to the `pause-when-empty-seconds` server property. 
+
 An auto-pause functionality is provided that monitors whether clients are connected to the server. If a client is not connected for a specified time, the Java process is put into a pause state. When a client attempts to connect while the process is paused, then process will be restored to a running state. The experience for the client does not change. This feature can be enabled by setting the environment variable `ENABLE_AUTOPAUSE` to "true".
 
 !!! important
 
-    **You must greatly increase or disable max-tick-time watchdog functionality.** From the server's point of view, the pausing causes a single tick to take as long as the process is stopped, so the server watchdog might intervene after the process is continued, possibly forcing a container restart. To prevent this, ensure that the `max-tick-time` in the `server.properties` file is set to a very large value or -1 to disable it entirely, which is highly recommended. That can be set with `MAX_TICK_TIME` as described in [the section below](../../configuration/server-properties.md#max-tick-time).
+**You must greatly increase or disable max-tick-time watchdog functionality.** From the server's point of view, the pausing causes a single tick to take as long as the process is stopped, so the server watchdog might intervene after the process is continued, possibly forcing a container restart. To prevent this, ensure that the `max-tick-time` in the `server.properties` file is set to a very large value or -1 to disable it entirely, which is highly recommended. That can be set with `MAX_TICK_TIME` as described in [server properties](../../configuration/server-properties.md).
 
     Non-vanilla versions might have their own configuration file, you might have to disable their watchdogs separately. For PaperMC servers, you need to send the JVM flag `-Ddisable.watchdog=true`, this can be done with the docker env variable `-e JVM_DD_OPTS=disable.watchdog:true`
 
@@ -18,8 +22,6 @@ A `.skip-pause` file can be created in the `/data` directory to make the server
 
 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.
-
 !!! note 
 
     When configuring kubernetes readiness/liveness health checks with auto-pause enabled, be sure to reference the `mc-health` wrapper script rather than `mc-status` directly.
@@ -38,6 +40,8 @@ The following environment variables define the behaviour of auto-pausing:
   describes period of the daemonized state machine, that handles the pausing of the process (resuming is done independently)
 - `AUTOPAUSE_KNOCK_INTERFACE`, default `eth0`
   <br>Describes the interface passed to the `knockd` daemon. If the default interface does not work, run the `ifconfig` command inside the container and derive the interface receiving the incoming connection from its output. The passed interface must exist inside the container. Using the loopback interface (`lo`) does likely not yield the desired results.
+- `AUTOPAUSE_STATUS_RETRY_LIMIT`, default 10
+- `AUTOPAUSE_STATUS_RETRY_INTERVAL`, default 2s
 
 !!! tip
 

docs/misc/autopause-autostop/autostop.md

@@ -17,12 +17,14 @@ Enable the Autostop functionality by setting:
 ```
 
 The following environment variables define the behavior of auto-stopping:
-* `AUTOSTOP_TIMEOUT_EST`, default `3600` (seconds)
+- `AUTOSTOP_TIMEOUT_EST`, default `3600` (seconds)
   describes the time between the last client disconnect and the stopping of the server (read as timeout established)
-* `AUTOSTOP_TIMEOUT_INIT`, default `1800` (seconds)
+- `AUTOSTOP_TIMEOUT_INIT`, default `1800` (seconds)
   describes the time between server start and the stopping of the server, when no client connects in-between (read as timeout initialized)
-* `AUTOSTOP_PERIOD`, default `10` (seconds)
+- `AUTOSTOP_PERIOD`, default `10` (seconds)
   describes period of the daemonized state machine, that handles the stopping of the server
+- `AUTOPAUSE_STATUS_RETRY_LIMIT`, default 10
+- `AUTOPAUSE_STATUS_RETRY_INTERVAL`, default 2s
 
 > To troubleshoot, add `DEBUG_AUTOSTOP=true` to see additional output
 

docs/misc/autoscale/autoscale.md

@@ -0,0 +1,39 @@
+
+# Autoscaling (sleep when idle)
+
+Autoscaling (sometimes called *sleeping*, *scale to zero* or *wake on join*) is the pattern of stopping a Minecraft server when nobody is playing and starting it again when someone tries to connect with the intention of saving resources when the server is not in use (e.g., on a VPS with limited CPU/RAM or a home server).
+
+## mc-router
+
+[mc-router](https://github.com/itzg/mc-router) is a Minecraft-aware router/multiplexer.
+
+- Routes players by the hostname they connect with (useful for multiple servers behind one port)
+- Can auto-start a backend container on join and stop it again after an idle timeout
+
+Examples:
+
+- See the mc-router section in [Examples](../examples.md#mc-router-with-auto-scale)
+
+## Lazymc
+
+[Lazymc](https://github.com/timvisee/lazymc) can keep a server “asleep” until a player connects. With Docker it’s commonly used via [lazymc-docker-proxy](https://github.com/joesturge/lazymc-docker-proxy).
+
+- Players connect to the proxy; the proxy starts/stops the server container
+- Usually requires a static IP for the Minecraft container on a user-defined network
+
+Example:
+
+- See the Lazymc section in [Examples](../examples.md#lazymc-put-your-minecraft-server-to-rest-when-idle)
+
+## Lazytainer
+
+[Lazytainer](https://github.com/vmorganp/Lazytainer) starts/stops containers based on network traffic.
+
+- Uses packet thresholds + inactivity timeouts (not Minecraft hostname aware)
+- Can be triggered by port scans/pings in noisy environments
+
+Example:
+
+- See the Lazytainer section in [Examples](../examples.md#lazytainer-stop-minecraft-container-based-on-traffic)
+
+

docs/misc/building.md

@@ -1,7 +1,13 @@
 
+!!! tip "For advanced use only"
+
+    This page describes a capability that is not applicable to most users. It is only intended for rare cases when a very specific Java base image is needed or additional packages need to be installed that are not generally applicable or would bloat the image size.
+
+    Be sure to confirm that the desired [version and variant of Java isn't already provided](../versions/java.md).
+
 ## Building image locally with alternate Java base
 
-The following shows how to change the base Java image used by the build:
+An alternate Java base image can be specified by setting the [docker build argument](https://docs.docker.com/reference/cli/docker/buildx/build/#build-arg) `BASE_IMAGE` to the desired base image. The following shows an example of using the base image `ghcr.io/graalvm/graalvm-ce:ol8-java11`:
 
 ```shell
 docker build --build-arg BASE_IMAGE=ghcr.io/graalvm/graalvm-ce:ol8-java11 -t IMG_PREFIX/minecraft-server:java11-graalvm .

docs/misc/contributing/development.md

@@ -21,8 +21,8 @@ $env:FOLDER_TO_TEST="forgeapimods_projectids"
 $env:IMAGE_TO_TEST="mc-dev"
 docker build -t $env:IMAGE_TO_TEST .
 pushd "tests/setuponlytests/$env:FOLDER_TO_TEST/"
-docker-compose run mc
-docker-compose down -v --remove-orphans
+docker compose run mc
+docker compose down -v --remove-orphans
 popd
 ```
 
@@ -39,28 +39,28 @@ export FOLDER_TO_TEST="forgeapimods_file"
 export IMAGE_TO_TEST="mc-dev"
 docker build -t $IMAGE_TO_TEST .
 pushd tests/setuponlytests/$FOLDER_TO_TEST/
-docker-compose run mc
-docker-compose down -v --remove-orphans
+docker compose run mc
+docker compose down -v --remove-orphans
 popd
 ```
 
 Using the baseline image, an interactive container can be started to iteratively run the scripts to be developed. By attaching the current workspace directory, you can use the local editor of your choice to iteratively modify scripts while using the container to run them.
 
 ```shell
-docker run -it --rm -v ${PWD}:/scripts -e SCRIPTS=/scripts/ --entrypoint bash mc-dev
+docker run -it --rm -v ${PWD}:/image/scripts --entrypoint bash mc-dev
 ```
 
-From within the container you can run individual scripts via the attached `/scripts/` path; however, be sure to set any environment variables expected by the scripts by either `export`ing them manually:
+From within the container you can run individual scripts via the attached `/image/scripts/` path; however, be sure to set any environment variables expected by the scripts by either `export`ing them manually:
 
 ```shell
 export VERSION=1.12.2
-/scripts/start-magma
+/image/scripts/start-deployFabric
 ```
 
 ...or pre-pending script execution:
 
 ```shell
-VERSION=1.12.2 /scripts/start-magma
+VERSION=1.12.2 /image/scripts/start-deployFabric
 ```
 
 !!! note
@@ -69,15 +69,38 @@ VERSION=1.12.2 /scripts/start-magma
 
 ## Using development copy of tools
 
-In the cloned repo, such as [`mc-image-helper`](https://github.com/itzg/mc-image-helper), create an up-to-date snapshot build of the tgz distribution using:
+In the cloned repo, such as [`mc-image-helper`](https://github.com/itzg/mc-image-helper), install the distribution locally by running:
 
 ```shell
-./gradlew distTar
+./gradlew installDist
 ```
 
-!!! note
+The distribution will be installed in the project's `build/install/mc-image-helper`. Obtain the absolute path to that directory use in the next step.
 
-    The distribution's version will be `0.0.0-<branch>-SNAPSHOT`
+Refer to the instructions above to mount any locally modified image scripts or build a local copy of the image using or with alternate `BASE_IMAGE`, as described above:
+
+```shell
+docker build -t itzg/minecraft-server .
+```
+
+Mount the local mc-image-helper distribution directory as a volume in the container at the path `/usr/share/mc-image-helper`, such as
+
+```shell
+docker run -it --rm \
+  -v /path/to/mc-image-helper/build/install/mc-image-helper:/usr/share/mc-image-helper \
+  -e EULA=true \
+  itzg/minecraft-server
+```
+
+In a compose file, include the volume mount in the `volumes` section of the container definition:
+
+```yaml
+services:
+  mc:
+    # ... usual container definition
+    volumes:
+      - /path/to/mc-image-helper/build/install/mc-image-helper:/usr/share/mc-image-helper:ro
+```
 
 For Go base tools, run
 

docs/misc/contributing/docs.md

@@ -1,6 +1,6 @@
 # Site documentation
 
-The documentation for this image/repository is written in markdown and built by [MkDocs](https://www.mkdocs.org/) into a documentation website hosted at [Read the Docs](https://readthedocs.org/). [Here is general information about writing MkDocs markdown](https://www.mkdocs.org/user-guide/writing-your-docs/) and [specifics for the Material theme used](https://squidfunk.github.io/mkdocs-material/reference/).
+The documentation for this image/repository is written in markdown and built using [Zensical](https://zensical.org/) into a documentation website hosted at [Read the Docs](https://readthedocs.org/). [Here is general information about writing Zensical markdown](https://zensical.org/docs/authoring/markdown/).
 
 !!! note
     The README.md rarely needs to be modified and only serves as a brief introduction to the project.
@@ -10,7 +10,7 @@ The documentation source is maintained in the [docs](https://github.com/itzg/doc
 It will be very helpful to view the rendered documentation as you're editing. To do that run the following from the top-level directory:
 
 ```shell
-docker compose -f docker-compose-mkdocs.yml -p mkdocs up
+docker compose -f compose-docs.yml -p zensical up
 ```
 
-You can access the live documentation rendering at <http://localhost:8000>.
+You can access the live documentation rendering at <http://localhost:8000>.

docs/misc/deployment/index.md

@@ -13,6 +13,17 @@
 
 [Shulker](https://github.com/jeremylvln/Shulker) is a Kubernetes operator for managing complex and dynamic Minecraft infrastructures, including game servers and proxies. It uses the docker-minecraft-server and docker-bungeecord images under-the-hood.
 
+## With Ansible
+
+[Ansible](https://docs.ansible.com/ansible/latest/getting_started/introduction.html) is an open-source task automation tool built in [Python](https://www.python.org/). Ansible playbooks can be used to automate all kinds of tasks, including deploying remote Minecraft servers.
+
+### Using the MASH playbook
+
+[The MASH Playbook](https://github.com/mother-of-all-self-hosting/mash-playbook) is a premade playbook with the option to deploy a [wide variety of open-source services](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/supported-services.md) to your server(s), including [docker-minecraft-server](https://github.com/XHawk87/ansible-role-minecraft), making it a good option if you want all the bells and whistles alongside your Minecraft server.
+- Check out the [Installation Guide](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/README.md) for the MASH playbook to get started.
+- You can then enable [Minecraft](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/services/minecraft.md) in your vars.yml.
+- Enable any supporting services that you might find useful, such as [user authentication](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/services/authelia.md), [remote backups](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/services/backup-borg.md), [email relay](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/services/exim-relay.md), [cron monitoring](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/services/healthchecks.md), [audio and video conferencing](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/services/jitsi.md), databases ([MariaDB](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/services/mariadb.md), [PostgresSQL](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/services/postgres.md)), [push notifications](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/services/ntfy.md), [uptime monitoring](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/services/uptime-kuma.md), [a website](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/services/wordpress.md), as well as installing any [extra files, folders, applications, services and running commands](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/services/auxiliary.md) automatically on deployment.
+
 ## On CloudFormation (AWS)
 
 If you're looking for a simple way to deploy this to the Amazon Web Services Cloud, check out the [Minecraft Server Deployment (CloudFormation) repository](https://github.com/vatertime/minecraft-spot-pricing). This repository contains a CloudFormation template that will get you up and running in AWS in a matter of minutes. Optionally it uses Spot Pricing so the server is very cheap, and you can easily turn it off when not in use.

docs/misc/examples.md

@@ -6,11 +6,12 @@ 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
+```yaml title="compose.yaml"
 
 services:
   mc:
-    image: itzg/minecraft-server
+    image: itzg/minecraft-server:latest
+    pull_policy: daily
     environment:
       EULA: "true"
       TYPE: "PAPER"
@@ -26,20 +27,80 @@ services:
 
 [Source](https://github.com/itzg/docker-minecraft-server/blob/master/examples/geyser/docker-compose.yml)
 
+
+## mc-router with auto-scale
+
+Using [mc-router](https://github.com/itzg/mc-router) in front of one or multiple Minecraft server containers allows you to route players based on the hostname they use to connect.
+
+With `AUTO_SCALE_UP` and `AUTO_SCALE_DOWN` enabled, mc-router can automatically start a target server when a player connects and stop it again after a period of inactivity.
+
+```yaml title="compose.yaml"
+services:
+  router:
+    image: itzg/mc-router
+    environment:
+      IN_DOCKER: true
+      AUTO_SCALE_DOWN: true
+      AUTO_SCALE_UP: true
+      AUTO_SCALE_DOWN_AFTER: 2h
+      AUTO_SCALE_ASLEEP_MOTD: "Server is asleep. Join again to wake it up!"
+    ports:
+      - "25565:25565"
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock:ro
+
+  vanilla:
+    image: itzg/minecraft-server
+    environment:
+      EULA: "TRUE"
+    labels:
+      mc-router.host: "vanilla.example.com"
+
+  paper:
+    image: itzg/minecraft-server
+    environment:
+      EULA: "TRUE"
+      TYPE: PAPER
+    labels:
+      mc-router.host: "paper.example.com"
+```
+
+[Source](https://github.com/itzg/mc-router/blob/main/examples/docker-autoscale/compose-minimal.yml)
+
+[More detailed example](https://github.com/itzg/mc-router/blob/main/examples/docker-autoscale/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
+```yaml title="compose.yaml"
+# Lazymc requires that the minecraft server have a static IP.
+#
+# To ensure that our servers have a static IP we need to create
+# a network for our services to use.
+#
+# By default, Docker uses 172.17.0.0/16 subnet range.
+# So we need to create a new network in a different subnet
+# See the readme for more information.
+#
+# Please ensure that the subnet falls within the private CIDRs:
+# https://datatracker.ietf.org/doc/html/rfc1918#section-3
+#
+# And that it is not in use by anything else.
+networks:
+  minecraft-network:
+    driver: bridge    
+    ipam:
+      config:
+        - subnet: 172.18.0.0/16
+
 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
+    # the IPs should start at .2 as .1 is reserved for the gateway
+    networks:
+      minecraft-network:
+        ipv4_address: 172.18.0.2
     restart: unless-stopped
     volumes:
       # you should mount the minecraft server dir under /server, using read only.
@@ -54,11 +115,20 @@ services:
   # Standard Docker Minecraft server, also works with other server types
   mc:
     image: itzg/minecraft-server:java21
-    container_name: minecraft-server
+    pull_policy: daily
+    # Assign a static IP to the server container
+    networks:
+      minecraft-network:
+        ipv4_address: 172.18.0.3
     # We need to add a label here so that lazymc-docker-proxy knows which
     # container to manage
     labels:
+      # Set lazymc.enabled to true to enable lazymc on this container
+      - lazymc.enabled=true
+      # Required to find the container to manage it
       - lazymc.group=mc
+      # Point to the service name of the Minecraft server
+      - lazymc.server.address=mc:25565
     tty: true
     stdin_open: true
     # This container should be managed solely by the lazymc container
@@ -79,7 +149,7 @@ 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
+```yaml title="compose.yaml"
 services:
   lazytainer:
     image: ghcr.io/vmorganp/lazytainer:master
@@ -97,7 +167,8 @@ services:
     restart: unless-stopped
     network_mode: bridge
   mc:
-    image: itzg/minecraft-server
+    image: itzg/minecraft-server:latest
+    pull_policy: daily
     environment:
       EULA: TRUE
       TYPE: PAPER
@@ -113,4 +184,4 @@ services:
     stdin_open: true
     restart: unless-stopped
 ```
-[Source](https://github.com/itzg/docker-minecraft-server/blob/master/examples/lazytainer/docker-compose.yml)
+[Source](https://github.com/itzg/docker-minecraft-server/blob/master/examples/lazytainer/docker-compose.yml)

docs/misc/healthcheck.md

@@ -7,14 +7,14 @@ CONTAINER ID        IMAGE               COMMAND             CREATED
 b418af073764        mc                  "/start"            43 seconds ago      Up 41 seconds (healthy)   0.0.0.0:25565->25565/tcp, 25575/tcp   mc
 ```
 
-You can also query the container's health in a script friendly way:
+You can also query the container's health in a script-friendly way:
 
 ``` shell
 > docker container inspect -f "{{.State.Health.Status}}" mc
 healthy
 ```
 
-There's actually a wrapper script called `mc-health` that takes care of calling `mc-monitor status` with the correct arguments. If needing to customize the health checks parameters, such as in a compose file, then use something like the following in the service declaration:
+There's actually a wrapper script called `mc-health` that takes care of calling `mc-monitor status` with the correct arguments. If needing to customize the health checks parameters, such as in a Compose file, then use something like the following in the service declaration:
 
 ``` yaml
 healthcheck:
@@ -24,9 +24,16 @@ healthcheck:
   retries: 20
 ```
 
-Some orchestration systems, such as Portainer, don't allow for disabling the default `HEALTHCHECK` declared by this image. In those cases you can approximate the disabling of healthchecks by setting the environment variable `DISABLE_HEALTHCHECK` to `true`.
+Some orchestration systems, such as Portainer, don't allow for disabling the default `HEALTHCHECK` declared by this image. In those cases you can approximate the disabling of health checks by setting the environment variable `DISABLE_HEALTHCHECK` to `true`.
 
-### Healthchecks for older versions
+The [health check in a Compose service declaration](https://docs.docker.com/reference/compose-file/services/#healthcheck) can also be disabled using:
 
-This container disables Healthchecks for Versions before b1.8 as those versions do not support any kind of server pinging.
-For more information see [Server List Ping](https://wiki.vg/Server_List_Ping#Beta_1.8_to_1.3)
+```yaml
+    healthcheck:
+      disable: true
+      test: ["NONE"]
+```
+
+### Health checks for older versions
+
+This container disables health checks for Minecraft versions before b1.8 as those versions do not support any kind of server pinging. For more information see [Server List Ping](https://minecraft.wiki/w/Java_Edition_protocol/Server_List_Ping#Beta_1.8_to_1.3).

docs/misc/troubleshooting.md

@@ -5,3 +5,34 @@ To troubleshoot just the command-line used to start the Minecraft server, set th
 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`.
+
+To confirm the image version that has been pulled, use the following command, replacing `itzg/minecraft-server` as needed for specific image tags:
+
+## Image labels
+
+```shell
+docker image inspect itzg/minecraft-server -f "{{json .Config.Labels}}"
+```
+
+such as
+
+```json
+{
+  "org.opencontainers.image.authors": "... <...@gmail.com>",
+  "org.opencontainers.image.created": "2025-04-03T02:15:51.405Z",
+  "org.opencontainers.image.description": "Docker image that provides a Minecraft Server for Java Edition that automatically downloads selected version at startup",
+  "org.opencontainers.image.licenses": "Apache-2.0",
+  "org.opencontainers.image.ref.name": "ubuntu",
+  "org.opencontainers.image.revision": "d6897a649ecbc16b5fb2e1500e24b64ef80270a0",
+  "org.opencontainers.image.source": "https://github.com/itzg/docker-minecraft-server",
+  "org.opencontainers.image.title": "docker-minecraft-server",
+  "org.opencontainers.image.url": "https://github.com/itzg/docker-minecraft-server",
+  "org.opencontainers.image.version": "java21"
+}
+```
+
+The labels that are most interesting are:
+
+- `org.opencontainers.image.created` : the date/time the image was built
+- `org.opencontainers.image.revision` : which maps to <https://github.com/itzg/docker-minecraft-server/commit/REVISION>
+- `org.opencontainers.image.version` : image tag and variant [as described in this page](../versions/java.md)

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

@@ -6,7 +6,7 @@ A specific file can be omitted from each reference to allow for auto-selecting t
 
 !!! warning "CurseForge API key usage"
 
-    A CurseForge API key must be allocated and set with `CF_API_KEY` [as described here](../types-and-platforms/mod-platforms/auto-curseforge.md#api-key).
+    A CurseForge API key must be allocated and set with `CF_API_KEY` (or `CF_API_KEY_FILE`) [as described here](../types-and-platforms/mod-platforms/auto-curseforge.md#api-key).
 
 ## Project-file references
 

docs/mods-and-plugins/index.md

@@ -1,134 +1,215 @@
-# Working with mods and plugins
-
-## 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 modpack platforms](../types-and-platforms/index.md).
-
-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)
-- [Feed the Beast](../types-and-platforms/mod-platforms/ftb.md)
-
-## Download automation
-
-On the left, there are sections describing some download automation options.
-
-## Mods vs Plugins
-
-The terms "mods" and "plugins" can be quite confusing. Generally, the rule of thumb is that "mods" are used by the types that run client side to modify rendering, add new blocks, and add behaviors server, such as [Forge](../types-and-platforms/server-types/forge.md) and [Fabric](../types-and-platforms/server-types/fabric.md). "Plugins" are used by the types that **only run on servers** to add behaviors, commands, etc such as [Paper](../types-and-platforms/server-types/paper.md) (which derives from [Bukkit/Spigot](../types-and-platforms/server-types/bukkit-spigot.md)). There are also some types that are [hybrids](../types-and-platforms/server-types/hybrids.md), such as Magma, that use both "mods" and "plugins"
-
-## Optional plugins, mods, and config attach points
-
-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`.
-
-`/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`.
-
-`/config`
-: contents are synchronized into `/data/config` by default, but can be changed with `COPY_CONFIG_DEST`. For example, `-v ./config:/config -e COPY_CONFIG_DEST=/data` will allow you to copy over files like `bukkit.yml` and so on directly into the server directory. The source can be changed by setting `COPY_CONFIG_SRC`. Set `SYNC_SKIP_NEWER_IN_DESTINATION=false` if you want files from `/config` to take precedence over newer files in `/data/config`.
-
-By default, the [environment variable processing](../configuration/interpolating.md) is performed on synchronized files that match the expected suffixes in `REPLACE_ENV_SUFFIXES` (by default "yml,yaml,txt,cfg,conf,properties,hjson,json,tml,toml") and are not excluded by `REPLACE_ENV_VARIABLES_EXCLUDES` and `REPLACE_ENV_VARIABLES_EXCLUDE_PATHS`. This processing can be disabled by setting `REPLACE_ENV_DURING_SYNC` to `false`.
-
-If you want old mods/plugins to be removed before the content is brought over from those attach points, then add `-e REMOVE_OLD_MODS=TRUE`. You can fine tune the removal process by specifying the `REMOVE_OLD_MODS_INCLUDE` and `REMOVE_OLD_MODS_EXCLUDE` variables, which are comma separated lists of file glob patterns. If a directory is excluded, then it and all of its contents are excluded. By default, only jars are removed. 
-
-You can also specify the `REMOVE_OLD_MODS_DEPTH` (default is 16) variable to only delete files up to a certain level.
-
-For example: `-e REMOVE_OLD_MODS=TRUE -e REMOVE_OLD_MODS_INCLUDE="*.jar" -e REMOVE_OLD_MODS_DEPTH=1` will remove all old jar files that are directly inside the `plugins/` or `mods/` directory.
-
-These paths work well if you want to have a common set of modules in a separate location, but still have multiple worlds with different server requirements in either persistent volumes or a downloadable archive.
-
-!!! information ""
-    For more flexibility with mods/plugins preparation, you can declare other directories, files, and URLs to use in [the `MODS` / `PLUGINS` variables](#modsplugins-list).
-
-
-## Zip file modpack
-
-Like the `WORLD` option above, you can specify the URL or container path of a "mod pack" to download and install into `mods` for Forge/Fabric or `plugins` for Bukkit/Spigot. To use this option pass the environment variable `MODPACK`, such as
-
-```shell
-docker run -d -e MODPACK=http://www.example.com/mods/modpack.zip ...
-```
-
-!!! note
-    The referenced URL/file must be a zip file with one or more jar files at the
-    top level of the zip archive. Make sure the jars are compatible with the
-    particular `TYPE` of server you are running.
-
-## Generic pack files
-
-To install all the server content (jars, mods, plugins, configs, etc.) from a zip or tgz file, then set `GENERIC_PACK` to the container path or URL of the archive file. This can also be used to apply a CurseForge modpack that is missing a server start script and/or Forge installer.
-
-If multiple generic packs need to be applied together, set `GENERIC_PACKS` instead, with a comma separated list of archive file paths and/or URLs to files.
-
-To avoid repetition, each entry will be prefixed by the value of `GENERIC_PACKS_PREFIX` and suffixed by the value of `GENERIC_PACKS_SUFFIX`, both of which are optional. For example, the following variables
-
-```
-GENERIC_PACKS=configs-v9.0.1,mods-v4.3.6
-GENERIC_PACKS_PREFIX=https://cdn.example.org/
-GENERIC_PACKS_SUFFIX=.zip
-```
-
-would expand to `https://cdn.example.org/configs-v9.0.1.zip,https://cdn.example.org/mods-v4.3.6.zip`.
-
-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".
-
-## 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
-
-```shell
-docker run -d -e MODS=https://www.example.com/mods/mod1.jar,/plugins/common,/plugins/special/mod2.jar ...
-```
-
-The newline delimiting allows for compose file usage like:
-```yaml
-      PLUGINS: |
-        https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/spigot
-        https://download.geysermc.org/v2/projects/floodgate/versions/latest/builds/latest/downloads/spigot
-```
-
-## Mod/Plugin URL Listing File 
-
-As an alternative to `MODS`/`PLUGINS`, the variable `MODS_FILE` or `PLUGINS_FILE` can be set with the container path or URL of a text file listing a mod/plugin URLs on each line. For example, the following
-
-     -e MODS_FILE=/extras/mods.txt
-
-would load from a file mounted into the container at `/extras/mods.txt`. That file might look like:
-
-```text
-https://edge.forgecdn.net/files/2965/233/Bookshelf-1.15.2-5.6.40.jar
-https://edge.forgecdn.net/files/2926/27/ProgressiveBosses-2.1.5-mc1.15.2.jar
-# This and next line are ignored
-#https://edge.forgecdn.net/files/3248/905/goblintraders-1.3.1-1.15.2.jar
-https://edge.forgecdn.net/files/3272/32/jei-1.15.2-6.0.3.16.jar
-https://edge.forgecdn.net/files/2871/647/ToastControl-1.15.2-3.0.1.jar
-```
-
-!!! note
-
-    Blank lines and lines that start with a `#` will be ignored
-
-    [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
-
-When the `MODPACK` option above is specified you can also instruct script to delete old mods/plugins prior to installing new ones. This behaviour is desirable in case you want to upgrade mods/plugins from downloaded zip file.
-
-To use this option pass the environment variable `REMOVE_OLD_MODS=TRUE`, such as
-
-```shell
-docker run -d -e REMOVE_OLD_MODS=TRUE -e MODPACK=http://www.example.com/mods/modpack.zip ...
-```
-
-!!! danger 
-
-    All content of the `mods` or `plugins` directory will be deleted before unpacking new content from the MODPACK or MODS.
+# Working with mods and plugins
+
+## 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 modpack platforms](../types-and-platforms/index.md).
+
+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)
+- [Feed the Beast](../types-and-platforms/mod-platforms/ftb.md)
+
+## Download automation
+
+On the left, there are sections describing some download automation options.
+
+## Mods vs Plugins
+
+The terms "mods" and "plugins" can be quite confusing. Generally, the rule of thumb is that "mods" are used by the types that run client side to modify rendering, add new blocks, and add behaviors server, such as [Forge](../types-and-platforms/server-types/forge.md) and [Fabric](../types-and-platforms/server-types/fabric.md). "Plugins" are used by the types that **only run on servers** to add behaviors, commands, etc such as [Paper](../types-and-platforms/server-types/paper.md) (which derives from [Bukkit/Spigot](../types-and-platforms/server-types/bukkit-spigot.md)). There are also some types that are [hybrids](../types-and-platforms/server-types/hybrids.md), such as Magma, that use both "mods" and "plugins".
+
+Typically, mods needs to be installed in both the client and server; however, there are some cases when only the server needs a mod. Plugins only need to be installed in the server and are never needed in the client.
+
+## Optional plugins, mods, and config attach points
+
+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`. 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.
+
+!!! example "Using Cardboard plugins with Fabric"
+
+    ```yaml
+        environment:
+          EULA: "TRUE"
+          TYPE: "FABRIC"
+          MODRINTH_PROJECTS: |
+            fabric-api
+            cardboard
+          USES_PLUGINS: true
+    ```
+
+`/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`.
+
+`/config`
+: contents are synchronized into `/data/config` by default, but can be changed with `COPY_CONFIG_DEST`. For example, `-v ./config:/config -e COPY_CONFIG_DEST=/data` will allow you to copy over files like `bukkit.yml` and so on directly into the server directory. The source can be changed by setting `COPY_CONFIG_SRC`. Set `SYNC_SKIP_NEWER_IN_DESTINATION=false` if you want files from `/config` to take precedence over newer files in `/data/config`.
+
+By default, the [environment variable processing](../configuration/interpolating.md) is performed on synchronized files that match the expected suffixes in `REPLACE_ENV_SUFFIXES` (by default "yml,yaml,txt,cfg,conf,properties,hjson,json,tml,toml") and are not excluded by `REPLACE_ENV_VARIABLES_EXCLUDES` and `REPLACE_ENV_VARIABLES_EXCLUDE_PATHS`. This processing can be disabled by setting `REPLACE_ENV_DURING_SYNC` to `false`.
+
+If you want old mods/plugins to be removed before the content is brought over from those attach points, then add `-e REMOVE_OLD_MODS=TRUE`. You can fine tune the removal process by specifying the `REMOVE_OLD_MODS_INCLUDE` and `REMOVE_OLD_MODS_EXCLUDE` variables, which are comma separated lists of file glob patterns. If a directory is excluded, then it and all of its contents are excluded. By default, only jars are removed. 
+
+You can also specify the `REMOVE_OLD_MODS_DEPTH` (default is 16) variable to only delete files up to a certain level.
+
+For example: `-e REMOVE_OLD_MODS=TRUE -e REMOVE_OLD_MODS_INCLUDE="*.jar" -e REMOVE_OLD_MODS_DEPTH=1` will remove all old jar files that are directly inside the `plugins/` or `mods/` directory.
+
+These paths work well if you want to have a common set of modules in a separate location, but still have multiple worlds with different server requirements in either persistent volumes or a downloadable archive.
+
+!!! information "Multiple source directories"
+
+    `COPY_PLUGINS_SRC`, `COPY_MODS_SRC`, `COPY_CONFIG_SRC` can each be set to a comma or newline delimited list of container directories to reference.
+
+    For example, in a compose file:
+    
+    ```yaml
+        environment:
+          # ...EULA, etc
+          TYPE: PAPER
+          # matches up to volumes declared below
+          COPY_PLUGINS_SRC: /plugins-common,/plugins-local
+        volumes:
+          - mc-data:/data
+          # For example, reference a shared directory used by several projects
+          - ../plugins-common:/plugins-common:ro
+          # and add plugins unique to this project
+          - ./plugins:/plugins-local:ro
+    ```
+
+    Alternatively, you can declare other directories along with files and URLs to use in [the `MODS` / `PLUGINS` variables](#modsplugins-list).
+
+## Applying extra configuration files
+
+You can download/copy additional configuration files or other resources before the server starts by using the `APPLY_EXTRA_FILES` environment variable. This is useful for downloading configs that you want to patch or modify during the startup process.
+
+The format uses a `<` separator between the destination path and the source URL/path. The destination path is relative to the `/data` directory. If specifying a source path, it needs to be path mounted within the container.
+
+!!! example
+
+    With `docker run`
+    
+    ```
+    -e APPLY_EXTRA_FILES=destination<source_url[,destination2<source_url2,...]
+    ```
+    
+    With a compose file:
+    ```yaml
+    environment:
+      APPLY_EXTRA_FILES: |
+        destination<source1_url
+        destination2<source2_path
+    ```
+
+!!! tip "Patch-able"
+
+The `APPLY_EXTRA_FILES` feature is processed prior to [patch processing](../configuration/interpolating.md#patching-existing-files), so this can be used as for baseline files to be patched further at runtime.
+
+## Zip file modpack
+
+Like the `WORLD` option above, you can specify the URL or container path of a "mod pack" to download and install into `mods` for Forge/Fabric or `plugins` for Bukkit/Spigot. To use this option pass the environment variable `MODPACK`, such as
+
+```shell
+docker run -d -e MODPACK=http://www.example.com/mods/modpack.zip ...
+```
+
+!!! note
+    The referenced URL/file must be a zip file with one or more jar files at the
+    top level of the zip archive. Make sure the jars are compatible with the
+    particular `TYPE` of server you are running.
+
+## Generic pack files
+
+To install all the server content (jars, mods, plugins, configs, etc.) from a zip or tgz file, then set `GENERIC_PACK` to the container path or URL of the archive file. This can also be used to apply a CurseForge modpack that is missing a server start script and/or Forge installer.
+
+If multiple generic packs need to be applied together, set `GENERIC_PACKS` instead, with a comma separated list of archive file paths and/or URLs to files.
+
+To avoid repetition, each entry will be prefixed by the value of `GENERIC_PACKS_PREFIX` and suffixed by the value of `GENERIC_PACKS_SUFFIX`, both of which are optional. For example, the following variables
+
+```
+GENERIC_PACKS=configs-v9.0.1,mods-v4.3.6
+GENERIC_PACKS_PREFIX=https://cdn.example.org/
+GENERIC_PACKS_SUFFIX=.zip
+```
+
+would expand to `https://cdn.example.org/configs-v9.0.1.zip,https://cdn.example.org/mods-v4.3.6.zip`.
+
+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".
+
+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
+
+```shell
+docker run -d -e MODS=https://www.example.com/mods/mod1.jar,/plugins/common,/plugins/special/mod2.jar ...
+```
+
+The newline delimiting allows for compose file usage like:
+```yaml
+      PLUGINS: |
+        https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/spigot
+        https://download.geysermc.org/v2/projects/floodgate/versions/latest/builds/latest/downloads/spigot
+```
+
+!!! note "Auto-removal"
+
+    Entries that are removed from the `MODS` or `PLUGINS` list will be automatically removed from the `mods` or `plugins` directory. This is useful for removing mods/plugins that are no longer needed. An empty `MODS` or `PLUGINS` list will remove all mods/plugins.
+
+!!! note "Disable processing"
+
+    To temporarily disable processing of the `MODS` or `PLUGINS` list, then comment out the `MODS` or `PLUGINS` environment variable.
+
+## Mod/Plugin URL Listing File 
+
+As an alternative to `MODS`/`PLUGINS`, the variable `MODS_FILE` or `PLUGINS_FILE` can be set with the container path or URL of a text file listing a mod/plugin URLs on each line. For example, the following
+
+     -e MODS_FILE=/extras/mods.txt
+
+would load from a file mounted into the container at `/extras/mods.txt`. That file might look like:
+
+```text
+https://edge.forgecdn.net/files/2965/233/Bookshelf-1.15.2-5.6.40.jar
+https://edge.forgecdn.net/files/2926/27/ProgressiveBosses-2.1.5-mc1.15.2.jar
+# This and next line are ignored
+#https://edge.forgecdn.net/files/3248/905/goblintraders-1.3.1-1.15.2.jar
+https://edge.forgecdn.net/files/3272/32/jei-1.15.2-6.0.3.16.jar
+https://edge.forgecdn.net/files/2871/647/ToastControl-1.15.2-3.0.1.jar
+```
+
+!!! note
+
+    Blank lines and lines that start with a `#` will be ignored
+
+    [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
+
+When the `MODPACK` option above is specified you can also instruct script to delete old mods/plugins prior to installing new ones. This behaviour is desirable in case you want to upgrade mods/plugins from downloaded zip file.
+
+To use this option pass the environment variable `REMOVE_OLD_MODS=TRUE`, such as
+
+```shell
+docker run -d -e REMOVE_OLD_MODS=TRUE -e MODPACK=http://www.example.com/mods/modpack.zip ...
+```
+
+!!! danger 
+
+    All content of the `mods` or `plugins` directory will be deleted before unpacking new content from the MODPACK or MODS.

docs/mods-and-plugins/modrinth.md

@@ -2,31 +2,117 @@
 
 [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 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 (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 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` |
+## Usage
+
+To use this feature, set the environment variable `MODRINTH_PROJECTS` to a comma or newline separated list of projects.  
+
+Each project entry can be any of the following combinations where a colon (`:`) is used to separate the different parts:
+
+```
+         Project
+         Project : Version
+         Project : Release Type
+Prefix : Project
+Prefix : Project : Version
+Prefix : Project : Release Type
+@ Listing File
+```
+
+Where:
+
+- **Project** is the project slug or ID, see below
+- **Version** is the version ID (such as "Oa9ZDzZq") or number (such as "2.21.2"). When omitted, the latest release version will be selected. Using version ID will override Minecraft and loader compatibility checks.
+- **Release Type** is `release`, `beta`, or `alpha` indicating the latest version to select.
+- **Prefix** is `datapack`, `fabric`, `forge`, or `paper`
+    - The `datapack` prefix is optional when running a vanilla server
+    - The `fabric`, `forge`, and `paper` prefixes allow for installing mods/plugins that differ from server's `TYPE`. Using [Sinytra Connector](https://modrinth.com/mod/connector) is an example of this, where Fabric mods can be loaded into a NeoForge server.
+- **Listing file** is a container path to a file containing a list of projects
+
+!!! tip "Project ID"
+
+    The project ID can be copied to the clipboard from the project page menu:
+
+    ![Modrinth copy project ID](../img/modrinth-copy-project-id.png)
+
+!!! tip "Project Slug"
+
+    The project slug is the part of the URL that follows `/mod/`, `/plugin/`, or `/datapack/`. For example, this one is "essentialsx".
+
+    ![](../img/modrinth-plugin-project-slug.png)
+
+!!! tip "Version number and ID"
+
+    The version number and ID are located in the metadata panel on a version specific page, such as <https://modrinth.com/plugin/essentialsx/version/2.21.2>
+
+    ![Version ID](../img/modrinth-version-id.drawio.png)
+
+### Examples
+            
+| Description                     | Example projects entry                                |
+|---------------------------------|-------------------------------------------------------|
+| Select latest version           | `fabric-api`                                          |
+| Select specific version         | `fabric-api:bQZpGIz0`<br/>`fabric-api:0.119.2+1.21.4` |
+| 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`                            |
+| Mod loader override             | `fabric:fabric-api`<br/>`fabric:fabric-api:bQZpGIz0`  |
+| Projects Listing File           | `@/path/to/modrinth-mods.txt`                         |
+
+### Notes
+
+!!! info "More about listing files"
+
+    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, `MODRINTH_PROJECTS` can be set to "@/extras/modrinth-mods.txt", assuming "/extras" has been added to `volumes` section, where the container file `/extras/modrinth-mods.txt` contains
+    
+    ```text
+    # This comment is ignored
+    fabric-api
+    
+    # This and previous blank line are ignore
+    cloth-config
+    datapack:terralith
+    ```
+
+!!! note "Auto-removal"
+
+    Entries that are removed from the `MODRINTH_PROJECTS` list will be automatically removed from the `mods` or `plugins` directory. This is useful for removing mods/plugins that are no longer needed. An empty `MODRINTH_PROJECTS` list will remove all mods/plugins.
+
+!!! note "Disable processing"
+
+    To temporarily disable processing of the `MODRINTH_PROJECTS` list, then comment out the `MODRINTH_PROJECTS` environment variable.
+
+## Version from Projects
+
+When the environment variable `VERSION_FROM_MODRINTH_PROJECTS` is set to "true" the Minecraft [`VERSION`](../versions/minecraft.md) will be automatically determined by looking at the most recent version of Minecraft that is supported by all the projects provided in `MODRINTH_PROJECTS`.
+
+!!! example
+
+    Given the environment variables
+    
+    ```yaml
+        MODRINTH_PROJECTS: |
+          viaversion
+          viabackwards
+          griefprevention
+          discordsrv
+        VERSION_FROM_MODRINTH_PROJECTS: true
+    ```
+    
+    Let's say all are supported on Minecraft up to 1.21.8 except griefprevention, which is only supported up to 1.21.7. In that case, `VERSION` will be automatically set to 1.21.7.
 
 ## Extra options
 
 `MODRINTH_DOWNLOAD_DEPENDENCIES`
 : Can be set to `none` (the default), `required`, or `optional` to download required and/or optional dependencies.
 
-`MODRINTH_ALLOWED_VERSION_TYPE`
+`MODRINTH_PROJECTS_DEFAULT_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`. Setting to `beta` will pick up both release and beta versions. Setting to `alpha` will pick up release, beta, and alpha versions.
 
+`MODRINTH_LOADER`
+: When using a custom server, set this to specify which loader type will be requested during lookups
+

docs/mods-and-plugins/packwiz.md

@@ -5,7 +5,8 @@
 To configure server mods using a packwiz modpack, set the `PACKWIZ_URL` environment variable to the location of your `pack.toml` modpack definition:
 
 ```
-docker run -d -v /path/on/host:/data -e TYPE=FABRIC \
+docker run -d --pull=always \
+    -v /path/on/host:/data -e TYPE=FABRIC \
     -e "PACKWIZ_URL=https://example.com/modpack/pack.toml" \
     itzg/minecraft-server
 ```

docs/requirements.txt

@@ -1,7 +1,25 @@
-mkdocs-material == 9.5.50
-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.3
+click==8.3.1
+colorama==0.4.6
+deepmerge==2.0
+ghp-import==2.1.0
+griffe==1.15.0
+Jinja2==3.1.6
+Markdown==3.10.1
+MarkupSafe==3.0.3
+mergedeep==1.3.4
+mkdocs==1.6.1
+mkdocs-autorefs==1.4.3
+mkdocs-get-deps==0.2.0
+mkdocstrings==1.0.2
+mkdocstrings-python==2.0.1
+packaging==26.0
+pathspec==1.0.4
+platformdirs==4.5.1
+Pygments==2.19.2
+pymdown-extensions==10.20.1
+python-dateutil==2.9.0.post0
+PyYAML==6.0.3
+pyyaml_env_tag==1.1
+six==1.17.0
+watchdog==6.0.0
+# zensical @ file:///

docs/sending-commands/commands.md

@@ -1,5 +1,5 @@
 ---
-title: Sending commands
+title: With Docker
 ---
 
 [RCON](http://wiki.vg/RCON) is enabled by default, so you can `exec` into the container to
@@ -24,9 +24,9 @@ _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 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
-            |                     |
-            +- container name     +- Minecraft commands start here
+docker exec --user 1000 mc mc-send-to-console op player
+                        |                     |
+                        +- container name     +- Minecraft commands start here
 ```
 
 ## Enabling interactive console
@@ -50,12 +50,20 @@ In order to attach and interact with the Minecraft server make sure to enable TT
         tty: true
     ```
 
-With that you can attach and interact at any time using
+With that you can attach and interact at any time using the following, replacing the `{...}` placeholders.
 
-    docker attach mc
+...when container is created with `docker run`
+```
+docker attach {container name or ID}
+```
+
+...or when declared using a compose file
+```
+docker compose attach {service name}
+```
 
 and then Control-p Control-q to **detach**.
 
 !!! info "RCON is required for fully interactive, color console"
 
-    RCON must be enabled, which is the default, in order to use a fully interactive console with auto-completion and colorized log output. 
+    RCON must be enabled, which is the default, in order to use a fully interactive console with auto-completion and colorized log output.

docs/sending-commands/ssh.md

@@ -0,0 +1,70 @@
+---
+title: Over SSH
+---
+
+The container can host an SSH console. It is enabled by setting `ENABLE_SSH` to `true`.
+The SSH server only supports password based authentication. The password is the same as the RCON password.
+
+!!! question
+    See [the RCON password](../configuration/server-properties.md/#rcon-password) section under configuration/server-properties for more information on how to set an RCON password.
+
+The SSH server runs on port `2222` inside the container.
+
+??? tip "Tip: Exposing the SSH port"
+
+    !!! warning "Security Implications"
+        By default, publishing ports in Docker binds them to all network interfaces (`0.0.0.0`), making the SSH console accessible to any device that can reach your host machine.
+        
+        Since the SSH console grants **full administrative access** to your server, it is critical to use a strong [RCON password](../configuration/server-properties.md/#rcon-password). 
+        
+        If you wish to restrict access to the local machine only, refer to the [Docker documentation](https://docs.docker.com/engine/network/port-publishing/#publishing-ports) on binding to specific IP addresses (e.g., `127.0.0.1:2222:2222`).
+      
+        If SSH access is only intended for inter-container connections, consider **NOT** forwarding the port to the host machine, and putting the containers in a shared [Docker network](https://docs.docker.com/engine/network/#user-defined-networks).
+
+    ```yaml title="compose.yaml"
+    services:
+      mc:
+        ports:
+          - '25565:25565'
+          - '2222:2222'
+    ```
+
+## Connecting
+
+Connecting should be as simple as running
+```bash
+ssh anyuser@127.0.0.1 -p 2222
+```
+and typing in the RCON password.
+
+## Environment variables
+
+| Environment Variable | Usage                     | Default |
+| -------------------- | ------------------------- | ------- |
+| `ENABLE_SSH`   | Enable remote SSH console | `false` |
+
+
+## Example
+
+```yaml title="compose.yaml"
+services:
+  mc:
+    image: itzg/minecraft-server:latest
+    pull_policy: daily
+    tty: true
+    stdin_open: true
+    ports:
+      - "25565:25565"
+      - "2222:2222"
+    environment:
+      EULA: "TRUE"
+      ENABLE_SSH: true
+      RCON_PASSWORD_FILE: /run/secrets/rcon_pass
+    volumes:
+      # attach the relative directory 'data' to the container's /data path
+      - ./data:/data
+    
+secrets:
+  rcon_pass:
+    file: ./rcon_password
+```

docs/sending-commands/websocket.md

@@ -0,0 +1,90 @@
+---
+title: With WebSocket
+---
+
+With `WEBSOCKET_CONSOLE` set to `true`, logs can be streamed, and commands sent, over a WebSocket connection.
+The API is available on `/console`.
+
+## Password
+A password must be supplied using the `Sec-WebSocket-Protocol` header. This is done by putting `mc-server-runner-ws-v1` in the first slot, and the password in the second. The password can be set with `RCON_PASSWORD` or `WEBSOCKET_PASSWORD`. The latter overwrites the former. Authentication can be disabled with `WEBSOCKET_DISABLE_AUTHENTICATION`.
+??? Example "Examples"
+    ```js title="JavaScript example"
+    let socket = new WebSocket("http://localhost:80/websocket", ["mc-server-runner-ws-v1", "rcon-password"]);
+    ```
+
+## Allowed origins
+A list of comma-separated allowed origins should be supplied with `WEBSOCKET_ALLOWED_ORIGINS`. Origin checking can be disabled with `WEBSOCKET_DISABLE_ORIGIN_CHECK`.
+
+## Listen address
+The listen address and port can be set with `WEBSOCKET_ADDRESS` (defaults to `0.0.0.0:80`), but it's recommended to listen on all interfaces when running in Docker.
+
+## Log history
+When a connection is established, the last 50 (by default, configurable with `WEBSOCKET_LOG_BUFFER_SIZE`) log lines are sent with a `logHistory` type message.
+
+??? tip "Tip: Remember to forward the WebSocket port on the host"
+
+    !!! warning "Security Implications"
+        By default, publishing ports in Docker binds them to all network interfaces (`0.0.0.0`), making the WebSocket console accessible to any device that can reach your host machine.
+        
+        Since the WebSocket console grants **full administrative access** to your server, it is critical to use a strong [WebSocket password](#password) or [RCON password](../configuration/server-properties.md/#rcon-password).
+      
+        If you wish to restrict access to the local machine only, refer to the [Docker documentation](https://docs.docker.com/engine/network/port-publishing/#publishing-ports) on binding to specific IP addresses (e.g., `127.0.0.1:80:80`).
+        
+        If WebSocket access is only intended for inter-container connections, consider **NOT** forwarding the port to the host machine, and putting the containers in a shared [Docker network](https://docs.docker.com/engine/network/#user-defined-networks).
+
+    ```yaml title="compose.yaml"
+    services:
+      mc:
+        ports:
+          - '25565:25565'
+          - '80:80'
+    ```
+
+## Environment variables
+| Environment Variable               | Usage                                                      | Default      |
+| ---------------------------------- | ---------------------------------------------------------- | ------------ |
+| `WEBSOCKET_CONSOLE`                | Allow remote shell over WebSocket                          | `false`      |
+| `WEBSOCKET_ADDRESS`                | Bind address for WebSocket server                          | `0.0.0.0:80` |
+| `WEBSOCKET_DISABLE_ORIGIN_CHECK`   | Disable checking if origin is trusted                      | `false`      |
+| `WEBSOCKET_ALLOWED_ORIGINS`        | Comma-separated list of trusted origins                    | ` `          |
+| `WEBSOCKET_PASSWORD`               | Password will be the same as RCON_PASSWORD if unset        | ` `          |
+| `WEBSOCKET_DISABLE_AUTHENTICATION` | Disable WebSocket authentication                           | `false`      |
+| `WEBSOCKET_LOG_BUFFER_SIZE`        | Number of log lines to save and send to connecting clients | `50`         |
+
+## API Schema
+```ts title="API Schema"
+interface StdinMessage {
+  type: "stdin";
+  data: string;
+}
+
+interface StdoutMessage {
+  type: "stdout";
+  data: string;
+}
+
+interface StderrMessage {
+  type: "stderr";
+  data: string;
+}
+
+interface LogHistoryMessage {
+  type: "logHistory";
+  lines: string[];
+}
+
+interface AuthFailureMessage {
+  type: "authFailure";
+  reason: string;
+}
+
+// Messages sent from Client -> Server
+export type ClientMessage = StdinMessage;
+
+// Messages sent from Server -> Client
+export type ServerMessage =
+  | StdoutMessage
+  | StderrMessage
+  | LogHistoryMessage
+  | AuthFailureMessage;
+```

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

@@ -7,56 +7,109 @@ To manage a CurseForge modpack automatically with upgrade support, pinned or lat
 !!! warning "CurseForge API key usage"
 
     A CurseForge API key is **required** to use this feature. Go to their [developer console](https://console.curseforge.com/), generate an API key, and set the environment variable `CF_API_KEY`.
-    
+
     When entering your API Key in a docker compose file you will need to escape any `$` character with a second `$`. Refer to [this compose file reference section](https://docs.docker.com/compose/compose-file/compose-file-v3/#variable-substitution) for more information.
-    
+
     Example if your key is `$11$22$33aaaaaaaaaaaaaaaaaaaaaaaaaa`:
-    ```yaml
+    ```yaml title="compose.yaml"
     environment:
       CF_API_KEY: '$$11$$22$$33aaaaaaaaaaaaaaaaaaaaaaaaaa'
     ```
     If you use `docker run` you will need to make sure to use single quotes:
-    
+
     ```shell
     docker run ... -e CF_API_KEY='$11$22$33aaaaaaaaaaaaaaaaaaaaaaaaaa'
     ```
-    
-    To avoid exposing the API key, it is highly recommended to use a `.env` file, which is [loaded automatically by docker compose](https://docs.docker.com/compose/environment-variables/set-environment-variables/#substitute-with-an-env-file). `$`'s in the value still need to escaped with a second `$` and the variable needs to be referenced from the compose file, such as:
-    ```yaml
+
+    To avoid exposing the API key, it is highly recommended to use a `.env` file, which is [loaded automatically by docker compose](https://docs.docker.com/compose/environment-variables/set-environment-variables/#substitute-with-an-env-file). You **do not** need to escape `$`'s with a second `$` in the `.env` file **as long as the key is wrapped in single quotes**.
+
+    ```title=".env"
+    CF_API_KEY='$11$22$33aaaaaaaaaaaaaaaaaaaaaaaaaa'
+    ```
+
+    The variable should to be referenced from the compose file, such as:
+
+    ```yaml title="compose.yaml"
     environment:
       CF_API_KEY: ${CF_API_KEY}
     ```
-    
-    To use the equivalent with `docker run` you need to specify the `.env` file explicitly:
+
+    The .env file should be placed in the same directory as your compose file like so:
+
     ```
+    minecraft-server/
+    ├── .env
+    ├── compose.yaml
+    ├── data/
+    ```
+
+    To use the equivalent with `docker run` you need to specify the `.env` file explicitly:
+    ```shell
     docker run --env-file=.env itzg/minecraft-server
     ```
 
+    Alternately you can use [docker secrets](https://docs.docker.com/compose/how-tos/use-secrets/) with a `CF_API_KEY_FILE` environment variable:
+    ```yaml title="compose.yaml"
+    service:
+      environment:
+        CF_API_KEY_FILE: /run/secrets/cf_api_key
+      secrets:
+        - cf_api_key
+
+    secrets:
+      cf_api_key:
+        file: cf_api_key.secret
+    ```
+
+
 !!! note
     Be sure to use the appropriate [image tag for the Java version compatible with the modpack](../../versions/java.md).
-    
+
     Most modpacks require a good amount of memory, so it best to set `MEMORY` to at least "4G" since the default is only 1 GB.
 
 ## Usage
 
 Use one of the following to specify the modpack to install:
 
-Pass a page URL to the modpack or a specific file with `CF_PAGE_URL` such as the modpack page "https://www.curseforge.com/minecraft/modpacks/all-the-mods-8" or a specific file "https://www.curseforge.com/minecraft/modpacks/all-the-mods-8/files/4248390". For example:
+Pass a page URL to the modpack or a specific file with `CF_PAGE_URL` such as the modpack page "https://www.curseforge.com/minecraft/modpacks/all-the-mods-8" or a specific file "https://www.curseforge.com/minecraft/modpacks/all-the-mods-8/files/4248390".
 
-```
--e TYPE=AUTO_CURSEFORGE -e CF_PAGE_URL=https://www.curseforge.com/minecraft/modpacks/all-the-mods-8
-```
+!!! example "Using CF_PAGE_URL"
+
+    ```yaml title="Using compose.yaml"
+    environment:
+      # ...
+      MODPACK_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/all-the-mods-8
+    ```
+
+    ```title="Using docker run"
+    docker run -e CF_API_KEY=${CF_API_KEY} -e TYPE=AUTO_CURSEFORGE -e CF_PAGE_URL=https://www.curseforge.com/minecraft/modpacks/all-the-mods-8
+    ```
 
 Instead of a URL, the modpack slug can be provided as `CF_SLUG`. The slug is the short identifier visible in the URL after "/modpacks/", such as
 
 ![cf-slug](../../img/cf-slug.png)
 
-For example:
-```
--e TYPE=AUTO_CURSEFORGE -e CF_SLUG=all-the-mods-8
-```
+!!! example "Using CF_SLUG"
 
-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.
+    ```yaml title="Using compose.yaml"
+    environment:
+      # ...
+      MODPACK_PLATFORM: AUTO_CURSEFORGE
+      # allocate from https://console.curseforge.com/ and set in .env file
+      CF_API_KEY: ${CF_API_KEY}
+      CF_SLUG: all-the-mods-8
+    ```
+
+    ```title="Using docker run"
+    docker run -e CF_API_KEY=${CF_API_KEY} -e TYPE=AUTO_CURSEFORGE -e CF_SLUG=all-the-mods-8
+    ```
+
+### 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,6 +135,32 @@ 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.
+
+### Custom modloader versions
+
+By default, AUTO_CURSEFORGE will use the exact modloader version declared by the modpack. However, you can override the modloader version by setting the following environment variable:
+
+- `CF_MOD_LOADER_VERSION`: Override the mod loader version (e.g., `43.4.22`)
+
+!!! example "Override mod loader version"
+
+    ```yaml
+    environment:
+      MODPACK_PLATFORM: AUTO_CURSEFORGE
+      CF_API_KEY: ${CF_API_KEY}
+      CF_SLUG: all-the-mods-8
+      CF_MOD_LOADER_VERSION: "43.4.22"
+    ```
+
+    ```title="Using docker run"
+    docker run -e CF_MOD_LOADER_VERSION=43.4.22 -e CF_SLUG=my-fabric-pack ...
+    ```
+
+!!! warning "Compatibility"
+
+    Using a custom modloader version that differs significantly from what the modpack was designed for may cause compatibility issues. Use this feature carefully and test thoroughly.
+
 ## 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.
@@ -93,12 +172,12 @@ For mod, modpacks, and world files that are not allowed for automated download,
 !!! example
 
     Assuming Docker compose is being used:
-    
-    1. Create a directory next to the `docker-compose.yml` file. The name doesn't matter, but "downloads" is the common convention
+
+    1. Create a directory next to the `compose.yaml` 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 compose up -d` to apply the changes
-    
+
     ```yaml
         volumes:
           ./downloads:/downloads
@@ -113,7 +192,8 @@ If you wish to use an unpublished modpack zip, set the container path to the fil
     ```yaml
     services:
       mc:
-        image: itzg/minecraft-server
+        image: itzg/minecraft-server:latest
+        pull_policy: daily
         environment:
           EULA: true
           MODPACK_PLATFORM: AUTO_CURSEFORGE
@@ -126,7 +206,7 @@ If you wish to use an unpublished modpack zip, set the container path to the fil
     ```
 
     where an exported manifest file should look like:
-    
+
     ```json
     {
       "minecraft": {
@@ -160,13 +240,13 @@ If you wish to use an unpublished modpack zip, set the container path to the fil
 
 ## Exclude client mods
 
-Quite often there are mods that need to be excluded, such as ones that did not properly declare as a client mod via the file's game versions. Similarly, there are some mods that are incorrectly tagged as client only. The following describes two options to exclude/include mods:
+Quite often there are mods that need to be excluded, such as ones that did not properly declare as a client mod via the file's game versions. Similarly, there are some mods that are incorrectly tagged as client only. The following describes some options to exclude/include mods:
 
-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.
+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. Alternatively, all mods can be excluded by setting `CF_EXCLUDE_ALL_MODS` to `true`
 
 !!! 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:
@@ -179,9 +259,20 @@ If needing to iterate on the options above, set `CF_FORCE_SYNCHRONIZE` to "true"
 !!! important
     These options are provided to empower you to get your server up and running quickly. Please help out by reporting an issue with the respective mod project. Ideally mod developers should [use correct registrations for one-sided client mods](https://docs.minecraftforge.net/en/latest/concepts/sides/#writing-one-sided-mods). Understandably, those code changes may be non-trivial, so mod authors can also add "Client" to the game versions when publishing.
 
+!!! tip "Embedded comments"
+
+    Comments can be embedded in the list using the `#` character.
+
+    ```yaml
+          CF_EXCLUDE_MODS: |
+            # Exclude client-side mods not published correctly
+            creative-core
+            default-options
+    ```
+
 ## Excluding Overrides Files
 
-Modpack zip files typically include an `overrides` subdirectory that may contain 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 `CF_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. 
+Modpack zip files typically include an `overrides` subdirectory that may contain 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 `CF_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
 
@@ -194,15 +285,15 @@ Ant-style paths can include the following globbing/wildcard symbols:
 | `?`    | Matches one character                                   |
 
 !!! example
-    
+
     The following compose `environment` entries show how to exclude Iris and Sodium mods from the overrides
-    
+
     ```yaml
       CF_OVERRIDES_EXCLUSIONS: mods/iris*.jar,mods/sodium*.jar
     ```
-    
+
     or using newline delimiter, which improves maintainability
-    
+
     ```yaml
       CF_OVERRIDES_EXCLUSIONS: |
         mods/iris*.jar
@@ -218,7 +309,7 @@ Some modpacks come with world/save data via a worlds file and/or the overrides p
 
 ## 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`.
+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, newline delimited list, or a file globbing pattern to `CF_IGNORE_MISSING_FILES`.
 
 !!! hint
 
@@ -235,6 +326,7 @@ Some mods use temporary files from the modpack and delete them when finished. Ot
       environment:
         CF_IGNORE_MISSING_FILES: |
           mods/gregtech-2.6.2-beta.jar
+          mods/*.jar
     ```
 
 

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

@@ -11,20 +11,20 @@ variable. A CurseForge server modpack is available together with its respective
 client modpack at <https://www.curseforge.com/minecraft/modpacks> .
 
 Now you can add a `-e CF_SERVER_MOD=name_of_modpack.zip` to your command-line.
-
-    docker run -d -v /path/on/host:/data -e TYPE=CURSEFORGE \
-        -e CF_SERVER_MOD=SkyFactory_4_Server_4.1.0.zip \
-        -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
-
+```shell
+docker run -d --pull=always -v /path/on/host:/data -e TYPE=CURSEFORGE \
+    -e CF_SERVER_MOD=SkyFactory_4_Server_4.1.0.zip \
+    -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
+```
 If you want to keep the pre-download modpacks separate from your data directory,
 then you can attach another volume at a path of your choosing and reference that.
 The following example uses `/modpacks` as the container path as the pre-download area:
-
-    docker run -d -v /path/on/host:/data -v /path/to/modpacks:/modpacks \
-        -e TYPE=CURSEFORGE \
-        -e CF_SERVER_MOD=/modpacks/SkyFactory_4_Server_4.1.0.zip \
-        -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
-
+```shell
+docker run -d --pull=always -v /path/on/host:/data \
+    -v /path/to/modpacks:/modpacks -e TYPE=CURSEFORGE \
+    -e CF_SERVER_MOD=/modpacks/SkyFactory_4_Server_4.1.0.zip \
+    -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
+```
 ### Modpack data directory
 
 By default, CurseForge modpacks are expanded into the sub-directory `/data/FeedTheBeast` and executed from there. (The default location was chosen for legacy reasons, when Curse and FTB were maintained together.)

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

@@ -30,12 +30,8 @@ If a specific `FTB_MODPACK_VERSION_ID` was not specified, simply restart the con
 The following example runs the latest version of [FTB Presents Direwolf20 1.12](https://ftb.neptunepowered.org/pack/ftb-presents-direwolf20-1-12/):
 
 ``` shell
-docker run -d --name mc-ftb -e EULA=TRUE \
-  -e TYPE=FTBA -e FTB_MODPACK_ID=31 \
-  -p 25565:25565 \
-  itzg/minecraft-server:java8-multiarch
+docker run -d --pull=always -v /path/on/host:/data \
+    -e EULA=TRUE -e TYPE=FTBA \
+    -e FTB_MODPACK_ID=31 -p 25565:25565 \
+    itzg/minecraft-server:java8-multiarch
 ```
-
-!!! note
-
-    Normally you will also add `-v` volume for `/data` since the mods and config are installed there along with world data.

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

@@ -0,0 +1,54 @@
+# Auto-setup GTNH server
+
+[GT New Horizons (GTNH)](https://www.gtnewhorizons.com/) is a Minecraft 1.7.10 modpack maintained and supported by dedicated community members! With over 10 years in development, GTNH offers a carefully balanced and immersive experience to challenge players as they climb through the 15 tiers of technology. The ultimate goal of GTNH is to build the Stargate, an interdimensional teleporter and the symbol for absolute prestige, aptitude, and determination. 
+
+As GTNH is a complex modpack with some specifics it has its own `TYPE` to simplify the deployment and update process. To use it set the environment variable `TYPE` to "GTNH". 
+
+Configuration options with defaults:
+
+- `GTNH_PACK_VERSION`=latest
+- `GTNH_DELETE_BACKUPS`=false
+- `SKIP_GTNH_UPDATE_CHECK`=false
+
+## Set Modpack version
+
+As GTNH is a Minecraft 1.7.10 modpack, when using it your minecraft version is set to 1.7.10 by default. The [modpack version](https://www.gtnewhorizons.com/downloads/) can be selected by setting `GTNH_PACK_VERSION` to `latest`, `latest-dev` or any specific version number. `latest` will automatically select the latest full release version available and deploy the server with it (Note: this will also automatically update the server on startup). `latest-dev` does the same but selects the latest version marked as beta or RC (it won't select a full release version even if a newer exist). The third (and recommended) option is setting the server to a specific version like `2.8.1` to manage updates manually.
+
+> To actively prevent an update from happening you can set the environment variable `SKIP_GTNH_UPDATE_CHECK` to true this will prevent any update check from running, but will also prevent the server install from running, so just set it after the initial setup.
+
+## Resource requirements
+
+**Recommended Minimum:**
+
+  - 2-4 cpu cores
+  - 6GB of RAM +0.5GB per extra player (early game)
+  - 6GB of RAM +1GB per extra player (~UV tier+)
+  - 20GB+ storage. HDD is feasible, SSD is preferred
+
+For more details regarding the server setup consult the [modpack wiki](https://wiki.gtnewhorizons.com/wiki/Server_Setup).
+
+## Java Version
+
+GTNH supports java 8 and 17+ (java 17+ is always recommended for maximum performance). The server will only start when a supported version of itzg/docker-minecraft-server is used.
+
+For optimal performance choose java25 with GTNH 2.8.0 and later.
+
+## Config backups
+
+During version upgrade, the server will replace all config files to make sure all new features are setup as intended. The old config files are stored in a backup folder in the data directory, for you to use as reference for manual reapplication of your changed settings. Set the environment variable `GTNH_DELETE_BACKUPS` to true to delete all backup folders at startup. 
+
+## server.properties defaults
+
+To deliver the intended GTNH by default, when running a GTNH server, the following options are set in `server.properties`. It is recommended to leave them as is, but if you know what you are doing feel free to play around with them.
+
+- `LEVEL_TYPE=rwg`
+- `DIFFICULTY=hard`
+- `ALLOW_FLIGHT=true`
+- `ENABLE_COMMAND_BLOCK=true`
+- `MOTD=Greg Tech New Horizon <current-pack-version>`
+
+## Java args
+
+With java 17+ the server starts with `-Dfml.readTimeout=180 @java9args.txt -jar lwjgl3ify-forgePatches.jar`. 
+
+With java 8 the server stars with `-XX:+UseStringDeduplication -XX:+UseCompressedOops -XX:+UseCodeCacheFlushing -Dfml.readTimeout=180 -jar forge-1.7.10-10.13.4.1614-1.7.10-universal.jar`

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

@@ -1,109 +1,110 @@
-# Modrinth Modpacks
-
-[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
-
-The desired modpack project is specified with the `MODRINTH_MODPACK` environment variable and must be one of:
-
-- The project "slug", which is located in the URL shown here:
-
-  ![](../../img/modrinth-project-slug.drawio.png)
-
-- The project ID, which is located in the bottom of the left panel, shown here
-
-  ![](../../img/modrinth-project-id.drawio.png)
-
-- The project page URL, such as <https://modrinth.com/modpack/cobblemon-fabric>. As described below, this can further be the page URL of a modpack's version page.
-
-- A custom URL of a hosted [mrpack file](https://support.modrinth.com/en/articles/8802351-modrinth-modpack-format-mrpack)
-
-- The container path to a local [mrpack file](https://support.modrinth.com/en/articles/8802351-modrinth-modpack-format-mrpack)
-
-## Modpack version
-
-The automatic modpack version resolving can be narrowed in a few ways:
-
-The latest release or beta version, respectively, of the Modrinth modpack is selected when `VERSION` is "LATEST" or "SNAPSHOT". That can be overridden by setting `MODRINTH_DEFAULT_VERSION_TYPE` to "release", "beta", or "alpha".
-
-The resolved modpack version can be narrowed by setting `VERSION` to a specific Minecraft version, such as "1.19.2".
-
-The selected version can also be narrowed to a particular mod loader by setting `MODRINTH_LOADER` to either "forge", "fabric", or "quilt".
-
-Instead of auto resolving, a specific version of modpack file can be specified by passing the version's page URL to `MODRINTH_MODPACK`, such as <https://modrinth.com/modpack/cobblemon-fabric/version/1.3.2> or by setting `MODRINTH_VERSION` to the version ID or number located in the Metadata section, as shown here
-
-![](../../img/modrinth-version-id.drawio.png)
-
-## Ignore missing files
-
-Some mods, such as [MCInstance Loader](https://modrinth.com/mod/mcinstance-loader), use temporary files from the modpack and delete them when finished. 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 `MODRINTH_IGNORE_MISSING_FILES`.
-
-!!! example
-
-    In a Compose file
-    ```yaml
-      environment:
-        MODRINTH_IGNORE_MISSING_FILES: |
-          config/mcinstanceloader/pack.mcinstance
-    ```
-
-## Excluding files
-
-To exclude client mods that are incorrectly declared by the modpack as server-compatible, set `MODRINTH_EXCLUDE_FILES` to a comma or newline delimited list of partial file names to exclude. 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_EXCLUDE_FILES: |
-        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
-    ```
-
+# Modrinth Modpacks
+
+[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
+
+The desired modpack project is specified with the `MODRINTH_MODPACK` environment variable and must be one of:
+
+- The project "slug", which is located in the URL shown here:
+
+  ![](../../img/modrinth-project-slug.drawio.png)
+
+- The project ID, which is located in the bottom of the left panel, shown here
+
+  ![](../../img/modrinth-project-id.drawio.png)
+
+- The project page URL, such as <https://modrinth.com/modpack/cobblemon-fabric>. As described below, this can further be the page URL of a modpack's version page.
+
+- A custom URL of a hosted [mrpack file](https://support.modrinth.com/en/articles/8802351-modrinth-modpack-format-mrpack)
+
+- The container path to a local [mrpack file](https://support.modrinth.com/en/articles/8802351-modrinth-modpack-format-mrpack)
+
+## Modpack version
+
+The automatic modpack version resolving can be narrowed in a few ways:
+
+The latest release or beta version, respectively, of the Modrinth modpack is selected when `VERSION` is "LATEST" or "SNAPSHOT". That can be overridden by setting `MODRINTH_MODPACK_VERSION_TYPE` to "release", "beta", or "alpha".
+
+The resolved modpack version can be narrowed by setting `VERSION` to a specific Minecraft version, such as "1.19.2".
+
+The selected version can also be narrowed to a particular mod loader by setting `MODRINTH_LOADER` to either "forge", "fabric", or "quilt".
+
+Instead of auto resolving, a specific version of modpack file can be specified by passing the version's page URL to `MODRINTH_MODPACK`, such as <https://modrinth.com/modpack/cobblemon-fabric/version/1.3.2> or by setting `MODRINTH_VERSION` to the version ID or number located in the Metadata section, as shown here
+
+![](../../img/modrinth-version-id.drawio.png)
+
+## Ignore missing files
+
+Some mods, such as [MCInstance Loader](https://modrinth.com/mod/mcinstance-loader), use temporary files from the modpack and delete them when finished. In order to avoid the installer from detecting the absent file(s) and re-installing, those files can be ignored by passing a comma, newline delimited list or, a file globbing pattern to `MODRINTH_IGNORE_MISSING_FILES`.
+
+!!! example
+
+    In a Compose file
+    ```yaml
+      environment:
+        MODRINTH_IGNORE_MISSING_FILES: |
+          config/mcinstanceloader/pack.mcinstance
+          mods/*.jar
+    ```
+
+## Excluding files
+
+To exclude client mods that are incorrectly declared by the modpack as server-compatible, set `MODRINTH_EXCLUDE_FILES` to a comma or newline delimited list of partial file names to exclude. 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_EXCLUDE_FILES: |
+        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

@@ -12,7 +12,7 @@ Run a Bukkit/Spigot server type by setting the environment variable `TYPE` to "B
     ```
     docker run ... -e TYPE=SPIGOT ...
     ```
-    
+
     Compose
     ```yaml
         environment:
@@ -50,3 +50,16 @@ Canyon is on a temporary hiatus, so by default the final build from GitHub will
 
     -e CANYON_BUILD=6
     -e CANYON_BUILD=26
+
+### Poseidon
+
+[Poseidon](https://github.com/retromcorg/Project-Poseidon) is a fork of CraftBukkit for Minecraft Beta 1.7.3. It includes multiple enhancements whilst also retaining compatibility with old Bukkit plugins.
+
+    -e VERSION=b1.7.3 -e TYPE=CANYON
+
+!!! important
+    Only `VERSION=b1.7.3` is supported. Since that version pre-dates the health check mechanism used by this image, that will need to be disabled by setting `DISABLE_HEALTHCHECK=true`.
+
+### Uberbukkit
+
+[Uberbukkit](https://github.com/Moresteck/uberbukkit) is a fork of CraftBukkit for Minecraft Beta with Multi version support, supports b1.0 - b1.7.3

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

@@ -1,27 +1,67 @@
-Enable [Fabric server](https://fabricmc.net/) mode by adding a `-e TYPE=FABRIC` to your command-line.
+A [Fabric server](https://fabricmc.net/) can be automatically downloaded, upgraded, and run by setting the environment variable TYPE to "FABRIC"
 
-```
-docker run -d -v /path/on/host:/data \
-    -e TYPE=FABRIC \
-    -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
-```
+!!! example
+
+    Using `docker run` command line
+
+    ```shell
+    docker run -d --pull=always -e EULA=TRUE -e TYPE=FABRIC -p 25565:25565 itzg/minecraft-server
+    ```
+    
+    In a compose file service:
+    
+    ```yaml
+    environment:
+      EULA: TRUE
+      TYPE: FABRIC
+    ```
 
 By default, the container will install the latest [fabric server launcher](https://fabricmc.net/use/server/), using the latest [fabric-loader](https://fabricmc.net/wiki/documentation:fabric_loader) against the minecraft version you have defined with `VERSION` (defaulting to the latest vanilla release of the game).
 
 A specific loader or launcher version other than the latest can be requested using `FABRIC_LOADER_VERSION` and `FABRIC_LAUNCHER_VERSION` respectively, such as:
 
-```
-docker run -d -v /path/on/host:/data ... \
-    -e TYPE=FABRIC \
-    -e FABRIC_LAUNCHER_VERSION=0.10.2 \
-    -e FABRIC_LOADER_VERSION=0.13.1
-```
+!!! example "Using launcher and loader versions"
+
+    With docker run
+
+    ```shell
+    docker run -d ... \
+        -e TYPE=FABRIC \
+        -e FABRIC_LAUNCHER_VERSION=0.10.2 \
+        -e FABRIC_LOADER_VERSION=0.13.1
+    ```
+    
+    In a compose file service:
+    
+    ```yaml
+    environment:
+      EULA: TRUE
+      TYPE: FABRIC
+      FABRIC_LAUNCHER_VERSION: 0.10.2
+      FABRIC_LOADER_VERSION: 0.13.1
+    ```
 
 !!! note
 
-    If you wish to use an alternative launcher you can:  
+    See the [Working with mods and plugins](../../mods-and-plugins/index.md) section to set up Fabric mods and configuration.
 
-    - Provide the path to a custom launcher jar available to the container with `FABRIC_LAUNCHER`, relative to `/data` (such as `-e FABRIC_LAUNCHER=fabric-server-custom.jar`)
-    - Provide the URL to a custom launcher jar with `FABRIC_LAUNCHER_URL` (such as `-e FABRIC_LAUNCHER_URL=http://HOST/fabric-server-custom.jar`)
+## Fabric API
 
-See the [Working with mods and plugins](../../mods-and-plugins/index.md) section to set up Fabric mods and configuration.
+As [mentioned on the Fabric download page](https://fabricmc.net/use/installer/), most mods will require the Fabric API mod to be installed. That can be easily done by utilizing [the Modrinth downloads feature](../../mods-and-plugins/modrinth.md), such as adding this to the `environment` of a compose file service:
+
+```yaml
+      TYPE: FABRIC
+      MODRINTH_PROJECTS: |
+        fabric-api
+```
+
+## Alternate launcher
+
+If you wish to use an alternative launcher you can:  
+
+- Provide the path to a custom launcher jar available to the container with `FABRIC_LAUNCHER`, relative to `/data` (such as `-e FABRIC_LAUNCHER=fabric-server-custom.jar`)
+- Provide the URL to a custom launcher jar with `FABRIC_LAUNCHER_URL` (such as `-e FABRIC_LAUNCHER_URL=http://HOST/fabric-server-custom.jar`)
+
+## Force re-install
+
+If the Fabric launcher jar becomes corrupted you can temporarily set FABRIC_FORCE_REINSTALL to "true" to have it re-installed on next startup.

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

@@ -1,8 +1,16 @@
 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
 
-    ```
+    ```shell
     docker run -e TYPE=FORGE ...
     ```
     
@@ -14,9 +22,10 @@ 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
 
-    ```
+    ```shell
     docker run -e TYPE=FORGE -e VERSION=1.12.2 -e FORGE_VERSION=14.23.5.2854 ...
     ```
     
@@ -36,6 +45,11 @@ In both of the cases above, there is no need for the `VERSION` or `FORGE_VERSION
 
     If an error occurred while installing Forge, it might be possible to resolve by temporarily setting `FORGE_FORCE_REINSTALL` to "true". Be sure to remove that variable after successfully starting the server.
 
+URLs configurable via environment variables:
+
+- `FORGE_PROMOTIONS_URL`: default is https://files.minecraftforge.net/net/minecraftforge/forge/promotions_slim.json
+- `FORGE_MAVEN_REPO_URL`: default is https://maven.minecraftforge.net
+
 ## Alternatives
 
 ### NeoForge
@@ -44,7 +58,7 @@ Support for [NeoForge](https://neoforged.net/) is also provided. A NeoForge serv
 
 !!! example
 
-    ```
+    ```shell
     docker run -e TYPE=NEOFORGE -e VERSION=1.20.1 -e NEOFORGE_VERSION=47.1.79 ...
     ```
     
@@ -55,3 +69,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

@@ -49,10 +49,37 @@ By default the latest build will be used; however, a specific build number can b
 
     -e VERSION=1.16.5 -e MOHIST_BUILD=374
 
-### Catserver
+### Youer
 
-A [Catserver](http://catserver.moe/) type server can be used with
+A [Youer](https://github.com/MohistMC/Youer) server can be used with
 
-    -e TYPE=CATSERVER
+    -e TYPE=YOUER
 
-> **NOTE** Catserver only provides a single release stream, so `VERSION` is ignored
+!!! note
+
+    There are limited base versions supported, so you will also need to  set `VERSION`, such as "1.12.2"
+
+By default the latest build will be used; however, a specific build number can be selected by setting `MOHIST_BUILD`, such as
+
+    -e VERSION=1.16.5 -e MOHIST_BUILD=374
+
+### Banner
+
+A [Banner](https://github.com/MohistMC/Banner) server can be used with
+
+    -e TYPE=BANNER
+
+!!! note
+
+    There are limited base versions supported, so you will also need to  set `VERSION`, such as "1.12.2"
+
+By default the latest build will be used; however, a specific build number can be selected by setting `MOHIST_BUILD`, such as
+
+    -e VERSION=1.16.5 -e MOHIST_BUILD=374
+
+### Arclight
+
+A [Arclight](https://arclight.izzel.io/) type server can be used with
+
+    -e TYPE=ARCLIGHT
+    -e ARCLIGHT_TYPE=NEOFORGE,FORGE,FABRIC

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

@@ -9,7 +9,7 @@ If you want to run a specific version, you can add `-e SPONGEVERSION=1.11.2-6.1.
 Beware that current [Sponge](https://www.spongepowered.org) `STABLE` versions for Minecraft 1.12 require using [the Java 8 tag](../../versions/java.md):
 
 ``` shell
-docker run -d -v /path/on/host:/data -e TYPE=SPONGEVANILLA \
+docker run -d --pull=always -v /path/on/host:/data -e TYPE=SPONGEVANILLA \
     -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server:java8-multiarch
 ```
 
@@ -17,7 +17,7 @@ You can also choose to use the `EXPERIMENTAL` branch.
 Just change it with `SPONGEBRANCH`, such as:
 
 ``` shell
-$ docker run -d -v /path/on/host:/data ... \
+$ docker run -d --pull=always -v /path/on/host:/data ... \
     -e TYPE=SPONGEVANILLA -e SPONGEBRANCH=EXPERIMENTAL ...
 ```
 
@@ -39,6 +39,14 @@ Configuration options with defaults:
 
     Instead of using format codes in the MOTD, Limbo requires [JSON chat content](https://minecraft.wiki/w/Raw_JSON_text_format#Java_Edition). If a plain string is provided, which is the default, then it gets converted into the required JSON structure. 
 
+## NanoLimbo
+
+A [NanoLimbo](https://github.com/BoomEaro/NanoLimbo) server can be run by setting `TYPE` to `NANOLIMBO`.
+
+Note: it is a fork of the original [NanoLimbo](https://github.com/Nan1t/NanoLimbo) made by Nan1t
+
+An alternate Limbo server
+
 ## Crucible
 
 A [Crucible](https://github.com/CrucibleMC/Crucible) server can be run by setting `TYPE` to `CRUCIBLE`.
@@ -65,4 +73,4 @@ Alternatively, the final `-jar` invocation can be replaced by setting `CUSTOM_JA
 
     When using `docker run` make sure to quote the entire value since it has spaces in it, such as
 
-        -e CUSTOM_JAR_EXEC="-cp worldedit.jar:Carpet-Server.jar net.minecraft.server.MinecraftServer"
+        -e CUSTOM_JAR_EXEC="-cp worldedit.jar:Carpet-Server.jar net.minecraft.server.MinecraftServer"

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

@@ -8,7 +8,7 @@ To allow for the selection of experimental builds, set `PAPER_CHANNEL` to "exper
 
     Using `docker run` command line
     
-    ```
+    ```shell
     docker run ... -e TYPE=PAPER ... 
     
     docker run ... -e TYPE=PAPER -e VERSION=1.20.6 ... 
@@ -85,6 +85,23 @@ Extra variables:
 - `USE_FLARE_FLAGS=false` : set to true to add appropriate flags for the built-in [Flare](https://blog.airplane.gg/flare) profiler
 - `PURPUR_DOWNLOAD_URL=<url>` : set URL to download Purpur from custom URL.
 
+### Leaf
+
+A [Leaf server](https://www.leafmc.one/) is a Paper fork focused on performance improvements and low-level optimizations for smoother gameplay.
+
+To use a Leaf server, set the environment variable `TYPE` to `"LEAF"`.
+
+    -e TYPE=LEAF
+
+!!! note
+
+    The `VERSION` variable is used to select the Minecraft version to run.  
+    To specify a particular Leaf build, use `LEAF_BUILD`.  
+
+By default the latest build will be used; however, a specific build number can be selected by setting `LEAF_BUILD`, such as
+
+    -e VERSION=1.21.4 -e LEAF_BUILD=441
+
 ### Folia
 
 A [Folia server](https://papermc.io/software/folia) can be used by setting the environment variable `TYPE` to "FOLIA".
@@ -95,9 +112,9 @@ By default, the container will run the latest experimental build of [Folia serve
 
     Using `docker run`
     
-    ```
-    docker run -d -v /path/on/host:/data \
-        -e TYPE=FOLIA \
+    ```shell
+    docker run -d --pull=always \
+        -v /path/on/host:/data -e TYPE=FOLIA \
         -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
     ```
 
@@ -109,3 +126,7 @@ If you have attached a host directory to the `/data` volume, then you can instal
 
 !!! note
     The Folia type inherits from the Paper type. Paper's variables will override the Folia ones.
+
+## Extra config
+
+- `SKIP_DOWNLOAD_DEFAULTS`: when set to "true" startup will entirely skip checking for default Paper/Bukkit/Spigot config files to download

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

@@ -1,8 +1,8 @@
 Enable [Quilt server](https://quiltmc.org/) mode by adding a `-e TYPE=QUILT` to your command-line.
 
-```
-docker run -d -v /path/on/host:/data \
-    -e TYPE=QUILT \
+```shell
+docker run -d --pull=always \
+    -v /path/on/host:/data -e TYPE=QUILT \
     -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
 ```
 
@@ -10,9 +10,9 @@ By default, the container will install the latest [quilt server launcher](https:
 
 A specific loader or installer version other than the latest can be requested using `QUILT_LOADER_VERSION` and `QUILT_INSTALLER_VERSION` respectively, such as:
 
-```
-docker run -d -v /path/on/host:/data ... \
-    -e TYPE=QUILT \
+```shell
+docker run -d --pull=always \
+    -v /path/on/host:/data ... -e TYPE=QUILT \
     -e QUILT_LOADER_VERSION=0.16.0 \
     -e QUILT_INSTALLER_VERSION=0.4.1
 ```

docs/variables.md

@@ -1,7 +1,7 @@
 
 !!! warning
 
-    The variables listed on this page are manually documented and may be out-of-date or inaccurate. 
+    The variables listed on this page are manually documented and may be out-of-date or inaccurate.
 
     All other documentation pages are actively maintained, so please use the search box above to find the desired topic.
 
@@ -48,7 +48,7 @@
         </tr>
         <tr>
             <td><code>TZ</code></td>
-            <td>You can configure the timezone to match yours by setting the TZ environment variable.  
+            <td>You can configure the timezone to match yours by setting the TZ environment variable.
 
 alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
 
@@ -57,9 +57,45 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
             <td><code>UTC</code></td>
             <td>⬜️</td>
         </tr>
+        <tr>
+            <td><code>LOG_LEVEL</code></td>
+            <td>Root logger level (trace, debug, info, warn, error)</td>
+            <td><code>info</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>LOG_CONSOLE_FORMAT</code></td>
+            <td>Log4j2 pattern for console output (what you see in <code>docker logs</code>)</td>
+            <td><code>[%d{HH:mm:ss}] [%t/%level]: %msg%n</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>LOG_FILE_FORMAT</code></td>
+            <td>Log4j2 pattern for file logs (written to <code>logs/latest.log</code>)</td>
+            <td><code>[%d{HH:mm:ss}] [%t/%level]: %msg%n</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>LOG_TERMINAL_FORMAT</code></td>
+            <td>Log4j2 pattern for interactive terminal console (used with <code>docker attach</code>)</td>
+            <td><code>[%d{HH:mm:ss} %level]: %msg%n</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>ROLLING_LOG_FILE_PATTERN</code></td>
+            <td>Pattern for rolled/archived log file names</td>
+            <td><code>logs/%d{yyyy-MM-dd}-%i.log.gz</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>ROLLING_LOG_MAX_FILES</code></td>
+            <td>Maximum number of archived log files to keep</td>
+            <td><code>1000</code></td>
+            <td>⬜️</td>
+        </tr>
         <tr>
             <td><code>ENABLE_ROLLING_LOGS</code></td>
-            <td>By default the vanilla log file will grow without limit. The logger can be reconfigured to use a rolling log files strategy by setting this to <code>true</code></td>
+            <td><strong>Legacy option.</strong> Rolling logs are now enabled by default via templated log4j2 configuration. This option is maintained for backward compatibility but only used for error reporting</td>
             <td><code>false</code></td>
             <td>⬜️</td>
         </tr>
@@ -81,6 +117,18 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
             <td><code>false</code></td>
             <td>⬜️</td>
         </tr>
+        <tr>
+            <td><code>USE_MEOWICE_FLAGS</code></td>
+            <td><a href="https://github.com/MeowIce/meowice-flags?tab=readme-ov-file#why-would-i-have-to-switch-">MeowIce has created an updated set of JVM flags</a> based on Aikar's flags but with support for optimizations for Java 17 and above</td>
+            <td><code>false</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>USE_MEOWICE_GRAALVM_FLAGS</code></td>
+            <td>enables MeowIce's flags for GraalVM if USE_MEOWICE_GRAALVM_FLAGS is TRUE</td>
+            <td><code>true</code></td>
+            <td>⬜️</td>
+        </tr>
         <tr>
             <td><code>JVM_OPTS</code></td>
             <td>General JVM options can be passed to the Minecraft Server invocation by passing a <code>JVM_OPTS</code> environment variable. The JVM requires -XX options to precede -X options, so those can be declared in <code>JVM_XX_OPTS</code>. Both variables are space-delimited, raw JVM arguments</td>
@@ -168,102 +216,6 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
             <td><code>FALSE</code></td>
             <td>⬜️</td>
         </tr>
-        <tr>
-            <td><code>MAX_PLAYERS</code></td>
-            <td>The maximum number of players that can join the server.</td>
-            <td><code>20</code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>MAX_WORLD_SIZE</code></td>
-            <td>The maximum possible size in blocks, expressed as a radius.</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>ALLOW_NETHER</code></td>
-            <td>Allows players to travel to the Nether</td>
-            <td><code>true</code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>ANNOUNCE_PLAYER_ACHIEVEMENTS</code></td>
-            <td>Allows server to announce when a player gets an achievement.</td>
-            <td><code>true</code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>ENABLE_COMMAND_BLOCK</code></td>
-            <td>Enables the command blocks.</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>FORCE_GAMEMODE</code></td>
-            <td>Force players to join in the default game mode.</td>
-            <td><code>false</code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>GENERATE_STRUCTURES</code></td>
-            <td>Defines whether structures (such as villages) will be generated.</td>
-            <td><code>true</code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>HARDCORE</code></td>
-            <td>If set to <code>true</code>, players will be set to spectator mode if they die.</td>
-            <td><code>false</code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>SNOOPER_ENABLED</code></td>
-            <td>If set to false, the server will not send data to snoop.minecraft.net server.</td>
-            <td><code>true</code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>MAX_BUILD_HEIGHT</code></td>
-            <td>The maximum height in which building is allowed. Terrain may still naturally generate above a low height limit.</td>
-            <td><code>256</code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>SPAWN_ANIMALS</code></td>
-            <td>Determines if animals will be able to spawn.</td>
-            <td><code>true</code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>SPAWN_MONSTERS</code></td>
-            <td>Determines if monsters will be spawned.</td>
-            <td><code>true</code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>SPAWN_NPCS</code></td>
-            <td>Determines if villagers will be spawned.</td>
-            <td><code>true</code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>SPAWN_PROTECTION</code></td>
-            <td>Sets the area that non-ops can not edit (0 to disable)</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>VIEW_DISTANCE</code></td>
-            <td>Sets the amount of world data the server sends the client, measured in chunks in each direction of the player (radius, not diameter). It determines the server-side viewing distance.</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>SEED</code></td>
-            <td>Sets the seed to create the Minecraft world. If you use a negative number, make sure that it is in quotes.</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
         <tr>
             <td><code>MODE</code></td>
             <td>Minecraft servers are configured to run in Survival mode by default. You can change the mode using MODE where you can either provide the <a href="http://minecraft.wiki/Game_mode#Game_modes">standard numerical values</a> or the shortcut values:<br />
@@ -276,127 +228,18 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
             <td><code></code></td>
             <td>⬜️</td>
         </tr>
-        <tr>
-            <td><code>PVP</code></td>
-            <td>By default, servers are created with player-vs-player (PVP) mode enabled.</td>
-            <td><code>true</code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>LEVEL_TYPE</code></td>
-            <td>By default, a standard world is generated with hills, valleys, water, etc. A different level type can be configured by setting LEVEL_TYPE to <a href="https://minecraft.wiki/w/Server.properties#level-type">an expected type listed here</a>.
-            </td>
-            <td><code>minecraft:default</code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>GENERATOR_SETTINGS</code></td>
-            <td>For some of the level types, <code>GENERATOR_SETTINGS</code> can be used to further customize the world generation <a href="https://minecraft.wiki/w/Server.properties#generator-settings">as described here</a>.</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
         <tr>
             <td><code>LEVEL</code></td>
-            <td>You can either switch between world saves or run multiple containers with different saves by using the LEVEL option</td>
+            <td>Maps to <a href="https://minecraft.wiki/w/Server.properties#level-name">the <code>level-name</code> server property</a>. You can either switch between world saves or run multiple containers with different saves by using the LEVEL option</td>
             <td><code>world</code></td>
             <td>⬜️</td>
         </tr>
-        <tr>
-            <td><code>ONLINE_MODE</code></td>
-            <td>By default, server checks connecting players against Minecraft's account database. If you want to create an offline server or your server is not connected to the internet, you can disable the server to try connecting to minecraft.net to authenticate players</td>
-            <td><code>true</code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>ALLOW_FLIGHT</code></td>
-            <td>Allows users to use flight on your server while in Survival mode, if they have a mod that provides flight installed.</td>
-            <td><code>FALSE</code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>SERVER_NAME</code></td>
-            <td>The server name</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
         <tr>
             <td><code>SERVER_PORT</code></td>
-            <td>Only change this value if you know what you're doing. It is only needed when using host networking and it is rare that host networking should be used.</td>
+            <td>Maps to <a href="https://minecraft.wiki/w/Server.properties#server-port">the <code>server-port</code> server property</a>. Only change this value if you know what you're doing. It is only needed when using host networking and it is rare that host networking should be used.</td>
             <td><code></code></td>
             <td>⬜️</td>
         </tr>
-        <tr>
-            <td><code>PLAYER_IDLE_TIMEOUT</code></td>
-            <td>player-idle-timeout</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>ENABLE_JMX</code></td>
-            <td>enable-jmx-monitoring</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>SYNC_CHUNK_WRITES</code></td>
-            <td>sync-chunk-writes</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>ENABLE_STATUS</code></td>
-            <td>enable-status</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>ENTITY_BROADCAST_RANGE_PERCENTAGE</code></td>
-            <td>entity-broadcast-range-percentage</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>FUNCTION_PERMISSION_LEVEL</code></td>
-            <td>function-permission-level</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>NETWORK_COMPRESSION_THRESHOLD</code></td>
-            <td>network-compression-threshold</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>OP_PERMISSION_LEVEL</code></td>
-            <td>op-permission-level</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>PREVENT_PROXY_CONNECTIONS</code></td>
-            <td>prevent-proxy-connections</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>USE_NATIVE_TRANSPORT</code></td>
-            <td>use-native-transport</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>SIMULATION_DISTANCE</code></td>
-            <td>simulation-distance</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>EXEC_DIRECTLY</code></td>
-            <td>If you would like to docker attach to the Minecraft server console with color and interactive capabilities, then set to <code>true</code></td>
-            <td><code>false</code></td>
-            <td>⬜️</td>
-        </tr>
         <tr>
             <td><code>STOP_SERVER_ANNOUNCE_DELAY</code></td>
             <td>To allow time for players to finish what they're doing during a graceful server shutdown, set <code>STOP_SERVER_ANNOUNCE_DELAY</code> to a number of seconds to delay after an announcement is posted by the server.</td>
@@ -454,6 +297,10 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
     </tbody>
 </table>
 
+### Server properties
+
+This image maps known server properties as described in [this section](configuration/server-properties.md).
+
 ### Custom resource pack
 
 <table>
@@ -597,10 +444,6 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
 
 ### Auto-Pause
 
-!!! note
-
-    Autopause is not compatible with `EXEC_DIRECTLY=true` and the two cannot be set together.
-
 <table>
     <thead>
         <tr>
@@ -711,7 +554,7 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
 ### CurseForge
 
 !!! tip
-    
+
     Refer to the [main documentation page](types-and-platforms/mod-platforms/auto-curseforge.md) for more details and up-to-date information.
 
 <table>
@@ -730,6 +573,12 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
             <td><code></code></td>
             <td>✅</td>
         </tr>
+        <tr>
+            <td><code>CF_API_KEY_FILE</code></td>
+            <td>A path to a file inside of container that contains <strong>YOUR</strong> CurseForge (Eternal) API Key.</td>
+            <td><code></code></td>
+            <td>✅</td>
+        </tr>
         <tr>
             <td><code>CF_PAGE_URL</code></td>
             <td>Pass a page URL to the modpack or a specific file</td>
@@ -800,6 +649,12 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
             <td><code>false</code></td>
             <td>⬜️</td>
         </tr>
+        <tr>
+            <td><code>CF_MOD_LOADER_VERSION</code></td>
+            <td>Override the mod loader version declared by the modpack</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
     </tbody>
 </table>
 

docs/versions/java.md

@@ -10,24 +10,30 @@ or explicitly include the tag, such as
 
 where `<tag>` refers to the first column of this table:
 
-| 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-jdk        | 8            | Ubuntu | Hotspot+JDK        | amd64               |
-| java8-openj9     | 8            | Debian | OpenJ9             | amd64               |
-| java8-graalvm-ce | 8            | Oracle | GraalVM CE         | amd64               |
+| Tag            | Java version | Linux  | JVM Type           | Architecture        | Note |
+|----------------|--------------|--------|--------------------|---------------------|------|
+| latest         | 25           | Ubuntu | Hotspot            | amd64, arm64        |      |
+| stable         | 25           | Ubuntu | Hotspot            | amd64, arm64        |      |
+| java25         | 25           | Ubuntu | Hotspot            | amd64, arm64        |      |
+| java25-jdk     | 25           | Ubuntu | Hotspot+JDK        | amd64, arm64        |      |
+| java25-graalvm | 25           | Oracle | Oracle GraalVM (3) | amd64, arm64        | (5)  |   
+| 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 (3) | amd64, arm64        | (5)  |   
+| java17         | 17           | Ubuntu | Hotspot            | amd64, arm64, armv7 |      |
+| java17-graalvm | 17           | Oracle | Oracle GraalVM (3) | amd64, arm64        | (5)  |   
+| java16         | 16           | Ubuntu | Hotspot            | amd64, arm64, armv7 | (4)  |
+| java11         | 11           | Ubuntu | Hotspot            | amd64, arm64, armv7 |      |
+| java8          | 8            | Ubuntu | Hotspot            | amd64, arm64, armv7 |      |
 
-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.
+Notes
+
+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.
+2. Short-term variant, subject to deprecation upon next version introduction
+3. Based on the [Oracle GraalVM 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.
+4. This version of Java is [recommended for PaperMC 1.16.5](https://docs.papermc.io/paper/getting-started/#requirements)
+5. Due to these images using Oracle Linux, (which is based on Red Hat Enterprise Linux) Forge Installer will not work due to its use of zlib-ng. Use other images for initial installation and Forge version upgrade.
 
 !!! example "Example using java8"
 
@@ -73,7 +79,7 @@ where `java tag` still refers to the first column of the table above and `releas
 
 ### 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.
+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. There is also a per-variant stable tag, formatted as `stable-{variant}`.
 
 ## Version compatibilities
 
@@ -121,17 +127,23 @@ Forge also doesn't support openj9 JVM implementation.
 
 The following image tags have been deprecated and are no longer receiving updates:
 
-- java19
 - adopt13
 - adopt14
 - adopt15
 - openj9-nightly
 - multiarch-latest
-- java16/java16-openj9
+- java16-openj9
 - java17-graalvm-ce
 - java17-openj9
+- java17-alpine
+- java19
 - java20-graalvm, java20, java20-alpine
+- java23-*
+- java24, java24-graalvm 
 - java8-multiarch is still built and pushed, but please move to java8 instead
-- java8-alpine
+- java8-alpine, java8-jdk, java8-openj9, java8-graalvm-ce
 
-[^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. 
+## JSON Listing
+
+
+Information about the image tags is available for programmatic access at <https://raw.githubusercontent.com/itzg/docker-minecraft-server/refs/heads/master/images.json>

docs/versions/minecraft.md

@@ -1,8 +1,8 @@
 To use a different Minecraft version, pass the `VERSION` environment variable (case sensitive), which can have the value
 
-- LATEST (the default)
-- SNAPSHOT
-- a specific version, such as "1.7.9"
+- `LATEST` for latest release (the default)
+- `SNAPSHOT` for latest snapshot
+- a specific version, such as `1.7.9`, `25w35a`, `26.1`, or `26.1-snapshot-1`
 - or an alpha and beta version, such as "b1.7.3" (server download might not exist)
 
 For example, to use the latest snapshot:

examples/apply-extra-configs/compose.yml

@@ -0,0 +1,19 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: "TRUE"
+      TYPE: PAPER
+      MAX_MEMORY: 4G
+      MODRINTH_PROJECTS: |
+        luckperms
+      APPLY_EXTRA_FILES: |
+        plugins/LuckPerms</shared-configs/LuckPerms/
+      DEBUG: true
+    volumes:
+      - data:/data
+      - ./shared-configs:/shared-configs:ro
+    ports:
+      - "25565:25565"
+volumes:
+  data:

examples/apply-extra-configs/shared-configs/LuckPerms/config.yml

@@ -0,0 +1,753 @@
+####################################################################################################
+# LOCALLY MODIFIED
+####################################################################################################
+# +----------------------------------------------------------------------------------------------+ #
+# |                                   __         __   ___  __         __                         | #
+# |                        |    |  | /  ` |__/  |__) |__  |__)  |\/| /__`                        | #
+# |                        |___ \__/ \__, |  \  |    |___ |  \  |  | .__/                        | #
+# |                                                                                              | #
+# |                                     https://luckperms.net                                    | #
+# |                                                                                              | #
+# |  WIKI:        https://luckperms.net/wiki                                                     | #
+# |  DISCORD:     https://discord.gg/luckperms                                                   | #
+# |  BUG REPORTS: https://github.com/LuckPerms/LuckPerms/issues                                  | #
+# |                                                                                              | #
+# |  Each option in this file is documented and explained here:                                  | #
+# |   ==>  https://luckperms.net/wiki/Configuration                                              | #
+# |                                                                                              | #
+# |  New options are not added to this file automatically. Default values are used if an         | #
+# |  option cannot be found. The latest config versions can be obtained at the link above.       | #
+# +----------------------------------------------------------------------------------------------+ #
+####################################################################################################
+
+# +----------------------------------------------------------------------------------------------+ #
+# |                                                                                              | #
+# |                                      ESSENTIAL SETTINGS                                      | #
+# |                                                                                              | #
+# |                   Important settings that control how LuckPerms functions.                   | #
+# |                                                                                              | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# The name of the server, used for server specific permissions.
+#
+# - When set to "global" this setting is effectively ignored.
+# - In all other cases, the value here is added to all players in a "server" context.
+# - See: https://luckperms.net/wiki/Context
+server: global
+
+# If the servers own UUID cache/lookup facility should be used when there is no record for a player
+# already in LuckPerms.
+#
+# - When this is set to 'false', commands using a player's username will not work unless the player
+#   has joined since LuckPerms was first installed.
+# - To get around this, you can use a player's uuid directly in the command, or enable this option.
+# - When this is set to 'true', the server facility is used. This may use a number of methods,
+#   including checking the servers local cache, or making a request to the Mojang API.
+use-server-uuid-cache: false
+
+
+
+
+# +----------------------------------------------------------------------------------------------+ #
+# |                                                                                              | #
+# |                                       STORAGE SETTINGS                                       | #
+# |                                                                                              | #
+# |                Controls which storage method LuckPerms will use to store data.               | #
+# |                                                                                              | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# How the plugin should store data
+#
+# - The various options are explained in more detail on the wiki:
+#   https://luckperms.net/wiki/Storage-types
+#
+# - Possible options:
+#
+#   |  Remote databases - require connection information to be configured below
+#   |=> MySQL
+#   |=> MariaDB (preferred over MySQL)
+#   |=> PostgreSQL
+#   |=> MongoDB
+#
+#   |  Flatfile/local database - don't require any extra configuration
+#   |=> H2 (preferred over SQLite)
+#   |=> SQLite
+#
+#   |  Readable & editable text files - don't require any extra configuration
+#   |=> YAML (.yml files)
+#   |=> JSON (.json files)
+#   |=> HOCON (.conf files)
+#   |=> TOML (.toml files)
+#   |
+#   | By default, user, group and track data is separated into different files. Data can be combined
+#   | and all stored in the same file by switching to a combined storage variant.
+#   | Just add '-combined' to the end of the storage-method, e.g. 'yaml-combined'
+#
+# - A H2 database is the default option.
+# - If you want to edit data manually in "traditional" storage files, we suggest using YAML.
+storage-method: h2
+
+# The following block defines the settings for remote database storage methods.
+#
+# - You don't need to touch any of the settings here if you're using a local storage method!
+# - The connection detail options are shared between all remote storage types.
+data:
+
+  # Define the address and port for the database.
+  # - The standard DB engine port is used by default
+  #   (MySQL: 3306, PostgreSQL: 5432, MongoDB: 27017)
+  # - Specify as "host:port" if differs
+  address: localhost
+
+  # The name of the database to store LuckPerms data in.
+  # - This must be created already. Don't worry about this setting if you're using MongoDB.
+  database: minecraft
+
+  # Credentials for the database.
+  username: root
+  password: ''
+
+  # These settings apply to the MySQL connection pool.
+  # - The default values will be suitable for the majority of users.
+  # - Do not change these settings unless you know what you're doing!
+  pool-settings:
+
+    # Sets the maximum size of the MySQL connection pool.
+    # - Basically this value will determine the maximum number of actual
+    #   connections to the database backend.
+    # - More information about determining the size of connection pools can be found here:
+    #   https://github.com/brettwooldridge/HikariCP/wiki/About-Pool-Sizing
+    maximum-pool-size: 10
+
+    # Sets the minimum number of idle connections that the pool will try to maintain.
+    # - For maximum performance and responsiveness to spike demands, it is recommended to not set
+    #   this value and instead allow the pool to act as a fixed size connection pool.
+    #   (set this value to the same as 'maximum-pool-size')
+    minimum-idle: 10
+
+    # This setting controls the maximum lifetime of a connection in the pool in milliseconds.
+    # - The value should be at least 30 seconds less than any database or infrastructure imposed
+    #   connection time limit.
+    maximum-lifetime: 1800000 # 30 minutes
+
+    # This setting controls how frequently the pool will 'ping' a connection in order to prevent it
+    # from being timed out by the database or network infrastructure, measured in milliseconds.
+    # - The value should be less than maximum-lifetime and greater than 30000 (30 seconds).
+    # - Setting the value to zero will disable the keepalive functionality.
+    keepalive-time: 0
+
+    # This setting controls the maximum number of milliseconds that the plugin will wait for a
+    # connection from the pool, before timing out.
+    connection-timeout: 5000 # 5 seconds
+
+    # This setting allows you to define extra properties for connections.
+    #
+    # By default, the following options are set to enable utf8 encoding. (you may need to remove
+    # these if you are using PostgreSQL)
+    #   useUnicode: true
+    #   characterEncoding: utf8
+    #
+    # You can also use this section to disable SSL connections, by uncommenting the 'useSSL' and
+    # 'verifyServerCertificate' options below.
+    properties:
+      useUnicode: true
+      characterEncoding: utf8
+      #useSSL: false
+      #verifyServerCertificate: false
+
+  # The prefix for all LuckPerms SQL tables.
+  #
+  # - This only applies for remote SQL storage types (MySQL, MariaDB, etc).
+  # - Change this if you want to use different tables for different servers.
+  table-prefix: 'luckperms_'
+
+  # The prefix to use for all LuckPerms MongoDB collections.
+  #
+  # - This only applies for the MongoDB storage type.
+  # - Change this if you want to use different collections for different servers. The default is no
+  # prefix.
+  mongodb-collection-prefix: ''
+
+  # The connection string URI to use to connect to the MongoDB instance.
+  #
+  # - When configured, this setting will override anything defined in the address, database,
+  #   username or password fields above.
+  # - If you have a connection string that starts with 'mongodb://' or 'mongodb+srv://', enter it
+  #   below.
+  # - For more information, please see https://docs.mongodb.com/manual/reference/connection-string/
+  mongodb-connection-uri: ''
+
+# Define settings for a "split" storage setup.
+#
+# - This allows you to define a storage method for each type of data.
+# - The connection options above still have to be correct for each type here.
+split-storage:
+  # Don't touch this if you don't want to use split storage!
+  enabled: false
+  methods:
+    # These options don't need to be modified if split storage isn't enabled.
+    user: h2
+    group: h2
+    track: h2
+    uuid: h2
+    log: h2
+
+
+
+
+# +----------------------------------------------------------------------------------------------+ #
+# |                                                                                              | #
+# |                            UPDATE PROPAGATION & MESSAGING SERVICE                            | #
+# |                                                                                              | #
+# |    Controls the ways in which LuckPerms will sync data & notify other servers of changes.    | #
+# |     These options are documented on greater detail on the wiki under "Instant Updates".      | #
+# |                                                                                              | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# This option controls how frequently LuckPerms will perform a sync task.
+#
+# - A sync task will refresh all data from the storage, and ensure that the most up-to-date data is
+#   being used by the plugin.
+# - This is disabled by default, as most users will not need it. However, if you're using a remote
+#   storage type without a messaging service setup, you may wish to set this to something like 3.
+# - Set to -1 to disable the task completely.
+sync-minutes: -1
+
+# If the file watcher should be enabled.
+#
+# - When using a file-based storage type, LuckPerms can monitor the data files for changes, and
+#   automatically update when changes are detected.
+# - If you don't want this feature to be active, set this option to false.
+watch-files: true
+
+# Define which messaging service should be used by the plugin.
+#
+# - If enabled and configured, LuckPerms will use the messaging service to inform other connected
+#   servers of changes.
+# - Use the command "/lp networksync" to manually push changes.
+# - Data is NOT stored using this service. It is only used as a messaging platform.
+#
+# - If you decide to enable this feature, you should set "sync-minutes" to -1, as there is no need
+#   for LuckPerms to poll the database for changes.
+#
+# - Possible options:
+#   => sql       Uses the SQL database to form a queue system for communication. Will only work when
+#                'storage-method' is set to MySQL or MariaDB. This is chosen by default if the
+#                option is set to 'auto' and SQL storage is in use. Set to 'notsql' to disable this.
+#   => pluginmsg Uses the plugin messaging channels to communicate with the proxy.
+#                LuckPerms must be installed on your proxy & all connected servers backend servers.
+#                Won't work if you have more than one proxy.
+#   => lilypad   Uses LilyPad pub-sub to push changes. You need to have the LilyPad-Connect plugin
+#                installed.
+#   => redis     Uses Redis pub-sub to push changes. Your server connection info must be configured
+#                below.
+#   => rabbitmq  Uses RabbitMQ pub-sub to push changes. Your server connection info must be
+#                configured below.
+#   => nats      Uses Nats pub-sub to push changes. Your server connection info must be
+#                configured below.
+#   => custom    Uses a messaging service provided using the LuckPerms API.
+#   => auto      Attempts to automatically setup a messaging service using redis or sql.
+messaging-service: auto
+
+# If LuckPerms should automatically push updates after a change has been made with a command.
+auto-push-updates: true
+
+# If LuckPerms should push logging entries to connected servers via the messaging service.
+push-log-entries: true
+
+# If LuckPerms should broadcast received logging entries to players on this platform.
+#
+# - If you have LuckPerms installed on your backend servers as well as a BungeeCord proxy, you
+#   should set this option to false on either your backends or your proxies, to avoid players being
+#   messaged twice about log entries.
+broadcast-received-log-entries: true
+
+# Settings for Redis.
+# Port 6379 is used by default; set address to "host:port" if differs
+# Multiple Redis nodes can be specified in the same format as a string list under the name "addresses".
+redis:
+  enabled: false
+  address: localhost
+  username: ''
+  password: ''
+
+# Settings for Nats.
+# Port 4222 is used by default; set address to "host:port" if differs
+nats:
+  enabled: false
+  address: localhost
+  username: ''
+  password: ''
+
+# Settings for RabbitMQ.
+# Port 5672 is used by default; set address to "host:port" if differs
+rabbitmq:
+  enabled: false
+  address: localhost
+  vhost: '/'
+  username: 'guest'
+  password: 'guest'
+
+
+
+
+# +----------------------------------------------------------------------------------------------+ #
+# |                                                                                              | #
+# |                                    CUSTOMIZATION SETTINGS                                    | #
+# |                                                                                              | #
+# |              Settings that allow admins to customize the way LuckPerms operates.             | #
+# |                                                                                              | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# Controls how temporary permissions/parents/meta should be accumulated.
+#
+# - The default behaviour is "deny".
+# - This behaviour can also be specified when the command is executed. See the command usage
+#   documentation for more info.
+#
+# - Possible options:
+#   => accumulate   durations will be added to the existing expiry time
+#   => replace      durations will be replaced if the new duration is later than the current
+#                   expiration
+#   => deny         the command will just fail if you try to add another node with the same expiry
+temporary-add-behaviour: deny
+
+# Controls how LuckPerms will determine a users "primary" group.
+#
+# - The meaning and influence of "primary groups" are explained in detail on the wiki.
+# - The preferred approach is to let LuckPerms automatically determine a users primary group
+#   based on the relative weight of their parent groups.
+#
+# - Possible options:
+#   => stored                  use the value stored against the users record in the file/database
+#   => parents-by-weight       just use the users most highly weighted parent
+#   => all-parents-by-weight   same as above, but calculates based upon all parents inherited from
+#                              both directly and indirectly
+primary-group-calculation: parents-by-weight
+
+# If the plugin should check for "extra" permissions with users run LP commands.
+#
+# - These extra permissions allow finer control over what users can do with each command, and who
+#   they have access to edit.
+# - The nature of the checks are documented on the wiki under "Argument based command permissions".
+# - Argument based permissions are *not* static, unlike the 'base' permissions, and will depend upon
+#   the arguments given within the command.
+argument-based-command-permissions: false
+
+# If the plugin should check whether senders are a member of a given group before they're able to
+# edit the groups data or add/remove other users to/from it.
+# Note: these limitations do not apply to the web editor!
+require-sender-group-membership-to-modify: false
+
+# If the plugin should send log notifications to users whenever permissions are modified.
+#
+# - Notifications are only sent to those with the appropriate permission to receive them
+# - They can also be temporarily enabled/disabled on a per-user basis using
+#   '/lp log notify <on|off>'
+log-notify: true
+
+# Defines a list of log entries which should not be sent as notifications to users.
+#
+# - Each entry in the list is a RegEx expression which is matched against the log entry description.
+log-notify-filtered-descriptions:
+#  - "parent add example"
+
+# If LuckPerms should automatically install translation bundles and periodically update them.
+auto-install-translations: true
+
+# Defines the options for prefix and suffix stacking.
+#
+# - The feature allows you to display multiple prefixes or suffixes alongside a players username in
+#   chat.
+# - It is explained and documented in more detail on the wiki under "Prefix & Suffix Stacking".
+#
+# - The options are divided into separate sections for prefixes and suffixes.
+# - The 'duplicates' setting refers to how duplicate elements are handled. Can be 'retain-all',
+#   'first-only' or 'last-only'.
+# - The value of 'start-spacer' is included at the start of the resultant prefix/suffix.
+# - The value of 'end-spacer' is included at the end of the resultant prefix/suffix.
+# - The value of 'middle-spacer' is included between each element in the resultant prefix/suffix.
+#
+# - Possible format options:
+#   => highest                        Selects the value with the highest weight, from all values
+#                                     held by or inherited by the player.
+#
+#   => lowest                         Same as above, except takes the one with the lowest weight.
+#
+#   => highest_own                    Selects the value with the highest weight, but will not
+#                                     accept any inherited values.
+#
+#   => lowest_own                     Same as above, except takes the value with the lowest weight.
+#
+#   => highest_inherited              Selects the value with the highest weight, but will only
+#                                     accept inherited values.
+#
+#   => lowest_inherited               Same as above, except takes the value with the lowest weight.
+#
+#   => highest_on_track_<track>       Selects the value with the highest weight, but only if the
+#                                     value was inherited from a group on the given track.
+#
+#   => lowest_on_track_<track>        Same as above, except takes the value with the lowest weight.
+#
+#   => highest_not_on_track_<track>   Selects the value with the highest weight, but only if the
+#                                     value was inherited from a group not on the given track.
+#
+#   => lowest_not_on_track_<track>    Same as above, except takes the value with the lowest weight.
+#
+#   => highest_from_group_<group>     Selects the value with the highest weight, but only if the
+#                                     value was inherited from the given group.
+#
+#   => lowest_from_group_<group>      Same as above, except takes the value with the lowest weight.
+#
+#   => highest_not_from_group_<group> Selects the value with the highest weight, but only if the
+#                                     value was not inherited from the given group.
+#
+#   => lowest_not_from_group_<group>  Same as above, except takes the value with the lowest weight.
+meta-formatting:
+  prefix:
+    format:
+      - "highest"
+    duplicates: first-only
+    start-spacer: ""
+    middle-spacer: " "
+    end-spacer: ""
+  suffix:
+    format:
+      - "highest"
+    duplicates: first-only
+    start-spacer: ""
+    middle-spacer: " "
+    end-spacer: ""
+
+
+
+
+# +----------------------------------------------------------------------------------------------+ #
+# |                                                                                              | #
+# |                            PERMISSION CALCULATION AND INHERITANCE                            | #
+# |                                                                                              | #
+# |    Modify the way permission checks, meta lookups and inheritance resolutions are handled.   | #
+# |                                                                                              | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# The algorithm LuckPerms should use when traversing the "inheritance tree".
+#
+# - Possible options:
+#   => breadth-first            See: https://en.wikipedia.org/wiki/Breadth-first_search
+#   => depth-first-pre-order    See: https://en.wikipedia.org/wiki/Depth-first_search
+#   => depth-first-post-order   See: https://en.wikipedia.org/wiki/Depth-first_search
+inheritance-traversal-algorithm: depth-first-pre-order
+
+# If a final sort according to "inheritance rules" should be performed after the traversal algorithm
+# has resolved the inheritance tree.
+#
+# "Inheritance rules" refers to things such as group weightings, primary group status, and the
+# natural contextual ordering of the group nodes.
+#
+# Setting this to 'true' will allow for the inheritance rules to take priority over the structure of
+# the inheritance tree.
+#
+# Effectively when this setting is 'true': the tree is flattened, and rules applied afterwards,
+# and when this setting is 'false':, the rules are just applied during each step of the traversal.
+post-traversal-inheritance-sort: false
+
+# Defines the mode used to determine whether a set of contexts are satisfied.
+#
+# - Possible options:
+#   => at-least-one-value-per-key   Set A will be satisfied by another set B, if at least one of the
+#                                   key-value entries per key in A are also in B.
+#   => all-values-per-key           Set A will be satisfied by another set B, if all key-value
+#                                   entries in A are also in B.
+context-satisfy-mode: at-least-one-value-per-key
+
+# LuckPerms has a number of built-in contexts. These can be disabled by adding the context key to
+# the list below.
+disabled-contexts:
+#  - "world"
+
+# +----------------------------------------------------------------------------------------------+ #
+# | Permission resolution settings                                                               | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# If users on this server should have their global permissions applied.
+# When set to false, only server specific permissions will apply for users on this server
+include-global: true
+
+# If users on this server should have their global world permissions applied.
+# When set to false, only world specific permissions will apply for users on this server
+include-global-world: true
+
+# If users on this server should have global (non-server specific) groups applied
+apply-global-groups: true
+
+# If users on this server should have global (non-world specific) groups applied
+apply-global-world-groups: true
+
+# +----------------------------------------------------------------------------------------------+ #
+# | Meta lookup settings                                                                         | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# Defines how meta values should be selected.
+#
+# - Possible options:
+#   => inheritance      Selects the meta value that was inherited first
+#   => highest-number   Selects the highest numerical meta value
+#   => lowest-number    Selects the lowest numerical meta value
+meta-value-selection-default: inheritance
+
+# Defines how meta values should be selected per key.
+meta-value-selection:
+#  max-homes: highest-number
+
+# +----------------------------------------------------------------------------------------------+ #
+# | Inheritance settings                                                                         | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# If the plugin should apply wildcard permissions.
+#
+# - If set to true, LuckPerms will detect wildcard permissions, and resolve & apply all registered
+#   permissions matching the wildcard.
+apply-wildcards: true
+
+# If LuckPerms should resolve and apply permissions according to the Sponge style implicit wildcard
+# inheritance system.
+#
+# - That being: If a user has been granted "example", then the player should have also be
+#   automatically granted "example.function", "example.another", "example.deeper.nesting",
+#   and so on.
+apply-sponge-implicit-wildcards: false
+
+# If the plugin should apply negated Bukkit default permissions before it considers wildcard
+# assignments.
+#
+# - Plugin authors can define permissions which explicitly should not be given automatically to OPs.
+#   This is usually used for so called "anti-permissions" - permissions which, when granted, apply
+#   something negative.
+# - If this option is set to true, LuckPerms will consider any negated declarations made by
+#   plugins before it considers wildcards. (similar to the way the OP system works)
+# - If this option is set to false, LuckPerms will consider any wildcard assignments first.
+apply-default-negated-permissions-before-wildcards: false
+
+# If the plugin should parse regex permissions.
+#
+# - If set to true, LuckPerms will detect regex permissions, marked with "r=" at the start of the
+#   node, and resolve & apply all registered permissions matching the regex.
+apply-regex: true
+
+# If the plugin should complete and apply shorthand permissions.
+#
+# - If set to true, LuckPerms will detect and expand shorthand node patterns.
+apply-shorthand: true
+
+# If the plugin should apply Bukkit child permissions.
+#
+# - Plugin authors can define custom permissions structures for their plugin, which will be resolved
+#   and used by LuckPerms if this setting is enabled.
+apply-bukkit-child-permissions: true
+
+# If the plugin should apply Bukkit default permissions.
+#
+# - Plugin authors can define permissions which should be given to all users by default, or setup
+#   permissions which should/shouldn't be given to opped players.
+# - If this option is set to false, LuckPerms will ignore these defaults.
+apply-bukkit-default-permissions: true
+
+# If the plugin should apply attachment permissions.
+#
+# - Other plugins on the server are able to add their own "permission attachments" to players.
+# - This allows them to grant players additional permissions which last until the end of the
+#   session, or until they're removed.
+# - If this option is set to false, LuckPerms will not include these attachment permissions when
+#   considering if a player should have access to a certain permission.
+apply-bukkit-attachment-permissions: true
+
+# +----------------------------------------------------------------------------------------------+ #
+# | Extra settings                                                                               | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# A list of context calculators which will be skipped when calculating contexts.
+#
+# - You can disable context calculators by either:
+#   => specifying the Java class name used by the calculator (e.g. com.example.ExampleCalculator)
+#   => specifying a sub-section of the Java package used by the calculator (e.g. com.example)
+disabled-context-calculators: []
+
+# Allows you to set "aliases" for the worlds sent forward for context calculation.
+#
+# - These aliases are provided in addition to the real world name. Applied recursively.
+# - Remove the comment characters for the default aliases to apply.
+world-rewrite:
+#  world_nether: world
+#  world_the_end: world
+
+# Define special group weights for this server.
+#
+# - Group weights can also be applied directly to group data, using the setweight command.
+# - This section allows weights to be set on a per-server basis.
+group-weight:
+#  admin: 10
+
+
+
+
+# +----------------------------------------------------------------------------------------------+ #
+# |                                                                                              | #
+# |                                      FINE TUNING OPTIONS                                     | #
+# |                                                                                              | #
+# |     A number of more niche settings for tweaking and changing behaviour. The section also    | #
+# | contains toggles for some more specialised features. It is only necessary to make changes to | #
+# |                  these options if you want to fine-tune LuckPerms behaviour.                 | #
+# |                                                                                              | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# +----------------------------------------------------------------------------------------------+ #
+# | Server Operator (OP) settings                                                                | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# Controls whether server operators should exist at all.
+#
+# - When set to 'false', all players will be de-opped, and the /op and /deop commands will be
+#   disabled. Note that vanilla features like the spawn-protection require an operator on the
+#   server to work.
+enable-ops: true
+
+# Enables or disables a special permission based system in LuckPerms for controlling OP status.
+#
+# - If set to true, any user with the permission "luckperms.autoop" will automatically be granted
+#   server operator status. This permission can be inherited, or set on specific servers/worlds,
+#   temporarily, etc.
+# - Additionally, setting this to true will force the "enable-ops" option above to false. All users
+#   will be de-opped unless they have the permission node, and the op/deop commands will be
+#   disabled.
+# - It is recommended that you use this option instead of assigning a single '*' permission.
+auto-op: false
+
+# Defines if "opped" players should be able to use all LuckPerms commands by default.
+#
+# - Set to false to only allow users who have the permissions access to the commands
+commands-allow-op: true
+
+# +----------------------------------------------------------------------------------------------+ #
+# | Vault integration settings                                                                   | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# If Vault lookups for offline players on the main server thread should be enabled.
+#
+# LuckPerms has a "catch" for plugins attempting to perform unsafe offline player data lookups
+# from the main server thread. This catch raises an exception (causes an error to occur) when unsafe
+# lookups are made, instead of allowing the lookup to happen, which would likely cause the server
+# to lag.
+#
+# However, if you're willing to accept the consequences, the catch can be disabled by setting this
+# option to 'true.
+vault-unsafe-lookups: false
+
+# If LuckPerms should use the 'display name' of a group when returning groups in Vault API calls.
+#
+# - When this option is set to true, the display name of the group is returned.
+# - When this option is set to false, the standard name/id of the group is returned.
+vault-group-use-displaynames: true
+
+# Controls which group LuckPerms should use for NPC players when handling Vault requests.
+#
+# - As NPCs aren't actually real players, LuckPerms does not load any user data for them. This
+#   becomes an issue when plugins want to check for their permissions using Vault.
+# - As a solution, Vault checks for NPCs fallback to a group, which is defined below.
+vault-npc-group: default
+
+# Controls how LuckPerms should consider the OP status of NPC players when handing Vault requests.
+#
+# - If you want NPCs to have the same permissions as "normal" players, set this option to false.
+# - If you want NPCs to have OP status, set this option to true.
+vault-npc-op-status: false
+
+# If the vault-server option below should be used.
+#
+# - When this option is set to false, the server value defined above under "server" is used.
+use-vault-server: false
+
+# The name of the server used within Vault operations.
+#
+# - If you don't want Vault operations to be server specific, set this to "global".
+# - Will only take effect if use-vault-server is set to true above.
+vault-server: global
+
+# If global permissions should be considered when retrieving meta or player groups
+vault-include-global: true
+
+# If Vault operations should ignore any world arguments if supplied.
+vault-ignore-world: false
+
+# +----------------------------------------------------------------------------------------------+ #
+# | Miscellaneous (and rarely used) settings                                                     | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# If LuckPerms should produce extra logging output when it handles logins.
+#
+# - Useful if you're having issues with UUID forwarding or data not being loaded.
+debug-logins: false
+
+# If LuckPerms should allow usernames with non alphanumeric characters.
+#
+# - Note that due to the design of the storage implementation, usernames must still be 16 characters
+#   or less.
+allow-invalid-usernames: false
+
+# If LuckPerms should not require users to confirm bulkupdate operations.
+#
+# - When set to true, operations will be executed immediately.
+# - This is not recommended, as bulkupdate has the potential to irreversibly delete large amounts of
+#   data, and is not designed to be executed automatically.
+# - If automation is needed, users should prefer using the LuckPerms API.
+skip-bulkupdate-confirmation: false
+
+# If LuckPerms should prevent bulkupdate operations.
+#
+# - When set to true, bulkupdate operations (the /lp bulkupdate command) will not work.
+# - When set to false, bulkupdate operations will be allowed via the console.
+disable-bulkupdate: false
+
+# If LuckPerms should allow a users primary group to be removed with the 'parent remove' command.
+#
+# - When this happens, the plugin will set their primary group back to default.
+prevent-primary-group-removal: false
+
+# If LuckPerms should update the list of commands sent to the client when permissions are changed.
+update-client-command-list: true
+
+# If LuckPerms should attempt to register "Brigadier" command list data for its commands.
+register-command-list-data: true
+
+# If LuckPerms should attempt to resolve Vanilla command target selectors for LP commands.
+# See here for more info: https://minecraft.wiki/w/Target_selectors
+resolve-command-selectors: false
+
+# If the plugin should run in "read-only" mode for commands.
+#
+# In this mode, players or the console will only be able to execute commands that read or view
+# data, and will not be able to execute any LP commands that modify data.
+#
+# If enabling read-only mode for just players, be aware that some other plugins may allow players
+# to execute commands as the console, allowing them to run LP commands indirectly.
+#
+# Note: This does not affect interactions with LuckPerms via the API.
+commands-read-only-mode:
+  players: false
+  console: false
+
+# If LuckPerms commands should be disabled. When true, this will prevent all LP commands from being
+# executed. In a sense this is a more extreme version of read-only mode (see above).
+#
+# LuckPerms will still act as the permission manager, but server administrators will be unable to
+# make changes via commands.
+#
+# If disabling commands just for players, be aware that some other plugins may allow players to
+# execute commands as the console, allowing them to run commands indirectly.
+#
+# If commands are disabled for both players and the console, LuckPerms will not attempt to register
+# a command with the server at all & in a sense will be invisible to both players and admins.
+#
+# Note: This does not affect interactions with LuckPerms via the API.
+disable-luckperms-commands:
+  players: false
+  console: false

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

@@ -1,48 +0,0 @@
-services:
-  mc:
-    image: itzg/minecraft-server:java8
-    ports:
-      - "25565:25565"
-    environment:
-      EULA: "true"
-      MODPACK_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/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
-
-volumes:
-  mc-data: {}

examples/auto-curseforge/aof7/docker-compose.yml

@@ -4,7 +4,10 @@ services:
     environment:
       EULA: true
       MODPACK_PLATFORM: AUTO_CURSEFORGE
-      # from .env
+      # 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

examples/auto-curseforge/atm10/docker-compose.yml

@@ -8,13 +8,17 @@ services:
     environment:
       EULA: true
       MOD_PLATFORM: AUTO_CURSEFORGE
-      # 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}
       CF_SLUG: all-the-mods-10
       # Optional: select a specific version/file
       # CF_FILENAME_MATCHER: "1.17"
       MEMORY: 4G
       CF_OVERRIDES_EXCLUSIONS: |
+        # Not applicable for server side
         shaderpacks/**
     volumes:
       # Use managed volume by default, but can change to a relative path like

examples/auto-curseforge/atm8/docker-compose.yml

@@ -6,7 +6,10 @@ services:
     environment:
       EULA: "true"
       MODPACK_PLATFORM: AUTO_CURSEFORGE
-      # 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}
       CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-the-mods-8
 #      CF_FILENAME_MATCHER: "1.1.0"

examples/auto-curseforge/atm9/docker-compose.yml

@@ -6,7 +6,10 @@ services:
     environment:
       EULA: "true"
       MODPACK_PLATFORM: AUTO_CURSEFORGE
-      # 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}
       CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-the-mods-9
       # Optional: select a specific version/file

examples/auto-curseforge/craftoria/docker-compose.yml

@@ -9,22 +9,12 @@ services:
       EULA: true
       ALLOW_FLIGHT: true
       MOD_PLATFORM: AUTO_CURSEFORGE
-      # allocate from https://console.curseforge.com/ and set in .env file
       CF_API_KEY: ${CF_API_KEY}
       CF_SLUG: craftoria
+      MOTD: |
+        A %TYPE% server on %VERSION%
+        running %MODPACK_NAME% %MODPACK_VERSION%
       MEMORY: 8G
-      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

examples/auto-curseforge/fabric-custom-loader/docker-compose.yml

@@ -0,0 +1,22 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: "TRUE"
+      MODPACK_PLATFORM: AUTO_CURSEFORGE
+      # Allocate API key from https://console.curseforge.com/
+      CF_API_KEY: ${CF_API_KEY}
+      # Example of overriding modloader version for a Fabric modpack
+      # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
+      CF_SLUG: "cobblemon-fabric"
+      # Override the mod loader version from the modpack
+      CF_MOD_LOADER_VERSION: "0.16.14"
+      MEMORY: "4G"
+    ports:
+      - "25565:25565"
+    volumes:
+      - ./data:/data
+    stdin_open: true
+    tty: true
+
+# See https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#custom-modloader-versions

examples/auto-curseforge/ftb-evolution/compose.yaml

@@ -9,6 +9,10 @@ services:
     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.

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

@@ -4,7 +4,10 @@ services:
     environment:
       EULA: true
       MODPACK_PLATFORM: AUTO_CURSEFORGE
-      # 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}
       CF_MODPACK_MANIFEST: /manifests/manifest.json
       CF_SLUG: "custom"

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

@@ -6,7 +6,10 @@ services:
     environment:
       EULA: "true"
       MODPACK_PLATFORM: AUTO_CURSEFORGE
-      # CF_API_KEY=... must be set in .env file or as environment variable
+      # 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: one-block-modded
       # Modpack client zip must be manually downloaded from

examples/auto-curseforge/pixelmon/docker-compose.yml

@@ -0,0 +1,21 @@
+services:
+  mc:
+    image: itzg/minecraft-server:java8-multiarch
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: "true"
+      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: the-pixelmon-modpack
+      CF_FILENAME_MATCHER: "9.1.2"
+      MEMORY: 4G
+    volumes:
+      - mc-data:/data
+
+volumes:
+  mc-data: {}

examples/auto-curseforge/prominence2/docker-compose.yml

@@ -6,7 +6,10 @@ services:
     environment:
       EULA: "true"
       MODPACK_PLATFORM: AUTO_CURSEFORGE
-      # 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}
       CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/prominence-2-rpg
       CF_FILENAME_MATCHER: "2.8.7"

examples/auto-curseforge/rad2/compose.yaml

@@ -7,24 +7,26 @@ services:
     environment:
       EULA: "true"
       MODPACK_PLATFORM: AUTO_CURSEFORGE
-      # 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}
       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
+        # Exclude client-side mods not published correctly
         creative-core
         default-options
         itemphysic-lite
         konkrete
         oauth
-        sound-filters
-        toast-control
       CF_FORCE_SYNCHRONIZE: "true"
       MEMORY: 4G
     volumes:
       - mc-data:/data
+      - C:\Users\geoff\git\mc-image-helper\build\install\mc-image-helper:/usr/share/mc-image-helper:ro
 
 volumes:
   mc-data: {}

examples/auto-curseforge/skyfactory4/compose.yml

@@ -0,0 +1,16 @@
+services:
+  mc:
+    image: itzg/minecraft-server:java8
+    environment:
+      EULA: "true"
+      MODPACK_PLATFORM: AUTO_CURSEFORGE
+      CF_SLUG: skyfactory-4
+      CF_FILENAME_MATCHER: 4.2.4
+      CF_API_KEY: ${CF_API_KEY}
+      MEMORY: 3G
+    ports:
+      - "25565:25565"
+    volumes:
+      - mc-data:/data
+volumes:
+  mc-data:

examples/auto-curseforge/skyfactory5/compose.yml

@@ -0,0 +1,24 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: true
+      # https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/
+      MODPACK_PLATFORM: AUTO_CURSEFORGE
+#      CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/skyfactory-5/files/6290684
+      CF_SLUG: skyfactory-5
+      # Comment out the following to get the latest version or pick a version from
+      # https://www.curseforge.com/minecraft/modpacks/skyfactory-5/files/all?page=1&pageSize=20
+      CF_FILENAME_MATCHER: 5.0.8
+      # 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}
+      MEMORY: 4G
+    ports:
+      - "25565:25565"
+    volumes:
+      - mc-data:/data
+volumes:
+  mc-data:

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

@@ -0,0 +1,20 @@
+services:
+  mc:
+    image: itzg/minecraft-server:java8
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: "true"
+      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
+      MEMORY: 4G
+    volumes:
+      - mc-data:/data
+
+volumes:
+  mc-data: {}

examples/auto-curseforge/valhesia5/docker-compose.yml

@@ -0,0 +1,21 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: "true"
+      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_FORCE_SYNCHRONIZE: "true"
+      CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/valhelsia-5/files/4429560
+      MEMORY: 4G
+    volumes:
+      - data:/data
+
+volumes:
+  data: {}

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

@@ -6,13 +6,14 @@ services:
     environment:
       EULA: "true"
       MODPACK_PLATFORM: AUTO_CURSEFORGE
-      # allocate from https://console.curseforge.com/
+      # 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: vault-hunters-1-18-2
       MOTD: "§4----- §2 Vault Hunters: 1.18.2 §4 -----§r\\n     §4------ §e vaulthunters.gg  §4------"
       MEMORY: 6G # 4G for base server + 2G per player
-      CF_EXCLUDE_MODS: |
-        reauth
       ALLOW_FLIGHT: true
       ENABLE_COMMAND_BLOCK: true
       DIFFICULTY: hard

examples/autopause/compose.yml

@@ -7,11 +7,13 @@ services:
       - "mc:/data"
     environment:
       EULA: "TRUE"
+      TYPE: PAPER
       ENABLE_AUTOPAUSE: "TRUE"
       MAX_TICK_TIME: "-1"
       # More aggressive settings for demo purposes
       AUTOPAUSE_TIMEOUT_INIT: "30"
       AUTOPAUSE_TIMEOUT_EST: "10"
+      JVM_DD_OPTS: "disable.watchdog:true"
     restart: unless-stopped
 
 volumes:

examples/bentobox/compose.yml

@@ -0,0 +1,22 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: "TRUE"
+      TYPE: PAPER
+      DEBUG: true
+      PLUGINS: |
+        https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/spigot
+        https://download.geysermc.org/v2/projects/floodgate/versions/latest/builds/latest/downloads/spigot
+        https://hangarcdn.papermc.io/plugins/BentoboxWorld/bentobox/versions/3.7.4/PAPER/BentoBox-3.7.4.jar
+      DOWNLOAD_EXTRA_CONFIGS: |
+        # Even though it's a jar can be treated just like any other file
+        plugins/BentoBox/addons<https://github.com/BentoBoxWorld/AOneBlock/releases/download/1.20.0/AOneBlock-1.20.0.jar
+    ports:
+      - "25565:25565"
+      - "25565:25565/udp"
+      - "19132:19132/udp"
+    volumes:
+      - data:/data
+volumes:
+  data:

examples/bettermc/docker-compose.yml

@@ -4,7 +4,10 @@ services:
     environment:
       EULA: true
       MODPACK_PLATFORM: AUTO_CURSEFORGE
-      # Set CF_API_KEY=... in a .env file next to this compose file and don't source control that 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}
       CF_SLUG: better-mc-fabric-bmc1
 #      CF_FILENAME_MATCHER: v18.5

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

@@ -1,15 +1,19 @@
-services:
-  mc:
-    image: itzg/minecraft-server
-    environment:
-      EULA: true
-      TYPE: FORGE
-      # allocate from https://console.curseforge.com/ and set in .env file
-      CF_API_KEY: ${CF_API_KEY}
-      VERSION: 1.19.2
-      CURSEFORGE_FILES: |
-        geckolib
-        aquaculture
-        naturalist
-    ports:
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: true
+      TYPE: FORGE
+      # 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: |
+        geckolib # some comment
+        # Removing temporarily
+        #aquaculture
+        naturalist
+    ports:
       - "25565:25565"

examples/docker-compose-curseforge-atm7.yaml

@@ -110,9 +110,20 @@ services:
 ####################################################################
 #                         Logging Options                          #
 #                                                                  #
-# Set to "true" to delete old logs                                 #
+# Rolling logs are now enabled by default with templated           #
+# log4j2 configuration. You can customize:                         #
+#                                                                  #
+# LOG_LEVEL: Log level (default: info)                             #
+# LOG_CONSOLE_FORMAT: Console output format (docker logs)          #
+# LOG_FILE_FORMAT: File log format (logs/latest.log)               #
+# ROLLING_LOG_MAX_FILES: Max archived files (default: 1000)        #
+#                                                                  #
+# Example: Add full timestamp to logs                              #
+# LOG_CONSOLE_FORMAT: "[%d{yyyy-MM-dd HH:mm:ss}] [%t/%level]: %msg%n"
+# LOG_FILE_FORMAT: "[%d{yyyy-MM-dd HH:mm:ss}] [%t/%level]: %msg%n"
+#                                                                  #
+# ENABLE_ROLLING_LOGS is now legacy and no longer needed.          #
 ####################################################################
-      ENABLE_ROLLING_LOGS: "true"
 
 ####################################################################
 #                          Server Timezone                         #

examples/docker-compose-fabric.yml

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

examples/docker-compose-forge-bettermcplus

@@ -120,9 +120,20 @@ services:
 ####################################################################
 #                         Logging Options                          #
 #                                                                  #
-# Set to "true" to delete old logs                                 #
+# Rolling logs are now enabled by default with templated           #
+# log4j2 configuration. You can customize:                         #
+#                                                                  #
+# LOG_LEVEL: Log level (default: info)                             #
+# LOG_CONSOLE_FORMAT: Console output format (docker logs)          #
+# LOG_FILE_FORMAT: File log format (logs/latest.log)               #
+# ROLLING_LOG_MAX_FILES: Max archived files (default: 1000)        #
+#                                                                  #
+# Example: Add full timestamp to logs                              #
+# LOG_CONSOLE_FORMAT: "[%d{yyyy-MM-dd HH:mm:ss}] [%t/%level]: %msg%n"
+# LOG_FILE_FORMAT: "[%d{yyyy-MM-dd HH:mm:ss}] [%t/%level]: %msg%n"
+#                                                                  #
+# ENABLE_ROLLING_LOGS is now legacy and no longer needed.          #
 ####################################################################
-      ENABLE_ROLLING_LOGS: "true"
 
 ####################################################################
 #                          Server Timezone                         #

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

@@ -1,157 +0,0 @@
-####################################################################
-#                         FORGE GENERIC_PACK                       #
-#                                                                  #
-# Date: 20220828                                                   #
-#                                                                  #
-# Mod: TNP Limitless 5 v2.19.0                                     #
-#                                                                  #
-# Notes: Verify that there is no EULA file in the modpack.zip      #
-#        if you do not delete it the EULA flag below will be       #
-#        overwritten when the modpack is copied and the server     #
-#        will not start.                                           #
-#                                                                  #
-####################################################################
-services:
-
-####################################################################
-#                         Service Name                             #
-#                                                                  #
-# Define Service Name here. If using RCON this name will be        #
-# referenced again as RWA_RCON_HOST below.                         #
-#                                                                  #
-# Example: 'name:' or 'mc_atm6:'                                   #
-####################################################################
-  mc_tnp5:
-
-####################################################################
-#                      Image & Container Name                      #
-#                                                                  #
-# Specify Image Name and Java Version. The 'image' will always be  #
-# 'itzg/minecraft-server' however the tag added to the end is      #
-# where you can specify the java version or container architecture.#
-# See readme.md for a full list.                                   #
-#                                                                  #
-# 'container_name:' This can be anything you like. This is the name#
-# that will show when you run 'docker ps' commands.                #
-####################################################################
-    image: itzg/minecraft-server
-    container_name: mc_tnp5
-
-####################################################################
-#                         Server Ports                             #
-#                                                                  #
-# Specify external port.                                           #
-####################################################################
-    ports:
-      - 25565:25565
-
-####################################################################
-#                   Automatic Server Restart                       #
-#                                                                  #
-# Define a restart policy here.                                    #
-#    - 'no' = Do not restart.                                      #
-#    - 'on-failure' = Restart if container exits because an error. #
-#    - 'always' = Regardless of stop reason.                       #
-#    - 'unless-stopped' = Similar to always except if stopped.     #
-####################################################################
-    restart: unless-stopped
-
-####################################################################
-#                     Volume and Folder Access                     #
-#                                                                  #
-# This section defines what folders and volumes you want to give   #
-# this container access to. It is recommended to leaves these set  #
-# to the default values unless you know what you are doing.        #
-#                                                                  #
-# Place your mod zip file in a folder called 'modpacks' in the     #
-# same directory you place this docker-compose file.               #
-#                                                                  #
-# Specify the data volume name or directory here as well.          #
-# In this example the volume name is 'data'. When docker creates   #
-# the volume it will add what ever name you give it here to the    #
-# end of the container name specified above. In this example it    #
-# would be named 'mc_atm6_data'. If you change this be sure to     #
-# update the volume name at the bottom of this config.             #
-####################################################################
-    volumes:
-      - ./modpacks:/modpacks:ro
-      - data:/data
-
-####################################################################
-#                             EULA                                 #
-#                                                                  #
-# Accept EULA by setting to "true"                                 #
-####################################################################
-    environment:
-      EULA: "true"
-
-####################################################################
-#                          FORGE INSTALL                           #
-#                                                                  #
-# Sets install type to FORGE and specifys the zip folder name      #
-# and location of your mod pack.                                   #
-#                                                                  #
-# TYPE: Defines the install type as FORGE                          #
-#                                                                  #
-# VERSION: Defines the version of MC the modpack is based on.      #
-#                                                                  #
-# FORGE_VERSION: Defines the version of FORGE the modpack uses.     #
-#               This can usually be found in the modpack.zip as    #
-#               installer.jar                                      #
-#                                                                  #
-# GENERIC_PACK: Define where the modpack.zip is located.            #
-#                                                                  #
-# Place your mod zip file in a folder called 'modpacks' in the     #
-# same directory you place this docker-compose file.               #
-####################################################################
-      TYPE: FORGE
-      VERSION: 1.18.2
-      FORGE_VERSION: 40.1.73
-      GENERIC_PACK: /modpacks/tnp5.zip
-
-####################################################################
-#                          Server Memory                           #
-#                                                                  #
-# Set Maximum amount of memory allowed for your server.            #
-####################################################################
-      MEMORY: "8G"
-
-####################################################################
-#                         Logging Options                          #
-#                                                                  #
-# Set to "true" to delete old logs                                 #
-####################################################################
-      ENABLE_ROLLING_LOGS: "true"
-
-####################################################################
-#                          Server Timezone                         #
-#                                                                  #
-# Specify server Timezone                                          #
-####################################################################
-      TZ: "America/New_York"
-
-####################################################################
-#                       Minecraft Game Options                     #
-#                                                                  #
-# List any game options you want to define here. A full list can   #
-# be found on the readme.md page on github.                        #
-####################################################################
-      OVERRIDE_SERVER_PROPERTIES: "true"
-      DIFFICULTY: "easy"
-      MAX_TICK_TIME: "-1"
-      VIEW_DISTANCE: "6"
-      ALLOW_FLIGHT: "true"
-      OPS: ""
-      MAX_PLAYERS: 10
-      PVP: "false"
-      LEVEL_TYPE: "biomesoplenty"
-      MOTD: "Welcome Home"
-
-####################################################################
-#                            Volumes                               #
-#                                                                  #
-# Define data volume name here. You should leave this set to the   #
-# default.                                                         #
-####################################################################
-volumes:
-  data:

examples/docker-compose-generic-pack.yml

@@ -1,19 +0,0 @@
-services:
-  mc:
-    image: itzg/minecraft-server:${IMAGE_TAG:-latest}
-    volumes:
-    - data:/data
-    - ./modpacks:/modpacks:ro
-    environment:
-      EULA: "true"
-      TYPE: FORGE
-      DEBUG: "${DEBUG:-false}"
-      VERSION: ${VERSION:-1.17.1}
-      FORGE_VERSION: ${FORGE_VERSION:-37.0.90}
-      GENERIC_PACK: /modpacks/${MODPACK:-Server-Files-0.0.21.zip}
-      REMOVE_OLD_MODS: "${REMOVE_OLD_MODS:-false}"
-    ports:
-      - "25565:25565"
-
-volumes:
-  data: {}

examples/docker-compose-rconcmd.yml

@@ -12,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/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

@@ -0,0 +1,20 @@
+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
+      # Since Fabric server type only includes the loader, most times
+      # the fabric-api is required for other mods to function
+      MODRINTH_PROJECTS: |
+        fabric-api
+    ports:
+      - "25565:25565"
+    volumes:
+      - fabric:/data
+
+volumes:
+  fabric: {}

examples/ftba/compose.yml

@@ -12,6 +12,10 @@ services:
       # 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: ""
+      MOTD: |
+        An FTB server running
+        %MODPACK_NAME% version %MODPACK_VERSION%
+      MEMORY: 4G
     volumes:
       # use a named, managed volume for data volume
       - data:/data

examples/ftba/stoneblock4/compose.yml

@@ -0,0 +1,17 @@
+services:
+  mc:
+    image: itzg/minecraft-server:java25
+    tty: true
+    stdin_open: true
+    environment:
+      EULA: "TRUE"
+      TYPE: FTBA
+      FTB_MODPACK_ID: "130"
+      FTB_MODPACK_VERSION_ID: "100171"
+      MEMORY: "4G"
+    ports:
+      - "25565:25565"
+    volumes:
+      - data:/data
+volumes:
+  data: