cf: remove failed mod downloads (#3641)

Co-authored-by: Geoff Bourne <itzgeoff@gmail.com>

.github/workflows/build-multiarch.yml

@@ -12,6 +12,7 @@ on:
       - "examples/**"
       - "notes/**"
       - "kustomize/**"
+      - "images.json"
 
 jobs:
   build:
@@ -20,19 +21,31 @@ jobs:
       matrix:
         # NOTE: the "latest" variant is identified in the Docker meta step's 'latest' config
         variant:
-          - java21-graalvm
+          - java24
+          - java24-graalvm
           - java21
-          - java21-jdk
           - java21-alpine
+          - java21-graalvm
+          - java21-jdk
           - java17
           - java17-graalvm
           - java17-alpine
+          - java16
+          - java11
           - java8
           - java8-graalvm-ce
           - java8-openj9
           - java8-jdk
-          - java11
         include:
+        # JAVA 24
+          - variant: java24
+            baseImage: eclipse-temurin:24-jre
+            platforms: linux/amd64,linux/arm64
+            mcVersion: latest
+          - variant: java24-graalvm
+            baseImage: container-registry.oracle.com/graalvm/jdk:24-ol8
+            platforms: linux/amd64,linux/arm64
+            mcVersion: latest
         # JAVA 21:
           - variant: java21-graalvm
             baseImage: container-registry.oracle.com/graalvm/jdk:21-ol8
@@ -64,28 +77,41 @@ jobs:
             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
+            # Pin version for Java 8
+#            mcHelperVersion: 1.46.0
           - 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.46.0
           - variant: java8-jdk
             baseImage: eclipse-temurin:8u312-b07-jdk-focal
             platforms: linux/amd64,linux/arm64
             mcVersion: 1.12.2
+            # Pin version for Java 8
+#            mcHelperVersion: 1.46.0
           - 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.46.0
     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 != '' }}
@@ -93,14 +119,14 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v4.2.2
+        uses: actions/checkout@v5.0.0
         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.8.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 +134,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 +156,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.11.1
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3.3.0
+        uses: docker/setup-qemu-action@v3.6.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 +173,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
 
@@ -157,14 +186,14 @@ jobs:
           tests/test.sh
 
       - name: Login to DockerHub
-        uses: docker/login-action@v3.3.0
+        uses: docker/login-action@v3.5.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.5.0
         if: env.HAS_IMAGE_REPO_ACCESS
         with:
           registry: ghcr.io
@@ -172,7 +201,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 +225,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/verify-pr.yml

@@ -11,6 +11,7 @@ on:
       - "kustomize/**"
       - "docker-compose*.yml"
       - "mkdocs.yml"
+      - "images.json"
 
 jobs:
   build:
@@ -42,31 +43,34 @@ jobs:
             baseImage: eclipse-temurin:8u312-b07-jre-focal
             platforms: linux/amd64
             mcVersion: 1.12.2
+            # Pin version for Java 8
+            mcHelperVersion: 1.42.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@v5.0.0
         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.11.1
 
       - 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 +83,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

Dockerfile

@@ -19,38 +19,36 @@ RUN --mount=target=/build,source=build \
 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
+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.5
+ARG RESTIFY_VERSION=1.7.10
 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
+ARG RCON_CLI_VERSION=1.7.1
 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
+ARG MC_MONITOR_VERSION=0.15.6
 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
+ARG MC_SERVER_RUNNER_VERSION=1.13.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_VERSION=1.48.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
@@ -67,9 +65,8 @@ STOPSIGNAL SIGTERM
 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/shims/ /usr/local/bin/
+COPY --chmod=755 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
@@ -78,3 +75,8 @@ RUN dos2unix /start* /auto/*
 
 ENTRYPOINT [ "/start" ]
 HEALTHCHECK --start-period=2m --retries=2 --interval=30s CMD mc-health
+
+ARG BUILDTIME=local
+ARG VERSION=local
+ARG REVISION=local
+RUN echo "buildtime=${BUILDTIME}\nversion=${VERSION}\nrevision=${REVISION}" > /etc/image.properties

README.md

@@ -1,5 +1,5 @@
-[![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/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}/developer/EPEL/\$basearch/
 gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-oracle
 gpgcheck=1
 enabled=1

docs/Dockerfile

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

docs/commands.md

@@ -24,7 +24,7 @@ _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
+docker exec --user 1000 mc mc-send-to-console op player
             |                     |
             +- container name     +- Minecraft commands start here
 ```
@@ -50,9 +50,17 @@ 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**.
 

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`).
 

docs/configuration/jvm-options.md

@@ -8,10 +8,10 @@ By default, the image declares an initial and maximum Java memory-heap limit of
 - `INIT_MEMORY`: independently sets the initial heap size
 - `MAX_MEMORY`: independently sets the max heap size
 
-The values of all three are passed directly to the JVM and support format/units as `<size>[g|G|m|M|k|K]`. 
+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
     ```
@@ -23,7 +23,7 @@ The values of all three are passed directly to the JVM and support format/units
     ```
 
 !!! example "Using compose file"
-     
+
     ```
         environment:
           MEMORY: 2G
@@ -46,8 +46,9 @@ To let the JVM calculate the heap size from the container declared memory limit,
           MEMORY: ""
           JVM_XX_OPTS: "-XX:MaxRAMPercentage=75"
         deploy:
-          limits:
-            memory: 4G  
+          resources:
+            limits:
+              memory: 4G
     ```
 
 !!! important
@@ -67,7 +68,7 @@ docker run ... -e JVM_OPTS="-someJVMOption someJVMOptionValue" ...
 ```yaml
     environment:
       - EULA=true
-      - JVM_OPTS=-someJVMOption someJVMOptionValue 
+      - JVM_OPTS=-someJVMOption someJVMOptionValue
 ```
 
 Using object syntax is recommended and more intuitive:
@@ -111,7 +112,7 @@ If needing to map to a different port, then also set the environment variable `J
 !!! example
 
     With a compose file:
-    
+
     ```yaml
     environment:
       ENABLE_JMX: true
@@ -130,3 +131,13 @@ 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 using
+
+    -e USE_MEOWICE_FLAGS=true
+
+There is an optional `USE_MEOWICE_GRAALVM_FLAGS` variable to enable GraalVM specific optimizations, defaults to `TRUE` if USE_MEOWICE_GRAALVM_FLAGS is `TRUE`

docs/configuration/misc-options.md

@@ -24,14 +24,9 @@ docker run -d -v /path/on/host:/data \
 
 ## 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.
+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`.
 
-    -e UID=1234
-    -e GID=1234
-
-The container will also skip user switching if the `--user`/`-u` argument
-is passed to `docker run`.
+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
 
@@ -55,6 +50,16 @@ To allow time for players to finish what they're doing during a graceful server
     
     The grace period can be increased using [the -t option on docker-compose down](https://docs.docker.com/compose/reference/down/) or set the [stop_grace_period](https://docs.docker.com/compose/compose-file/05-services/#stop_grace_period) in the compose file.
 
+The `STOP_SERVER_ANNOUNCE_DELAY` can be bypassed by sending a `SIGUSR1` signal to the `mc-server-runner` process.
+
+`docker`:
+
+        docker stop --signal SIGUSR1 mc
+
+`docker compose`:
+
+        docker compose kill --signal SIGUSR1
+
 ## Configuration Options for Minecraft Server Health Monitoring
 
 The image tags include specific variables to simplify configuration for monitoring the health of a Minecraft server:
@@ -102,11 +107,7 @@ such as:
 
 ## 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
+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
 

docs/configuration/server-properties.md

@@ -84,9 +84,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,14 +207,34 @@ 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
 
@@ -226,125 +256,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 +293,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 +300,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 +312,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 +355,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 +396,47 @@ 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          |
+| 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)                                           |
+| 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)                             |
+| 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_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)                       |
+| 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)                             |
+| SPAWN_MONSTERS                    | [spawn-monsters](https://minecraft.wiki/w/Server.properties#spawn-monsters)                                       |
+| 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/index.md

@@ -29,7 +29,7 @@ where, in this case, the standard server port 25565, will be exposed on your hos
 
     **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/)
 
@@ -58,6 +58,9 @@ To apply changes made to the compose file, just run `docker compose up -d` again
 
 Follow the logs of the container using `docker compose logs -f`, check on the status with `docker compose ps`, and stop the container using `docker compose stop`.
 
+!!! note "Configurator Tool"
+    If you prefer to use an interactive tool to create or edit a Docker Compose file for this image, you can check out [setupmc.com's configurator](https://setupmc.com/java-server/). It provides a form that supports most of the image variables and generates the `compose.yml` file in real time.
+
 !!! note "More Compose Examples"
     There are more [examples located in the Github repo](https://github.com/itzg/docker-minecraft-server/tree/master/examples).
 

docs/misc/autopause-autostop/autopause.md

@@ -1,4 +1,8 @@
 # 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".
 
@@ -38,6 +42,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/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/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

@@ -31,15 +31,33 @@ services:
 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
+# 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 +72,19 @@ services:
   # Standard Docker Minecraft server, also works with other server types
   mc:
     image: itzg/minecraft-server:java21
-    container_name: minecraft-server
+    # 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
@@ -113,4 +139,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

@@ -16,14 +16,16 @@ 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"
+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`.
+: content in this directory is synchronized into `/data/plugins` for server types that use plugins, [as described above](#mods-vs-plugins). For special cases, the source can be changed by setting `COPY_PLUGINS_SRC` and destination by setting `COPY_PLUGINS_DEST`. If using a mod-based loader, such as Forge or Fabric, but a hybrid mod like [Cardboard](https://modrinth.com/mod/cardboard), then set `USES_PLUGINS` to have the automation utilize `/plugins` mount.
 
 `/mods`
 : content in this directory is synchronized into `/data/mods` for server types that use mods, [as described above](#mods-vs-plugins). For special cases, the source can be changed by setting `COPY_MODS_SRC` and destination by setting `COPY_MODS_DEST`.
@@ -41,8 +43,28 @@ For example: `-e REMOVE_OLD_MODS=TRUE -e REMOVE_OLD_MODS_INCLUDE="*.jar" -e REMO
 
 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).
+!!! 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).
+
 
 
 ## Zip file modpack
@@ -78,9 +100,24 @@ If applying large generic packs, the update can be time-consuming. To skip the u
 
 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

docs/mods-and-plugins/modrinth.md

@@ -12,15 +12,54 @@
   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.
+  
+  You can also reference a file containing project entries by prefixing the **container path** path with `@`.
         
-  | 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` |
+  | 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`                            |
+  | Projects Listing File           | `@/path/to/modrinth-mods.txt`                         |
+
+!!! 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
+    ```
+
+## 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
 
@@ -30,3 +69,6 @@
 `MODRINTH_ALLOWED_VERSION_TYPE`
 : The version type is used to determine the newest version to use from each project. The allowed values are `release` (default), `beta`, `alpha`. 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/requirements.txt

@@ -1,7 +1,7 @@
-mkdocs-material == 9.5.50
-mkdocs-autorefs == 1.3.0
-mkdocstrings == 0.27.0
-mkdocs-literate-nav == 0.6.1
+mkdocs-material == 9.6.18
+mkdocs-autorefs == 1.4.3
+mkdocstrings[python] == 0.30.0
+mkdocs-literate-nav == 0.6.2
 mdx-gh-links == 0.4
-mkdocs-click == 0.8.1
-mkdocs-static-i18n == 1.2.3
+mkdocs-click == 0.9.0
+mkdocs-static-i18n == 1.3.0

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

@@ -12,6 +12,7 @@ To manage a CurseForge modpack automatically with upgrade support, pinned or lat
     
     Example if your key is `$11$22$33aaaaaaaaaaaaaaaaaaaaaaaaaa`:
     ```yaml
+    # compose.yaml
     environment:
       CF_API_KEY: '$$11$$22$$33aaaaaaaaaaaaaaaaaaaaaaaaaa'
     ```
@@ -21,16 +22,48 @@ To manage a CurseForge modpack automatically with upgrade support, pinned or lat
     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:
+    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**. 
+    
+    ```
+    # .env
+    CF_API_KEY='$11$22$33aaaaaaaaaaaaaaaaaaaaaaaaaa'
+    ```
+    
+    The variable should to be referenced from the compose file, such as:
+    
     ```yaml
+    # compose.yaml
     environment:
       CF_API_KEY: ${CF_API_KEY}
     ```
     
+    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:
     ```
     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:
+    ```
+    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).
@@ -56,7 +89,9 @@ For example:
 -e TYPE=AUTO_CURSEFORGE -e CF_SLUG=all-the-mods-8
 ```
 
-The latest file will be located and used by default, but if a specific version is desired you can use one of the following options. With any of these options **do not select a server file** -- they lack the required manifest and defeat the ability to consistently automate startup.
+### Pinning modpack and mod loader versions
+
+The latest modpack file and its associated mod loader will be located and installed by default on startup (including automatic upgrading of both on subsequent startups, if a later version is found on CurseForge). If a specific version is desired instead, you can use one of the following options. With any of these options **do not select a server file** -- they lack the required manifest and defeat the ability to consistently automate startup.
 
 - Use `CF_PAGE_URL`, but include the full URL to a specific file
 - Set `CF_FILE_ID` to the numerical file ID
@@ -82,6 +117,8 @@ The following examples all refer to version 1.0.7 of ATM8:
   CF_FILENAME_MATCHER: 1.0.7
 ```
 
+Pinning modpack version also pins the mod loader (to the version specified by the modpack). Mod loader version cannot be pinned independently of the modpack.
+
 ## Manual Downloads
 
 For mod, modpacks, and world files that are not allowed for automated download, the container path `/downloads` can be attached and matching files will be retrieved from there. The subdirectories `mods`, `modpacks`, and `worlds` will also be checked accordingly. To change the source location of downloaded files, set `CF_DOWNLOADS_REPO` to an existing container path. To disable this feature, set `CF_DOWNLOADS_REPO` to an empty string.

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
+
+    ```
+    docker run -d -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
+
+    ```
+    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,5 +1,13 @@
 A [Forge server](http://www.minecraftforge.net/) can be automatically downloaded, upgraded, and run by setting the environment variable `TYPE` to "FORGE".
 
+!!! note "A note from the installer"
+
+    > Please do not automate the download and installation of Forge.
+    Our efforts are supported by ads from the download page.
+    If you MUST automate this, please consider supporting the project through <https://www.patreon.com/LexManos/>
+
+    Since my project also relies on donations, please pass it along and consider contributing to the Patreon above.
+
 !!! example
 
     ```
@@ -14,6 +22,7 @@ A [Forge server](http://www.minecraftforge.net/) can be automatically downloaded
 
 The overall version is specified by `VERSION`, [as described in the section above](../../versions/minecraft.md) and provides the same benefits of upgrading as new versions are released. By default, the recommended version of Forge for that Minecraft version will be selected. The latest version can be selected instead by setting the environment variable `FORGE_VERSION` to "latest". You can also choose a specific Forge version by setting `FORGE_VERSION` with that version, such as "14.23.5.2854".
 
+
 !!! example
 
     ```
@@ -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
@@ -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,6 +49,34 @@ By default the latest build will be used; however, a specific build number can b
 
     -e VERSION=1.16.5 -e MOHIST_BUILD=374
 
+### Youer
+
+A [Youer](https://github.com/MohistMC/Youer) server can be used with
+
+    -e TYPE=YOUER
+
+!!! 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
+
 ### Catserver
 
 A [Catserver](http://catserver.moe/) type server can be used with
@@ -56,3 +84,10 @@ A [Catserver](http://catserver.moe/) type server can be used with
     -e TYPE=CATSERVER
 
 > **NOTE** Catserver only provides a single release stream, so `VERSION` is ignored
+
+### 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

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

@@ -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".
@@ -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/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
 
@@ -81,6 +81,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>
@@ -711,7 +723,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 +742,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>

docs/versions/java.md

@@ -10,24 +10,29 @@ 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         | 21           | Ubuntu | Hotspot            | amd64, arm64        |      |
+| stable         | 21           | Ubuntu | Hotspot            | amd64, arm64        |      |
+| java24         | 24           | Ubuntu | Hotspot            | amd64, arm64        | (2)  |
+| java24-graalvm | 24           | Oracle | Oracle GraalVM (3) | amd64, arm64        | (2)  |   
+| 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        |      |   
+| java17         | 17           | Ubuntu | Hotspot            | amd64, arm64, armv7 |      |
+| java17-graalvm | 17           | Oracle | Oracle GraalVM (3) | amd64, arm64        |      |   
+| java17-alpine  | 17           | Alpine | Hotspot            | amd64  (1)          |      |
+| java16         | 16           | Ubuntu | Hotspot            | amd64, arm64, armv7 | (4)  |
+| java11         | 11           | Ubuntu | Hotspot            | amd64, arm64, armv7 |      |
+| java8          | 8            | Ubuntu | Hotspot            | amd64, arm64, armv7 |      |
+
+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 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.
+4. This version of Java is [recommended for PaperMC 1.16.5](https://docs.papermc.io/paper/getting-started/#requirements)
 
 !!! example "Example using java8"
 
@@ -73,7 +78,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 +126,20 @@ 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
+- java19
 - java20-graalvm, java20, java20-alpine
+- java23-*
 - 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 programmatically at <https://raw.githubusercontent.com/itzg/docker-minecraft-server/refs/heads/master/images.json>

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,7 +8,10 @@ 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

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/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,20 +7,20 @@ 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
         creative-core
         default-options
         itemphysic-lite
         konkrete
         oauth
-        sound-filters
-        toast-control
       CF_FORCE_SYNCHRONIZE: "true"
       MEMORY: 4G
     volumes:

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/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

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

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

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

examples/lazymc/docker_compose.yml

@@ -1,12 +1,30 @@
+# 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.
@@ -21,11 +39,19 @@ services:
   # Standard Docker Minecraft server, also works with other server types
   mc:
     image: itzg/minecraft-server:java21
-    container_name: minecraft-server
+    # 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

examples/modrinth/bmc4/compose.yml

@@ -1,20 +1,20 @@
-services:
-  mc:
-    image: itzg/minecraft-server
-    environment:
-      EULA: true
-      MODPACK_PLATFORM: MODRINTH
-      MODRINTH_MODPACK: https://modrinth.com/modpack/better-mc-forge-bmc4/version/v32.5
-      MODRINTH_EXCLUDE_FILES: |
-        XaeroPlus
-        XaerosWorldMap
-      MODRINTH_OVERRIDES_EXCLUSIONS: |
-        mods/citresewn-*.jar
-        **/datapacks/BE_default_endgen_fix*
-      MODRINTH_FORCE_SYNCHRONIZE: true
-      MEMORY: 4G
-    ports:
-      - "25565:25565"
-    # declare /data volume mapping as desired
-#    volumes:
-#      - ./data:/data
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: true
+      MODPACK_PLATFORM: MODRINTH
+      # NOTE: v36 doesn't startup correctly
+      MODRINTH_MODPACK: https://modrinth.com/modpack/better-mc-forge-bmc4/version/v34.5
+      MODRINTH_OVERRIDES_EXCLUSIONS: |
+        config/paxi/datapacks/BE_default_endgen_fix*
+      MODRINTH_FORCE_SYNCHRONIZE: true
+      MEMORY: 4G
+    ports:
+      - "25565:25565"
+    volumes:
+      - mc-data:/data
+      # or use a host directory binding
+#      - ./data:/data
+volumes:
+  mc-data:

examples/modrinth/version-from-modrinth-projects/compose.yml

@@ -0,0 +1,15 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: true
+      TYPE: paper
+      MODRINTH_PROJECTS: |
+        viaversion
+        viabackwards
+        griefprevention
+        discordsrv
+      VERSION_FROM_MODRINTH_PROJECTS: true
+      MEMORY: 2G
+    ports:
+      - "25565:25565"

examples/mohist/compose.yml

@@ -7,7 +7,7 @@ services:
       EULA: "TRUE"
       TYPE: MOHIST
       VERSION: 1.12.2
-      DEBUG: "true"
+      MOHIST_BUILD: 347
     volumes:
       - data:/data
 

examples/packwiz/compose.yml

@@ -0,0 +1,16 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    tty: true
+    stdin_open: true
+    environment:
+      EULA: true
+      # Match loader from versions section of https://github.com/packwiz/packwiz-example-pack/blob/v1/pack.toml
+      TYPE: QUILT
+      VERSION: "1.19"
+      QUILT_LOADER_VERSION: "0.17.0"
+      PACKWIZ_URL: https://raw.githubusercontent.com/packwiz/packwiz-example-pack/refs/heads/v1/pack.toml
+    volumes:
+      - ./data:/data
+    ports:
+      - "25565:25565"

examples/paper/compose.yml

@@ -1,16 +1,16 @@
 services:
   mc:
     image: itzg/minecraft-server
-    container_name: paper
+    tty: true
+    stdin_open: true
     environment:
       EULA: "true"
       TYPE: PAPER
-      VIEW_DISTANCE: 10
       MEMORY: 2G
     ports:
       - "25565:25565"
     volumes:
-      - mc-paper:/data
+      - mc-data:/data
     restart: unless-stopped
 volumes:
-  mc-paper: {}
+  mc-data: {}

examples/pixelmon/docker-compose.yml

@@ -1,17 +0,0 @@
-services:
-  mc:
-    image: itzg/minecraft-server:java8-multiarch
-    ports:
-      - "25565:25565"
-    environment:
-      EULA: "true"
-      MODPACK_PLATFORM: AUTO_CURSEFORGE
-      CF_API_KEY: # allocate from https://console.curseforge.com/
-      CF_SLUG: the-pixelmon-modpack
-      CF_FILENAME_MATCHER: "9.1.2"
-      MEMORY: 4G
-    volumes:
-      - mc-data:/data
-
-volumes:
-  mc-data: {}

examples/rlcraft/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: rlcraft
       CF_FILENAME_MATCHER: 2.9.3

examples/skyfactory5/compose.yml

@@ -1,19 +0,0 @@
-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/6044634
-      CF_SLUG: skyfactory-5
-      CF_FILENAME_MATCHER: 5.0.2
-      # Loads from .env file
-      CF_API_KEY: ${CF_API_KEY}
-      MEMORY: 4G
-    ports:
-      - "25565:25565"
-    volumes:
-      - mc-data:/data
-volumes:
-  mc-data:

examples/valhesia5/docker-compose.yml

@@ -1,17 +0,0 @@
-services:
-  mc:
-    image: itzg/minecraft-server
-    ports:
-      - "25565:25565"
-    environment:
-      EULA: "true"
-      MODPACK_PLATFORM: AUTO_CURSEFORGE
-      CF_API_KEY: # allocate from https://console.curseforge.com/
-      CF_FORCE_SYNCHRONIZE: "true"
-      CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/valhelsia-5/files/4429560
-      MEMORY: 4G
-    volumes:
-      - data:/data
-
-volumes:
-  data: {}

files/auto/autopause-daemon.sh

@@ -45,11 +45,7 @@ if isTrue "${DEBUG_AUTOPAUSE}"; then
   knockdArgs+=(-D)
 fi
 
-if isTrue "${SKIP_SUDO}"; then
-  /usr/local/sbin/knockd "${knockdArgs[@]}"
-else
-  sudo /usr/local/sbin/knockd "${knockdArgs[@]}"
-fi
+/usr/local/sbin/knockd "${knockdArgs[@]}"
 
 if [ $? -ne 0 ] ; then
   logAutopause "Failed to start knockd daemon."

files/auto/autopause-fcns.sh

@@ -24,14 +24,31 @@ use_proxy() {
   fi
 }
 
+use_server_list_ping() {
+  if [[ "${VERSION^^}" == "LATEST" || "${VERSION^^}" == "SNAPSHOT" ]]; then
+    # Don't use server-list ping for unknown version
+    return 1
+  fi
+
+  if versionLessThan 1.7; then
+    echo "--use-server-list-ping"
+  fi
+}
+
+
 mc_server_listening() {
-  mc-monitor status $(use_proxy) --host "${SERVER_HOST:-localhost}" --port "$SERVER_PORT" --timeout 10s >&/dev/null
+  mc-monitor status $(use_proxy) --host "${SERVER_HOST:-localhost}" --port "$SERVER_PORT" $(use_server_list_ping) --timeout 10s >&/dev/null
 }
 
 java_clients_connections() {
   local connections
   if java_running; then
-    if ! connections=$(mc-monitor status $(use_proxy) --host "${SERVER_HOST:-localhost}" --port "$SERVER_PORT" --show-player-count); then
+    if ! connections=$(mc-monitor status \
+        --host "${SERVER_HOST:-localhost}" \
+        --port "$SERVER_PORT" \
+        --retry-limit "${AUTOPAUSE_STATUS_RETRY_LIMIT:-10}" --retry-interval "${AUTOPAUSE_STATUS_RETRY_INTERVAL:-2s}" \
+        $(use_proxy) $(use_server_list_ping) \
+        --show-player-count); then
       # consider it a non-zero player count if the ping fails
       # otherwise a laggy server with players connected could get paused
       connections=1
@@ -44,4 +61,4 @@ java_clients_connections() {
 
 java_clients_connected() {
   (( $(java_clients_connections) > 0 ))
-}
+}

files/auto/stop.sh

@@ -6,8 +6,5 @@ if isTrue "${DEBUG_AUTOSTOP}"; then
 fi
 
 logAutostopAction "Stopping Java process"
-if isTrue "${AUTOSTOP_PKILL_USE_SUDO:-false}"; then
-  sudo pkill -f --signal SIGTERM mc-server-runner
-else
-  pkill -f --signal SIGTERM mc-server-runner
-fi
+pkill -f --signal SIGTERM mc-server-runner
+

files/cf-exclude-include.json

@@ -11,20 +11,26 @@
     "beehivetooltips",
     "better-advancements",
     "better-foliage",
+    "better-modlist-neoforge",
     "better-placement",
     "better-sprinting",
     "better-third-person",
     "better-tips-nbt-tag",
     "betterf3",
     "betterfps",
+    "bettergrassify",
     "biomeinfo",
     "block-drops-jei-addon",
     "blur-forge",
     "cartography",
+    "chattoggle",
     "cherished-worlds",
     "chunk-animator",
     "clickable-advancements",
+    "compass-coords",
+    "config-menus-forge",
     "configured",
+    "controllable",
     "controlling",
     "craftpresence",
     "ctm",
@@ -32,8 +38,10 @@
     "dark-mode-everywhere",
     "defensive-measures",
     "ding",
+    "distraction-free-recipes",
     "drippy-loading-screen",
     "dynamic-surroundings",
+    "dynamic-view",
     "dynamiclights-reforged",
     "easiervillagertrading",
     "effective-forge",
@@ -41,18 +49,27 @@
     "embeddium-extension",
     "embeddium-extras",
     "enchantment-descriptions",
+    "enhanced-boss-bars",
     "enhancedvisuals",
     "entity-collision-fps-fix",
+    "entity-model-features",
     "entity-texture-features-fabric",
     "entityculling",
     "equipment-compare",
+    "essential-mod",
+    "euphoria-patches",
     "extreme-sound-muffler",
     "ezzoom",
     "fading-night-vision",
     "falling-leaves-forge",
     "fancymenu",
+    "farsight",
     "faster-ladder-climbing",
+    "fastquit",
+    "fastquit-forge",
+    "flerovium",
     "foamfix-optimization-mod",
+    "forgeskyboxes",
     "fps-reducer",
     "free-cam",
     "ftb-backups-2",
@@ -60,6 +77,7 @@
     "hwyla",
     "iceberg",
     "ignitioncoil",
+    "illager-raid-music",
     "inmisaddon",
     "iris-flywheel-compat",
     "irisshaders",
@@ -72,12 +90,13 @@
     "just-enough-mekanism-multiblocks",
     "just-enough-resources-jer",
     "just-zoom",
-    "konkrete",
     "legendary-tooltips",
     "lighty",
     "loot-capacitor-tooltips",
+    "loot-journal",
     "lootbeams",
     "magnesium-extras",
+    "make-bubbles-pop",
     "menumobs",
     "minecraft-rich-presence",
     "model-gap-fix",
@@ -93,7 +112,12 @@
     "overloaded-armor-bar",
     "packmenu",
     "packmodemenu",
+    "particle-effects",
+    "particle-effects-reforged",
+    "particular",
+    "particular-reforged",
     "reauth",
+    "rebind-narrator",
     "reblured",
     "reeses-sodium-options",
     "reforgium",
@@ -105,17 +129,21 @@
     "seamless-loading-screen",
     "seamless-loading-screen-forge",
     "searchables",
+    "seasonhud",
     "shulkerboxviewer",
     "skin-layers-3d",
     "smart-hud",
+    "smithing-template-viewer",
     "smooth-font",
     "smoothwater",
     "sodium",
     "sodium-extra",
     "sodium-options-api",
     "sodium-rubidium-occlusion-culling-fix",
+    "sound",
     "sound-filters",
     "sound-physics-remastered",
+    "sound-reloader",
     "stellar-sky",
     "swingthroughgrass",
     "textrues-embeddium-options",
@@ -129,7 +157,10 @@
     "vanillafix",
     "visuality",
     "waila-harvestability",
+    "waila-stages",
+    "wakes-reforged",
     "wawla",
+    "welcome-screen",
     "xaeroplus",
     "yungs-menu-tweaks",
     "zume"
@@ -138,6 +169,9 @@
     "all-of-fabric-6": {
       "forceIncludes": ["revelationary"]
     },
+    "beyond-depth": {
+      "forceIncludes": ["particular-reforged"]
+    },
     "create-arcane-engineering": {
       "forceIncludes": ["just-enough-resources-jer"]
     },
@@ -150,6 +184,12 @@
     },
     "valhelsia-5": {
       "excludes": ["modernfix"]
+    },
+    "mc-eternal-2": {
+      "forceIncludes": [
+        "particular-reforged",
+        "mob-player-animator"
+      ]
     }
   }
 }

files/log4j2.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<Configuration status="WARN" packages="com.mojang.util">
+<Configuration status="WARN">
     <Appenders>
         <Console name="SysOut" target="SYSTEM_OUT">
             <PatternLayout pattern="[%d{HH:mm:ss}] [%t/%level]: %msg%n" />
@@ -34,4 +34,4 @@
             <AppenderRef ref="TerminalConsole"/>
         </Root>
     </Loggers>
-</Configuration>
+</Configuration>

files/modrinth-exclude-include.json

@@ -11,6 +11,8 @@
     "BadOptimizations",
     "BetterAdvancements",
     "betterbeds",
+    "BetterF3",
+    "BetterGrassify",
     "BetterThirdPerson",
     "BHMenu",
     "blur",
@@ -22,13 +24,21 @@
     "cherishedworlds",
     "citresewn",
     "clickadv",
+    "cobblemon-ui-tweaks",
+    "compass-coords",
     "connectedness",
     "connector",
+    "continuity",
+    "controlling",
     "craftpresence",
     "cwb",
     "DisableCustomWorldsAdvice",
+    "distraction_free_recipes",
     "drippyloadingscreen",
     "eating-animation",
+    "emi",
+    "emi_loot",
+    "emi_trade",
     "emiffect",
     "emitrades",
     "entity_model_features",
@@ -38,14 +48,17 @@
     "fallingleaves",
     "fancymenu",
     "fast-ip-ping",
+    "fastquit",
     "FauxCustomEntityData",
     "feytweaks",
     "figura",
+    "ForgeConfigScreens",
     "GeckoLibIrisCompat",
     "gpumemleakfix",
     "Highlighter",
     "ImmediatelyFast",
     "indium",
+    "inventory-profiles-next",
     "iris",
     "iris-flywheel",
     "ItemBorders",
@@ -65,9 +78,10 @@
     "PickUpNotifier",
     "PresenceFootsteps",
     "Prism",
-    "reforgium",
     "reeses_sodium_options",
+    "reforgium",
     "ResourcePackOverrides",
+    "roughly-enough-items",
     "ryoamiclights",
     "screenshot_viewer",
     "Searchables",
@@ -76,13 +90,24 @@
     "skinlayers3d",
     "sodium",
     "sorted_enchantments",
+    "tooltipfix",
     "visuality",
     "VR-Combat",
+    "WailaStages",
+    "welcomescreen",
+    "Xaeros_Minimap",
+    "XaerosWorldMap",
     "YeetusExperimentus",
     "yungsmenutweaks",
     "Zoomify",
     "zume"
   ],
   "globalForceIncludes": [],
-  "modpacks": {}
-}
+  "modpacks": {
+    "cobbleverse": {
+      "excludes": [
+        "cloth-config"
+      ]
+    }
+  }
+}

files/property-definitions.json

@@ -1,10 +1,11 @@
 {
+  "accepts-transfers": {"env": "ACCEPTS_TRANSFERS"},
   "allow-flight": {"env": "ALLOW_FLIGHT"},
   "allow-nether": {"env": "ALLOW_NETHER"},
-  "bug-report-link": {"env": "BUG_REPORT_LINK"},
   "announce-player-achievements": {"env": "ANNOUNCE_PLAYER_ACHIEVEMENTS"},
   "broadcast-console-to-ops": {"env": "BROADCAST_CONSOLE_TO_OPS"},
   "broadcast-rcon-to-ops": {"env": "BROADCAST_RCON_TO_OPS"},
+  "bug-report-link": {"env": "BUG_REPORT_LINK"},
   "difficulty": {"env": "DIFFICULTY"},
   "enable-command-block": {"env": "ENABLE_COMMAND_BLOCK"},
   "enable-jmx-monitoring": {"env": "ENABLE_JMX"},
@@ -27,6 +28,9 @@
   "level-seed": {"env": "SEED"},
   "level-type": {"env": "LEVEL_TYPE"},
   "log-ips": {"env": "LOG_IPS"},
+  "management-server-enabled": {"env": "MANAGEMENT_SERVER_ENABLED"},
+  "management-server-host": {"env": "MANAGEMENT_SERVER_HOST"},
+  "management-server-port": {"env": "MANAGEMENT_SERVER_PORT"},
   "max-build-height": {"env": "MAX_BUILD_HEIGHT"},
   "max-chained-neighbor-updates": {"env": "MAX_CHAINED_NEIGHBOR_UPDATES"},
   "max-players": {"env": "MAX_PLAYERS"},
@@ -42,14 +46,15 @@
   "previews-chat": {"env": "PREVIEWS_CHAT"},
   "pvp": {"env": "PVP"},
   "query.port": {"env": "QUERY_PORT"},
+  "rate-limit": {"env": "RATE_LIMIT"},
   "rcon.password": {"env": "RCON_PASSWORD"},
   "rcon.port": {"env": "RCON_PORT"},
   "region-file-compression": {"env": "REGION_FILE_COMPRESSION"},
-  "resource-pack": {"env": "RESOURCE_PACK"},
+  "require-resource-pack": {"env": "RESOURCE_PACK_ENFORCE"},
   "resource-pack-id": {"env": "RESOURCE_PACK_ID"},
   "resource-pack-prompt": {"env": "RESOURCE_PACK_PROMPT"},
   "resource-pack-sha1": {"env": "RESOURCE_PACK_SHA1"},
-  "require-resource-pack": {"env": "RESOURCE_PACK_ENFORCE"},
+  "resource-pack": {"env": "RESOURCE_PACK"},
   "server-ip": {"env": "SERVER_IP"},
   "server-name": {"env": "SERVER_NAME"},
   "server-port": {"env": "SERVER_PORT"},
@@ -59,6 +64,7 @@
   "spawn-monsters": {"env": "SPAWN_MONSTERS"},
   "spawn-npcs": {"env": "SPAWN_NPCS"},
   "spawn-protection": {"env": "SPAWN_PROTECTION"},
+  "status-heartbeat-interval": {"env": "STATUS_HEARTBEAT_INTERVAL"},
   "sync-chunk-writes": {"env": "SYNC_CHUNK_WRITES"},
   "use-native-transport": {"env": "USE_NATIVE_TRANSPORT"},
   "view-distance": {"env": "VIEW_DISTANCE"},

files/shims/mc-send-to-console

@@ -17,8 +17,9 @@ if [ ! -p "${CONSOLE_IN_NAMED_PIPE}" ]; then
   exit 1
 fi
 
-if [ "$(id -u)" = 0 -a $UID != 0 ]; then
-  exec $(getSudoFromDistro) minecraft bash -c "echo '$*' > '${CONSOLE_IN_NAMED_PIPE}'"
+if [[ "$(id -u)" = 0 ]] && [[ $UID != 0 ]]; then
+  error "Exec needs to be run with user ID $UID"
+  exit 2
 else
   echo "$@" >"${CONSOLE_IN_NAMED_PIPE}"
 fi