build(deps): bump the patches group in /docs with 1 update (#2750)

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

.github/workflows/build-multiarch.yml

@@ -111,7 +111,7 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v4.1.1
+        uses: actions/checkout@v4.1.2
         with:
           # for build-files step
           fetch-depth: 0
@@ -144,13 +144,13 @@ jobs:
             org.opencontainers.image.authors=Geoff Bourne <itzgeoff@gmail.com>
 
       - name: Setup Docker Buildx
-        uses: docker/setup-buildx-action@v3.0.0
+        uses: docker/setup-buildx-action@v3.2.0
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3.0.0
 
       - name: Build for test
-        uses: docker/build-push-action@v5.1.0
+        uses: docker/build-push-action@v5.3.0
         with:
           platforms: linux/amd64
           tags: ${{ env.IMAGE_TO_TEST }}
@@ -173,14 +173,14 @@ jobs:
           tests/test.sh
 
       - name: Login to DockerHub
-        uses: docker/login-action@v3.0.0
+        uses: docker/login-action@v3.1.0
         if: env.HAS_IMAGE_REPO_ACCESS
         with:
           username: ${{ secrets.DOCKER_USER }}
           password: ${{ secrets.DOCKER_PASSWORD }}
 
       - name: Login to GHCR
-        uses: docker/login-action@v3.0.0
+        uses: docker/login-action@v3.1.0
         if: env.HAS_IMAGE_REPO_ACCESS
         with:
           registry: ghcr.io
@@ -188,7 +188,7 @@ jobs:
           password: ${{ github.token }}
 
       - name: Build and push
-        uses: docker/build-push-action@v5.1.0
+        uses: docker/build-push-action@v5.3.0
         if: github.actor == github.repository_owner
         with:
           platforms: ${{ matrix.platforms }}

.github/workflows/verify-pr.yml

@@ -45,16 +45,16 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v4.1.1
+        uses: actions/checkout@v4.1.2
         with:
           # for build-files step
           fetch-depth: 0
 
       - name: Setup Docker Buildx
-        uses: docker/setup-buildx-action@v3.0.0
+        uses: docker/setup-buildx-action@v3.2.0
 
       - name: Confirm multi-arch build
-        uses: docker/build-push-action@v5.1.0
+        uses: docker/build-push-action@v5.3.0
         with:
           platforms: ${{ matrix.platforms }}
           # ensure latest base image is used
@@ -64,7 +64,7 @@ jobs:
           cache-from: type=gha,scope=${{ matrix.variant }}
 
       - name: Build for test
-        uses: docker/build-push-action@v5.1.0
+        uses: docker/build-push-action@v5.3.0
         with:
           # Only build single platform since loading multi-arch image into daemon fails with
           # "docker exporter does not currently support exporting manifest lists"

Dockerfile

@@ -44,12 +44,12 @@ RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
   --var version=${MC_MONITOR_VERSION} --var app=mc-monitor --file {{.app}} \
   --from ${GITHUB_BASEURL}/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
-ARG MC_SERVER_RUNNER_VERSION=1.11.1
+ARG MC_SERVER_RUNNER_VERSION=1.12.0
 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.38.5
+ARG MC_HELPER_VERSION=1.38.7
 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

docs/requirements.txt

@@ -1,8 +1,8 @@
 mkdocs == 1.5.3
-mkdocs-material == 9.5.11
-mkdocs-autorefs == 0.5.0
-mkdocstrings == 0.24.0
+mkdocs-material == 9.5.16
+mkdocs-autorefs == 1.0.1
+mkdocstrings == 0.24.1
 mkdocs-literate-nav == 0.6.1
 mdx-gh-links == 0.4
 mkdocs-click == 0.8.1
-mkdocs-static-i18n == 1.2.0
+mkdocs-static-i18n == 1.2.2

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

@@ -59,4 +59,35 @@ To exclude client mods that are incorrectly declared by the modpack as server-co
         notenoughanimations
         lambdynamiclights
         euphoriapatcher
-    ```
+    ```
+
+## Excluding Overrides Files
+
+Modrinth mrpack/zip files may include an `overrides` subdirectory that contains config files, world data, and extra mod files. All of those files will be extracted into the `/data` path of the container. If any of those files, such as incompatible mods, need to be excluded from extraction, then the `MODRINTH_OVERRIDES_EXCLUSIONS` variable can be set with a comma or newline delimited list of ant-style paths ([see below](#ant-style-paths)) to exclude, relative to the overrides (or `/data`) directory.
+
+### Ant-style paths
+
+Ant-style paths can include the following globbing/wildcard symbols:
+
+| Symbol | Behavior                                                |
+|--------|---------------------------------------------------------|
+| `*`    | Matches zero, one, or many characters except a slash    |
+| `**`   | Matches zero, one, or many characters including slashes |
+| `?`    | Matches one character                                   |
+
+!!! example
+
+    The following compose `environment` entries show how to exclude Iris and Sodium mods from the overrides
+    
+    ```yaml
+      MODRINTH_OVERRIDES_EXCLUSIONS: mods/NekosEnchantedBooks-*.jar,mods/citresewn-*.jar
+    ```
+    
+    or using newline delimiter, which improves maintainability
+    
+    ```yaml
+      MODRINTH_OVERRIDES_EXCLUSIONS: |
+        mods/NekosEnchantedBooks-*.jar
+        mods/citresewn-*.jar
+    ```
+

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

@@ -8,7 +8,7 @@ A [Magma](https://magmafoundation.org/) server, which is a combination of Forge
 
 !!! note
 
-    The Magma project has been terminated ([original link died](https://git.magmafoundation.org/magmafoundation/magma-1-20-x/-/commit/4e7abe37403c47d09b74b77bcfc26a19b18f5891), [alternate statement on their discord](https://discord.com/channels/612695539729039411/647287352833605662/1174412642962649198) ). Please use Magma Maintained for 1.12.2, 1.18.2, 1.19.3, and 1.20.1, or Ketting for 1.20.1+.
+    The Magma project has been terminated ([original link died](https://git.magmafoundation.org/magmafoundation/magma-1-20-x/-/commit/4e7abe37403c47d09b74b77bcfc26a19b18f5891), [alternate statement on their discord](https://discord.com/channels/612695539729039411/647287352833605662/1174412642962649198) ). Please use Magma Maintained for 1.12.2, 1.18.2 and 1.19.3, or Ketting for 1.20.1+.
 
     There are limited base versions supported, so you will also need to  set `VERSION`, such as "1.12.2", "1.16.5", etc.
 

examples/bmc4/docker-compose.yml

@@ -0,0 +1,32 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: true
+      TYPE: MODRINTH
+      MEMORY: 4G
+      MODRINTH_MODPACK: better-mc-forge-bmc4
+      MODRINTH_VERSION: v4
+      MODRINTH_FORCE_SYNCHRONIZE: true
+      MODRINTH_EXCLUDE_FILES: |
+        citresewn
+        oculus
+        yungsmenutweaks
+        notenoughanimations
+        ryoamiclights
+        euphoriapatcher
+        entity_model_features
+        entity_texture_features
+        3dskinlayers
+      MODRINTH_OVERRIDES_EXCLUSIONS: |
+        mods/NekosEnchantedBooks-*.jar
+        mods/citresewn-*.jar
+      DEBUG: true
+      SETUP_ONLY: true
+    volumes:
+      - data:/data
+    ports:
+      - "25565:25565"
+
+volumes:
+  data: {}

examples/docker-compose-tailscale.yml

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

examples/docker-compose.yml

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

examples/ketting/docker-compose.yml

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

examples/spigot/docker-compose.yml

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

files/auto/autopause-daemon.sh

@@ -124,11 +124,7 @@ do
         STATE=E
       else
         TIME_THRESH=$(($(current_uptime)+$AUTOPAUSE_TIMEOUT_KN))
-        from=unknown
-        if [ -e /var/log/knocked-source ]; then
-          from=$(cat /var/log/knocked-source)
-        fi
-        logAutopause "Server was knocked from $from - waiting for clients or timeout"
+        logAutopause "Server was knocked - waiting for clients or timeout"
         STATE=K
       fi
     fi

files/auto/resume.sh

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

scripts/start-configuration

@@ -225,17 +225,14 @@ case "${TYPE^^}" in
   ;;
 
   CUSTOM)
-    evaluateJavaCompatibilityForForge
     exec "${SCRIPTS:-/}start-deployCustom" "$@"
   ;;
 
   MAGMA)
-    evaluateJavaCompatibilityForForge
     exec "${SCRIPTS:-/}start-deployMagma" "$@"
   ;;
 
   MAGMA_MAINTAINED)
-    evaluateJavaCompatibilityForForge
     exec "${SCRIPTS:-/}start-deployMagmaMaintained" "$@"
   ;;
 
@@ -244,12 +241,10 @@ case "${TYPE^^}" in
   ;;
 
   MOHIST)
-    evaluateJavaCompatibilityForForge
     exec "${SCRIPTS:-/}start-deployMohist" "$@"
   ;;
 
   CATSERVER)
-    evaluateJavaCompatibilityForForge
     exec "${SCRIPTS:-/}start-deployCatserver" "$@"
   ;;
 

scripts/start-deployBukkitSpigot

@@ -76,35 +76,50 @@ function downloadSpigot {
   fi
 
   setServerVar
+  curlArgs=()
   if [ -f "$SERVER" ] && ! isTrue "$FORCE_REDOWNLOAD"; then
     # tell curl to only download when newer
-    curlArgs="-z $SERVER"
+    curlArgs+=(-z "$SERVER")
   fi
   if isDebugging; then
-    curlArgs="$curlArgs -v"
+    curlArgs+=(-v)
   fi
   log "Downloading $match from $downloadUrl ..."
-  curl -fsSL -o "$SERVER" $curlArgs "$downloadUrl"
-  if [[ $? != 0 || $(grep -c "DOCTYPE html" "$SERVER") != 0 ]]; then
+
+  tempFile="$SERVER.$$"
+
+  # HTTP error or download site responded with an HTML error page
+  if ! curl -fsSL -o "$tempFile" "${curlArgs[@]}" "$downloadUrl" || ( [ -f "$tempFile" ] && grep -iq "doctype html" "$tempFile" ); then
+
     cat <<EOF
 
 ERROR: failed to download from $downloadUrl
        Visit https://getbukkit.org/download/${getbukkitFlavor} to lookup the
-       exact version, such as 1.4.6-R0.4-SNAPSHOT or 1.8-R0.1-SNAPSHOT-latest.
-       Click into the version entry to find the **exact** version, because something
-       like "1.8" is not sufficient according to their download naming.
+       exact version or see if download site is unavailable.
+       Click into the version entry to find the **exact** version.
 
 EOF
 
-    if isDebugging && [[ $(grep -c "DOCTYPE html" "$SERVER") != 0 ]]; then
-      cat "$SERVER"
+    if isDebugging && grep -iq "doctype html" "$tempFile"; then
+      cat "$tempFile"
+    fi
+
+    if [ -f "$SERVER" ]; then
+      log "Continuing with existing $SERVER file"
+    else
+      # remove invalid download
+      rm "$tempFile"
+      exit 3
+    fi
+
+  else
+    if [ -f "$tempFile" ]; then
+      mv "$tempFile" "$SERVER"
     fi
 
-    # remove invalid download
-    rm "$SERVER"
-    exit 3
   fi
 
+
   JVM_OPTS="${JVM_OPTS} -DIReallyKnowWhatIAmDoingISwear"
   export JVM_OPTS
 }

scripts/start-deployModrinth

@@ -11,6 +11,7 @@ resultsFile=/data/.install-modrinth.env
 : "${MODRINTH_VERSION:=${MODRINTH_VERSION_ID:-}}"
 : "${MODRINTH_IGNORE_MISSING_FILES:=}"
 : "${MODRINTH_EXCLUDE_FILES:=}"
+: "${MODRINTH_OVERRIDES_EXCLUSIONS:=}"
 
 if [[ ! $MODRINTH_MODPACK ]]; then
   log "ERROR: MODRINTH_MODPACK must be set when using TYPE/MOD_PLATFORM of MODRINTH"
@@ -56,6 +57,7 @@ setArg --loader MODRINTH_LOADER
 setArg --version MODRINTH_VERSION
 setArg --default-version-type MODRINTH_DEFAULT_VERSION_TYPE
 setArg --exclude-files MODRINTH_EXCLUDE_FILES
+setArg --overrides-exclusions MODRINTH_OVERRIDES_EXCLUSIONS
 
 if ! mc-image-helper install-modrinth-modpack "${args[@]}"; then
     log "ERROR failed to install Modrinth modpack"

scripts/start-finalExec

@@ -45,10 +45,17 @@ fi
 canUseRollingLogs=true
 useFallbackJvmFlag=false
 
+if [[ ${FTB_DIR:-} ]]; then
+  SERVER_DIR="$FTB_DIR"
+else
+  SERVER_DIR=/data
+fi
+
+
 patchLog4jConfig() {
   file=${1?}
   url=${2?}
-  if ! get -o "$file" "$url"; then
+  if ! get -o "${SERVER_DIR}/${file}" "$url"; then
     log "ERROR: failed to download corrected log4j config, fallback to JVM flag"
     useFallbackJvmFlag=true
     return 1
@@ -94,14 +101,14 @@ if isTrue "${ENABLE_ROLLING_LOGS:-false}"; then
     exit 1
   fi
   # Set up log configuration
-  LOGFILE="/data/log4j2.xml"
+  LOGFILE="${SERVER_DIR}/log4j2.xml"
   if [ ! -e "$LOGFILE" ]; then
     log "Creating log4j2.xml in ${LOGFILE}"
     cp /image/log4j2.xml "$LOGFILE"
   else
     log "log4j2.xml already created, skipping"
   fi
-  JVM_OPTS="-Dlog4j.configurationFile=/data/log4j2.xml ${JVM_OPTS}"
+  JVM_OPTS="-Dlog4j.configurationFile=log4j2.xml ${JVM_OPTS}"
 fi
 
 # Optional disable console
@@ -287,7 +294,10 @@ elif [[ $SERVER =~ run.sh ]]; then
     echo "SETUP_ONLY: bash ${SERVER}"
     exit
   fi
-  exec mc-server-runner "${mcServerRunnerArgs[@]}" --shell bash "${SERVER}"
+  if isTrue "${DEBUG_EXEC}"; then
+    set -x
+  fi
+  exec mc-server-runner "${mcServerRunnerArgs[@]}" --shell bash "${SERVER}" $EXTRA_ARGS
 else
   # If we have a bootstrap.txt file... feed that in to the server stdin
   if [ -f /data/bootstrap.txt ]; then

scripts/start-setupModpack

@@ -272,6 +272,13 @@ function handleCurseForgeFiles() {
     forge|fabric|quilt)
       args+=(--mod-loader "$TYPE")
       ;;
+    *)
+      if isFamily HYBRID; then
+        # To disambiguate mc-mods we'll assume that hybrid servers
+        # are blending Forge (rather than Fabric or NeoForge)
+        args+=(--mod-loader "forge")
+      fi
+      ;;
   esac
 
   # shellcheck disable=SC2086

scripts/start-utils

@@ -253,17 +253,6 @@ function isType() {
   return 1
 }
 
-function evaluateJavaCompatibilityForForge() {
-  javaRelease=$(mc-image-helper java-release)
-  if versionLessThan 1.18 && (( javaRelease > 8 )); then
-    log "**********************************************************************"
-    log "WARNING: Some mods and modpacks may require Java 8."
-    log "         Please use itzg/minecraft-server:java8"
-    log "**********************************************************************"
-    sleep 5
-  fi
-}
-
 function extract() {
   src=${1?}
   destDir=${2?}