Auto-merging via docker-versions-create

* Adds EULA to the 'quickstart' command in readme

most people will start with the quickstart command, which won't work anymore now that EULA is required.  Modified the sample quickstart to include the new minimum params.

* Update README.md

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

* Update README.md

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

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

.dockerignore

@@ -1,5 +1,6 @@
 data
+testdata
 examples
 k8s-examples
 .idea
-.git
+.git

.github/workflows/build-multiarch.yml

@@ -0,0 +1,25 @@
+name: Build and publish multiarch
+on:
+  push:
+    branches:
+      - multiarch
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+-multiarch"
+
+jobs:
+  docker-buildx:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2.2.0
+      - name: Get branch name
+        uses: nelonoel/branch-name@v1
+      - name:  Docker Buildx
+        uses: ilteoood/docker_buildx@1.0.4
+        with:
+          publish: true
+          imageName: itzg/minecraft-server
+          tag: ${{ env.BRANCH_NAME }}
+          dockerHubUser: ${{ secrets.DOCKER_USER }}
+          dockerHubPassword: ${{ secrets.DOCKER_PASSWORD }}
+

.github/workflows/main.yml

@@ -16,7 +16,18 @@ on:
       - "[0-9]+.[0-9]+.[0-9]+-adopt13"
 
 jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Run tests
+        run: |
+          tests/test.sh
   build:
+    needs:
+      - test
     runs-on: ubuntu-latest
 
     steps:
@@ -32,4 +43,5 @@ jobs:
         tag_with_sha: false
         cache_froms: itzg/minecraft-server:latest
         add_git_labels: true
+        labels: org.opencontainers.image.url=https://github.com/itzg/docker-minecraft-server,org.opencontainers.image.documentation=https://github.com/itzg/docker-minecraft-server
         push: true

.github/workflows/pr.yml

@@ -5,15 +5,12 @@ on:
     branches: [ master ]
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v2
 
-      - name: Build Docker image
+      - name: Run tests
-        uses: docker/build-push-action@v1.1.0
+        run: |
-        with:
+          tests/test.sh
-          tag_with_sha: true
-          cache_froms: itzg/minecraft-server:latest
-          push: false

BUILDING.md

@@ -0,0 +1,11 @@
+Ensure buildx/BuildKit support is enabled and run:
+
+```shell script
+docker buildx build --platform=linux/arm64 --platform=linux/arm/v7 --platform=linux/amd64 --tag itzg/minecraft-server:multiarch --push .
+```
+
+To build for local testing, use:
+
+```shell script
+docker buildx build --platform=linux/amd64 --tag mc-multiarch --load .
+```

Dockerfile

@@ -1,29 +1,27 @@
-FROM openjdk:8u212-jre-alpine
+FROM ubuntu:18.04
 
-LABEL maintainer "itzg"
+LABEL org.opencontainers.image.authors="Geoff Bourne <itzgeoff@gmail.com>"
 
-RUN apk add --no-cache -U \
+RUN apt-get update \
-  openssl \
+  && DEBIAN_FRONTEND=noninteractive \
-  imagemagick \
+  apt-get install -y \
-  lsof \
+    openjdk-8-jre-headless \
-  su-exec \
+    imagemagick \
-  shadow \
+    gosu \
-  bash \
+    curl wget \
-  curl iputils wget \
+    jq \
-  git \
+    dos2unix \
-  jq \
+    mysql-client \
-  mysql-client \
+    tzdata \
-  tzdata \
+    rsync \
-  rsync \
+    nano \
-  nano \
+    unzip \
-  sudo \
+    knockd \
-  knock \
+    ttf-dejavu \
-  ttf-dejavu
+    && apt-get clean
 
-RUN addgroup -g 1000 minecraft \
+RUN addgroup --gid 1000 minecraft \
-  && adduser -Ss /bin/false -u 1000 -G minecraft -h /home/minecraft minecraft \
+  && adduser --system --shell /bin/false --uid 1000 --ingroup minecraft --home /data minecraft
-  && mkdir -m 777 /data \
-  && chown minecraft:minecraft /data /home/minecraft
 
 COPY files/sudoers* /etc/sudoers.d
 
@@ -31,9 +29,9 @@ EXPOSE 25565 25575
 
 # hook into docker BuildKit --platform support
 # see https://docs.docker.com/engine/reference/builder/#automatic-platform-args-in-the-global-scope
-ARG TARGETOS=linux
+ARG TARGETOS
-ARG TARGETARCH=amd64
+ARG TARGETARCH
-ARG TARGETVARIANT=""
+ARG TARGETVARIANT
 
 ARG EASY_ADD_VER=0.7.1
 ADD https://github.com/itzg/easy-add/releases/download/${EASY_ADD_VER}/easy-add_${TARGETOS}_${TARGETARCH}${TARGETVARIANT} /usr/bin/easy-add
@@ -67,7 +65,7 @@ COPY log4j2.xml /tmp/log4j2.xml
 WORKDIR /data
 
 ENV UID=1000 GID=1000 \
-  JVM_XX_OPTS="-XX:+UseG1GC" MEMORY="1G" \
+  MEMORY="1G" \
   TYPE=VANILLA VERSION=LATEST FORGEVERSION=RECOMMENDED SPONGEBRANCH=STABLE SPONGEVERSION= FABRICVERSION=LATEST LEVEL=world \
   PVP=true DIFFICULTY=easy ENABLE_RCON=true RCON_PORT=25575 RCON_PASSWORD=minecraft \
   LEVEL_TYPE=DEFAULT SERVER_PORT=25565 ONLINE_MODE=TRUE SERVER_NAME="Dedicated Server" \

README.md

@@ -11,7 +11,7 @@ latest snapshot. See the _Versions_ section below for more information.
 
 To simply use the latest stable version, run
 
-    docker run -d -p 25565:25565 --name mc itzg/minecraft-server
+    docker run -d -p 25565:25565 --name mc -e EULA=TRUE itzg/minecraft-server
 
 where the standard server port, 25565, will be exposed on your host machine.
 
@@ -35,6 +35,7 @@ With that you can easily view the logs, stop, or re-start the container:
     docker stop mc
 
     docker start mc
+*Be sure to always include `-e EULA=TRUE` in your commands, as Mojang/Microsoft requires EULA acceptance.*
 
 ## Looking for a Bedrock Dedicated Server
 
@@ -269,10 +270,20 @@ the `/path/on/host` folder contents look like:
 ├── ops.json
 ├── server.properties
 ├── whitelist.json
+├── worlds
+│   └── ... PLACE MAPS IN THEIR OWN FOLDERS HERE ...
 └── ...
 ```
 
-If you add mods while the container is running, you'll need to restart it to pick those
+Providing a presistent `/data` mount is a good idea, both to persist the game world and to allow for the manual configuration which is sometimes needed.
+
+For instance, imagine a scenario when the initial launch has completed, but you now want to change the worldmap for your server.  
+
+Assuming you have a shared directory to your container, you can then (after first launch) drag and drop your premade maps or worlds into the `\worlds\` directory.  **Note:** each world should be placed in its own folder under the `\worlds\` directory.  
+
+Once your maps are in the proper path, you can then specify which map the server uses by changing the `level-name` value in `server.properties` to match the name of your map.
+
+If you add mods or make changes to `server.properties` while the container is running, you'll need to restart it to pick those
 up:
 
     docker stop mc
@@ -291,6 +302,8 @@ This works 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.
 
+
+
 ### Replacing variables inside configs
 
 Sometimes you have mods or plugins that require configuration information that is only available at runtime.
@@ -324,7 +337,13 @@ There are some limitations to what characters you can use.
 Variables will be replaced in files with the following extensions:
 `.yml`, `.yaml`, `.txt`, `.cfg`, `.conf`, `.properties`.
 
-Specific files can be excluded by listing their name (without path) in the variable `REPLACE_ENV_VARIABLES_EXCLUDES`. Paths can be excluded by listing them in the variable `REPLACE_ENV_VARIABLES_EXCLUDE_PATHS`.
+Specific files can be excluded by listing their name (without path) in the variable `REPLACE_ENV_VARIABLES_EXCLUDES`.
+
+Paths can be excluded by listing them in the variable `REPLACE_ENV_VARIABLES_EXCLUDE_PATHS`. Path
+excludes are recursive. Here is an example:
+```
+REPLACE_ENV_VARIABLES_EXCLUDE_PATHS="/data/plugins/Essentials/userdata /data/plugins/MyPlugin"
+```
 
 Here is a full example where we want to replace values inside a `database.yml`.
 
@@ -384,7 +403,7 @@ secrets:
 The content of `db_password`:
 
     ug23u3bg39o-ogADSs
-
+    
 ## Running a Bukkit/Spigot server
 
 Enable Bukkit/Spigot server mode by adding a `-e TYPE=BUKKIT` or `-e TYPE=SPIGOT` to your command-line.
@@ -507,6 +526,10 @@ The following example uses `/modpacks` as the container path as the pre-download
         -e CF_SERVER_MOD=/modpacks/SkyFactory_4_Server_4.1.0.zip \
         -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
 
+#### Buggy start scripts
+
+Some modpacks have buggy or overly complex start scripts. You can avoid using the bundled start script and use this image's standard server-starting logic by adding `-e USE_MODPACK_START_SCRIPT=false`.
+
 ### Fixing "unable to launch forgemodloader"
 
 If your server's modpack fails to load with an error [like this](https://support.feed-the-beast.com/t/cant-start-crashlanding-server-unable-to-launch-forgemodloader/6028/2):

files/autopause/autopause-daemon.sh

@@ -4,7 +4,7 @@
 
 . /start-utils
 
-sudo /usr/sbin/knockd -c /autopause/knockd-config.cfg -d
+sudo /usr/sbin/knockd -c /tmp/knockd-config.cfg -d
 if [ $? -ne 0 ] ; then
   while :
   do

start

@@ -36,16 +36,11 @@ if [ $(id -u) = 0 ]; then
     chown -R ${runAsUser}:${runAsGroup} /data
   fi
 
-  if [[ $(stat -c "%u" /autopause) != $UID ]]; then
-    log "Changing ownership of /autopause to $UID ..."
-    chown -R ${runAsUser}:${runAsGroup} /autopause
-  fi
-
   if [[ ${SKIP_NSSWITCH_CONF^^} != TRUE ]]; then
     echo 'hosts: files dns' > /etc/nsswitch.conf
   fi
 
-  exec su-exec ${runAsUser}:${runAsGroup} ${SCRIPTS:-/}start-configuration $@
+  exec gosu ${runAsUser}:${runAsGroup} ${SCRIPTS:-/}start-configuration $@
 else
   exec ${SCRIPTS:-/}start-configuration $@
 fi

start-autopause

@@ -4,18 +4,20 @@
 
 log "Autopause functionality enabled"
 
+cp /autopause/knockd-config.cfg /tmp/knockd-config.cfg
+
 # update server port to listen to
 regseq="^\s*sequence\s*=\s*$SERVER_PORT\s*$"
-linenum=$(grep -nm1 sequence /autopause/knockd-config.cfg | cut -d : -f 1 | tail -n1)
+linenum=$(grep -nm1 sequence /tmp/knockd-config.cfg | cut -d : -f 1 | tail -n1)
-if ! [[ $(awk "NR==$linenum" /autopause/knockd-config.cfg) =~ $regseq ]]; then
+if ! [[ $(awk "NR==$linenum" /tmp/knockd-config.cfg) =~ $regseq ]]; then
-  sed -i "${linenum}s/sequence.*/sequence = $SERVER_PORT/" /autopause/knockd-config.cfg
+  sed -i "${linenum}s/sequence.*/sequence = $SERVER_PORT/" /tmp/knockd-config.cfg
   log "Updated server port in knockd config"
 fi
 # update rcon port to listen to
 regseq="^\s*sequence\s*=\s*$RCON_PORT\s*$"
-linenum=$(grep -nm2 sequence /autopause/knockd-config.cfg | cut -d : -f 1 | tail -n1)
+linenum=$(grep -nm2 sequence /tmp/knockd-config.cfg | cut -d : -f 1 | tail -n1)
-if ! [[ $(awk "NR==$linenum" /autopause/knockd-config.cfg) =~ $regseq ]]; then
+if ! [[ $(awk "NR==$linenum" /tmp/knockd-config.cfg) =~ $regseq ]]; then
-  sed -i "${linenum}s/sequence.*/sequence = $RCON_PORT/" /autopause/knockd-config.cfg
+  sed -i "${linenum}s/sequence.*/sequence = $RCON_PORT/" /tmp/knockd-config.cfg
   log "Updated rcon port in knockd config"
 fi
 

start-configuration

@@ -7,9 +7,10 @@ shopt -s nullglob
 #umask 002
 export HOME=/data
 
+log "Running as uid=$(id -u) gid=$(id -g) with /data as '$(ls -lnd /data)'"
+
 if [ ! -e /data/eula.txt ]; then
-  EULA="${EULA,,}"
+  if ! isTrue "$EULA"; then
-  if [ "$EULA" != "true" ]; then
     log ""
     log "Please accept the Minecraft EULA at"
     log "  https://account.mojang.com/documents/minecraft_eula"
@@ -19,24 +20,10 @@ if [ ! -e /data/eula.txt ]; then
     exit 1
   fi
 
-  echo "# Generated via Docker on $(date)" > /data/eula.txt
+  writeEula
-
-  if ! echo "eula=$EULA" >> /data/eula.txt; then
-    log "ERROR: unable to write eula to /data. Please make sure attached directory is writable by uid=${UID}"
-    exit 2
-  fi
 fi
 
 
-log "Running as uid=$(id -u) gid=$(id -g) with /data as '$(ls -lnd /data)'"
-
-if ! touch /data/.verify_access; then
-  log "ERROR: /data doesn't seem to be writable. Please make sure attached directory is writable by uid=$(id -u)"
-  exit 2
-fi
-
-rm /data/.verify_access || true
-
 if [[ $PROXY ]]; then
     export http_proxy="$PROXY"
     export https_proxy="$PROXY"
@@ -45,6 +32,22 @@ if [[ $PROXY ]]; then
     sleep 5
 fi
 
+if [[ $RCON_PASSWORD_FILE ]]; then
+    log ""
+    if [ ! -e ${RCON_PASSWORD_FILE} ]; then
+	log "Initial RCON password file ${RCON_PASSWORD_FILE} does not seems to exist."
+	log "Please ensure your configuration."
+	log "If you are using Docker Secrets feature, please check this for further information: "
+	log " https://docs.docker.com/engine/swarm/secrets"
+	log ""
+	exit 1
+    else
+	RCON_PASSWORD=$(cat ${RCON_PASSWORD_FILE})
+	export RCON_PASSWORD
+    fi
+    log ""
+fi
+
 export SERVER_PROPERTIES=/data/server.properties
 export VERSIONS_JSON=https://launchermeta.mojang.com/mc/game/version_manifest.json
 
@@ -55,11 +58,8 @@ case "X$VERSION" in
   XSNAPSHOT|Xsnapshot)
     VANILLA_VERSION=$(curl -fsSL $VERSIONS_JSON | jq -r '.latest.snapshot')
   ;;
-  X[1-9]*)
-    VANILLA_VERSION=$VERSION
-  ;;
   *)
-    VANILLA_VERSION=$(curl -fsSL $VERSIONS_JSON | jq -r '.latest.release')
+    VANILLA_VERSION=$VERSION
   ;;
 esac
 export VANILLA_VERSION
@@ -95,8 +95,12 @@ case "${TYPE^^}" in
     exec ${SCRIPTS:-/}start-deployFabric "$@"
   ;;
 
-  FTB|CURSEFORGE)
+  FTBA)
-    exec ${SCRIPTS:-/}start-deployFTB "$@"
+    exec ${SCRIPTS:-/}start-deployFTBA "$@"
+  ;;
+
+  CURSEFORGE|FTB)
+    exec ${SCRIPTS:-/}start-deployCF "$@"
   ;;
 
   VANILLA)
@@ -129,8 +133,9 @@ case "${TYPE^^}" in
 
   *)
       log "Invalid type: '$TYPE'"
-      log "Must be: VANILLA, FORGE, BUKKIT, SPIGOT, PAPER, FTBA, CURSEFORGE, SPONGEVANILLA,"
+      log "Must be: VANILLA, FORGE, BUKKIT, SPIGOT, PAPER, FTBA (multiarch-only),"
-      log "         CUSTOM, CURSE_INSTANCE, MAGMA, MOHIST, CATSERVER"
+      log "         CURSE_INSTANCE, CURSEFORGE, SPONGEVANILLA,"
+      log "         CUSTOM, MAGMA, MOHIST, CATSERVER"
       exit 1
   ;;
 

start-deployBukkitSpigot

@@ -62,8 +62,12 @@ function downloadSpigot {
     downloadUrl="https://cdn.getbukkit.org/${getbukkitFlavor}/${getbukkitFlavor}-${VANILLA_VERSION}.jar"
   fi
 
+  if [ -f $SERVER ]; then
+    # tell curl to only download when newer
+    zarg="-z $SERVER"
+  fi
   log "Downloading $match from $downloadUrl ..."
-  curl -fsSL -o $SERVER "$downloadUrl"
+  curl -fsSL -o $SERVER $zarg "$downloadUrl"
   if [[ $? != 0 || $(grep -c "DOCTYPE html" $SERVER) != 0 ]]; then
     cat <<EOF
 
@@ -89,12 +93,12 @@ case "$TYPE" in
     ;;
 esac
 
-if [ ! -f $SERVER ] || [ -n "$FORCE_REDOWNLOAD" ]; then
+if isTrue "$BUILD_SPIGOT_FROM_SOURCE" || isTrue "$BUILD_FROM_SOURCE"; then
-   if isTrue "$BUILD_SPIGOT_FROM_SOURCE" || isTrue "$BUILD_FROM_SOURCE"; then
+  if [ ! -f $SERVER ] || [ -n "$FORCE_REDOWNLOAD" ]; then
-     buildSpigotFromSource
+    buildSpigotFromSource
-   else
+  fi
-     downloadSpigot
+else
-   fi
+  downloadSpigot
 fi
 
 # Normalize on Spigot for operations below

start-deployCF

@@ -1,26 +1,77 @@
 #!/bin/bash
 
+set -e
+
 . ${SCRIPTS:-/}start-utils
 
 export FTB_BASE_DIR=/data/FeedTheBeast
 legacyJavaFixerUrl=http://ftb.cursecdn.com/FTB2/maven/net/minecraftforge/lex/legacyjavafixer/1.0/legacyjavafixer-1.0.jar
-export TYPE=FEED-THE-BEAST
+export TYPE=CURSEFORGE
 
 FTB_SERVER_MOD=${FTB_SERVER_MOD:-$CF_SERVER_MOD}
 
 log "Looking for Feed-The-Beast / CurseForge server modpack."
-if [[ -z $FTB_SERVER_MOD ]]; then
+requireVar FTB_SERVER_MOD
-    log "Environment variable FTB_SERVER_MOD not set."
+
-    log "Set FTB_SERVER_MOD to the file name of the FTB server modpack."
+if ! isTrue ${USE_MODPACK_START_SCRIPT:-true}; then
-    log "(And place the modpack in the /data directory.)"
+  if ! [ -f ${FTB_SERVER_MOD} ]; then
+    log "ERROR unable to find requested modpack file ${FTB_SERVER_MOD}"
     exit 2
+  fi
+
+  needsInstall=true
+  installMarker=/data/.curseforge-installed
+  if [ -f $installMarker ]; then
+    if [ "$(cat $installMarker)" != "${FTB_SERVER_MOD}" ]; then
+      log "Upgrading modpack"
+
+      serverJar=$(find ${FTB_BASE_DIR} -not -name "forge*installer.jar" -name "forge*.jar")
+      if [[ "${serverJar}" ]]; then
+        rm -rf $(dirname "${serverJar}")/{mods,*.jar,libraries,resources,scripts}
+      fi
+    else
+      needsInstall=false
+    fi
+  fi
+
+  if $needsInstall; then
+    log "Unpacking FTB server modpack ${FTB_SERVER_MOD} ..."
+    mkdir -p ${FTB_BASE_DIR}
+    unzip -o ${FTB_SERVER_MOD} -d ${FTB_BASE_DIR} | awk '{printf "."} END {print ""}'
+
+    forgeInstallerJar=$(find ${FTB_BASE_DIR} -name "forge*installer.jar")
+    if [[ -z "${forgeInstallerJar}" ]]; then
+      log "ERROR Unable to find forge installer in modpack."
+      log "      Make sure you downloaded the server files."
+      exit 2
+    fi
+
+    log "Installing forge server"
+    (cd $(dirname "${forgeInstallerJar}"); java -jar $(basename ${forgeInstallerJar}) --installServer) | awk '{printf "."} END {print ""}'
+
+    echo "${FTB_SERVER_MOD}" > $installMarker
+  fi
+
+  export SERVER=$(find ${FTB_BASE_DIR} -not -name "forge*installer.jar" -name "forge*.jar")
+  if [[ -z "${SERVER}" || ! -f "${SERVER}" ]]; then
+    log "ERROR unable to locate installed forge server jar"
+    isDebugging && find ${FTB_BASE_DIR} -name "forge*.jar"
+    exit 2
+  fi
+
+  export FTB_DIR=$(dirname "${SERVER}")
+
+  exec ${SCRIPTS:-/}start-finalSetupWorld $@
 fi
 
 entryScriptExpr="
   -name ServerStart.sh
+  -o -name serverstart.sh
   -o -name ServerStartLinux.sh
   -o -name LaunchServer.sh
   -o -name server-start.sh
+  -o -name startserver.sh
+  -o -name StartServer.sh
   "
 
 if [[ -d ${FTB_BASE_DIR} ]]; then

start-deployFTBA

@@ -0,0 +1,72 @@
+#!/bin/bash
+
+ftbInstallMarker=".ftb-installed"
+
+. ${SCRIPTS:-/}start-utils
+isDebugging && set -x
+set -e
+
+if ! [[ -v FTB_MODPACK_ID ]]; then
+  log "ERROR FTB_MODPACK_ID is required with TYPE=FTB"
+  exit 1
+fi
+
+if ! [[ ${FTB_MODPACK_ID} =~ [0-9]+ ]]; then
+  log "ERROR FTB_MODPACK_ID needs to be numeric"
+  exit 1
+fi
+
+if ! [[ -v FTB_MODPACK_VERSION_ID ]]; then
+  if ! FTB_MODPACK_VERSION_ID=$(curl -fsSL https://api.modpacks.ch/public/modpack/${FTB_MODPACK_ID} | jq -r '.versions | sort_by(.updated)[-1].id'); then
+    log "ERROR unable to resolve latest modpack version ID for modpack ${FTB_MODPACK_ID}"
+    exit 1
+  fi
+elif ! [[ ${FTB_MODPACK_VERSION_ID} =~ [0-9]+ ]]; then
+  log "ERROR FTB_MODPACK_VERSION_ID needs to be numeric"
+  exit 1
+fi
+
+if ! [ -f "${ftbInstallMarker}" ] || [ $(cat "${ftbInstallMarker}") != "${FTB_MODPACK_ID}=${FTB_MODPACK_VERSION_ID}" ]; then
+  ftbInstaller=/data/ftb-installer
+  if ! [[ -f "${ftbInstaller}" ]]; then
+    log "Downloading FTB installer"
+    curl -fsSL https://api.modpacks.ch/public/modpack/1/1/server/linux -o "${ftbInstaller}"
+    chmod +x "${ftbInstaller}"
+  fi
+
+  rm -rf forge*jar mods config libraries defaultconfigs changelogs
+
+  log "Installing modpack ID ${FTB_MODPACK_ID}, version ID ${FTB_MODPACK_VERSION_ID}"
+  ${ftbInstaller} ${FTB_MODPACK_ID} ${FTB_MODPACK_VERSION_ID} --noscript --auto
+  rm -f forge*installer.jar
+
+  echo "${FTB_MODPACK_ID}=${FTB_MODPACK_VERSION_ID}" > ${ftbInstallMarker}
+
+  writeEula
+else
+  log "FTB modpack ID ${FTB_MODPACK_ID}, version ID ${FTB_MODPACK_VERSION_ID} is ready to go"
+fi
+
+isDebugging && cat version.json
+forgeVersion=$(jq -r '.targets[] | select(.name == "forge") | .version' version.json)
+mcVersion=$(jq -r '.targets[] | select(.name == "minecraft") | .version' version.json)
+
+variants=(
+  forge-${mcVersion}-${forgeVersion}.jar
+  forge-${mcVersion}-${forgeVersion}-universal.jar
+  forge-${mcVersion}-${forgeVersion}-${mcVersion}-universal.jar
+)
+for f in ${variants[@]}; do
+  if [ -f $f ]; then
+    export SERVER=$f
+    break
+  fi
+done
+if ! [ -v SERVER ]; then
+  log "ERROR unable to locate the installed forge server jar"
+  ls *.jar
+  exit 2
+fi
+
+# Continue to Final Setup
+exec ${SCRIPTS:-/}start-finalSetupWorld $@

start-deployPaper

@@ -5,17 +5,18 @@
 : ${PAPERBUILD:=latest}
 export SERVER=paper_server-${VANILLA_VERSION}-${PAPERBUILD}.jar
 
-if [ ! -f "$SERVER" ] || [ -n "$FORCE_REDOWNLOAD" ]; then
+if [ -f "$SERVER" ] && ! isTrue "$FORCE_REDOWNLOAD"; then
-    downloadUrl=${PAPER_DOWNLOAD_URL:-https://papermc.io/api/v1/paper/${VANILLA_VERSION}/${PAPERBUILD}/download}
+  zarg="-z '$SERVER'"
-    log "Downloading Paper $VANILLA_VERSION (build $PAPERBUILD) from $downloadUrl ..."
-    curl -fsSL -o "$SERVER" "$downloadUrl"
-    if [ ! -f "$SERVER" ]; then
-      log "ERROR: failed to download from $downloadUrl (status=$?)"
-      exit 3
-    fi
 fi
 
-# Normalize on Spigot for operations below
+downloadUrl=${PAPER_DOWNLOAD_URL:-https://papermc.io/api/v1/paper/${VANILLA_VERSION}/${PAPERBUILD}/download}
+log "Downloading Paper $VANILLA_VERSION (build $PAPERBUILD) from $downloadUrl ..."
+if ! curl -fsSL -o "$SERVER" $zarg "$downloadUrl"; then
+  log "ERROR: failed to download from $downloadUrl (status=$?)"
+  exit 3
+fi
+
+# Normalize on Spigot for downstream operations
 export TYPE=SPIGOT
 export SKIP_LOG4J_CONFIG=true
 

start-deployVanilla

@@ -26,6 +26,9 @@ if [ ! -e $SERVER ] || [ -n "$FORCE_REDOWNLOAD" ]; then
   if [ $result != 0 ]; then
     log "ERROR failed to obtain version manifest from $versionManifestUrl ($result)"
     exit 1
+  elif [ $serverDownloadUrl = null ]; then
+    log "ERROR version $VANILLA_VERSION does not provide a server download"
+    exit 1
   fi
 
   debug "Downloading server from $serverDownloadUrl"

start-finalSetupEnvVariables

@@ -7,14 +7,20 @@
 if isTrue "${REPLACE_ENV_VARIABLES}"; then
   log "Replacing env variables in configs that match the prefix $ENV_VARIABLE_PREFIX..."
 
-  findExcludes=
+  # File excludes
+  fileExcludes=
   for f in ${REPLACE_ENV_VARIABLES_EXCLUDES}; do
-    findExcludes="${findExcludes} -not -name $f"
+    fileExcludes="${fileExcludes} -not -name $f"
   done
-  for p in ${REPLACE_ENV_VARIABLES_EXCLUDE_PATHS}; do
+
-    findExcludes="${findExcludes} -not -path \"*$p*\""
+  # Directory excludes (recursive)
-  done
+  dirExcludes=$(join_by " -o -path " ${REPLACE_ENV_VARIABLES_EXCLUDE_PATHS})
-  isDebugging && echo "Using find exclusion: $findExcludes"
+  if [[ $dirExcludes ]]; then
+    dirExcludes=" -type d ( -path ${dirExcludes} ) -prune -o"
+  fi
+
+  isDebugging && echo "Using find file exclusions: $fileExcludes"
+  isDebugging && echo "Using find directory exclusions: $dirExcludes"
 
   while IFS='=' read -r name value ; do
     # check if name of env variable matches the prefix
@@ -29,10 +35,12 @@ if isTrue "${REPLACE_ENV_VARIABLES}"; then
       fi
 
       log "Replacing $name with $value ..."
-      find /data/ -type f \
+      find /data/ \
+          $dirExcludes \
+          -type f \
           \( -name "*.yml" -or -name "*.yaml" -or -name "*.txt" -or -name "*.cfg" \
           -or -name "*.conf" -or -name "*.properties" \) \
-          $findExcludes \
+          $fileExcludes \
           -exec sed -i 's#${'"$name"'}#'"$value"'#g' {} \;
     fi
   done < <(env)

start-finalSetupModpack

@@ -18,42 +18,60 @@ fi
 
 # If supplied with a URL for a modpack (simple zip of jars), download it and unpack
 if [[ "$MODPACK" ]]; then
-EFFECTIVE_MODPACK_URL=$(curl -Ls -o /dev/null -w %{url_effective} $MODPACK)
+  if isURL "${MODPACK}"; then
-case "X$EFFECTIVE_MODPACK_URL" in
+    if [[ "${MODPACK}" == *.zip ]]; then
-  X[Hh][Tt][Tt][Pp]*.zip)
+      downloadUrl="${MODPACK}"
+    else
+      downloadUrl=$(curl -Ls -o /dev/null -w %{url_effective} $MODPACK)
+      if ! [[ $downloadUrl == *.zip ]]; then
+        log "ERROR Invalid URL given for MODPACK: $downloadUrl resolved from $MODPACK"
+        log "      Must be HTTP or HTTPS and a ZIP file"
+        exit 1
+      fi
+    fi
+
     log "Downloading mod/plugin pack via HTTP"
-    log "  from $EFFECTIVE_MODPACK_URL ..."
+    log "  from $downloadUrl ..."
-    if ! curl -sSL -o /tmp/modpack.zip "$EFFECTIVE_MODPACK_URL"; then
+    if ! curl -sSL -o /tmp/modpack.zip "$downloadUrl"; then
-      log "ERROR: failed to download from $EFFECTIVE_MODPACK_URL"
+      log "ERROR: failed to download from $downloadUrl"
       exit 2
     fi
 
     if [ "$TYPE" = "SPIGOT" ]; then
       mkdir -p /data/plugins
       if ! unzip -o -d /data/plugins /tmp/modpack.zip; then
-        log "ERROR: failed to unzip the modpack from $EFFECTIVE_MODPACK_URL"
+        log "ERROR: failed to unzip the modpack from $downloadUrl"
       fi
     else
       mkdir -p /data/mods
       if ! unzip -o -d /data/mods /tmp/modpack.zip; then
-        log "ERROR: failed to unzip the modpack from $EFFECTIVE_MODPACK_URL"
+        log "ERROR: failed to unzip the modpack from $downloadUrl"
       fi
     fi
     rm -f /tmp/modpack.zip
-    ;;
+
-  *)
+  else
-    log "Invalid URL given for modpack: Must be HTTP or HTTPS and a ZIP file"
+    log "ERROR Invalid URL given for MODPACK: $MODPACK"
-    ;;
+    exit 1
-esac
+  fi
 fi
 
 # If supplied with a URL for a plugin download it.
 if [[ "$MODS" ]]; then
-for i in ${MODS//,/ }
+  for i in ${MODS//,/ }
-do
+  do
-  EFFECTIVE_MOD_URL=$(curl -Ls -o /dev/null -w %{url_effective} $i)
+    if isURL $i; then
-  case "X$EFFECTIVE_MOD_URL" in
+      if [[ $i == *.jar ]]; then
-    X[Hh][Tt][Tt][Pp]*.jar)
+        EFFECTIVE_MOD_URL=$i
+      else
+        EFFECTIVE_MOD_URL=$(curl -Ls -o /dev/null -w %{url_effective} $i)
+        if ! [[ $EFFECTIVE_MOD_URL == *.jar ]]; then
+          log "ERROR Invalid URL given in MODS: $EFFECTIVE_MOD_URL resolved from $i"
+          log "      Must be HTTP or HTTPS and a JAR file"
+          exit 1
+        fi
+      fi
+
       log "Downloading mod/plugin via HTTP"
       log "  from $EFFECTIVE_MOD_URL ..."
       if ! curl -sSL -o /tmp/${EFFECTIVE_MOD_URL##*/} $EFFECTIVE_MOD_URL; then
@@ -69,12 +87,12 @@ do
         mv /tmp/${EFFECTIVE_MOD_URL##*/} /data/mods/${EFFECTIVE_MOD_URL##*/}
       fi
       rm -f /tmp/${EFFECTIVE_MOD_URL##*/}
-      ;;
+
-    *)
+    else
-      log "Invalid URL given for modpack: Must be HTTP or HTTPS and a JAR file"
+      log "ERROR Invalid URL given in MODS: $i"
-      ;;
+      exit 1
-  esac
+    fi
-done
+  done
 fi
 
 if [[ "$MANIFEST" ]]; then

start-finalSetupWorld

@@ -10,7 +10,7 @@ else
   worldDest=/data/$LEVEL
 fi
 
-if [[ "$WORLD" ]] &&  isTrue "${FORCE_WORLD_COPY}" || [ ! -d "$worldDest" ]; then
+if [[ "$WORLD" ]] && ( isTrue "${FORCE_WORLD_COPY}" || [ ! -d "$worldDest" ] ); then
   if isURL $WORLD; then
     curl -fsSL "$WORLD" -o /tmp/world.zip
     zipSrc=/tmp/world.zip

start-minecraftFinalSetup

@@ -158,49 +158,60 @@ if isTrue "${DEBUG_MEMORY}"; then
   free -m
 fi
 
+JVM_OPTS="-Xms${INIT_MEMORY} -Xmx${MAX_MEMORY} ${JVM_OPTS}"
+
+function copyFilesForCurseForge() {
+  # copy player modification files unconditionally since their
+  # processing into json is additive anyway
+  [ -f /data/ops.txt ] && cp -f /data/ops.txt ${FTB_DIR}/
+  [ -f /data/white-list.txt ] && cp -f /data/white-list.txt ${FTB_DIR}/
+
+  if [ ! -e "${FTB_DIR}/server-icon.png" -a -e /data/server-icon.png ]; then
+    cp -f /data/server-icon.png ${FTB_DIR}/
+  fi
+
+  cp -f /data/eula.txt "${FTB_DIR}/"
+}
+
 mcServerRunnerArgs="--stop-duration 60s"
 if [[ ${TYPE} == "CURSE_INSTANCE" ]]; then
-    JVM_OPTS="-Xms${INIT_MEMORY} -Xmx${MAX_MEMORY} ${JVM_OPTS}"
     if isTrue ${DEBUG_EXEC}; then
       set -x
     fi
     exec mc-server-runner ${mcServerRunnerArgs} \
       --cf-instance-file "${CURSE_INSTANCE_JSON}" \
       java $JVM_XX_OPTS $JVM_OPTS $expandedDOpts -jar _SERVERJAR_ "$@" $EXTRA_ARGS
-elif [[ ${TYPE} == "FEED-THE-BEAST" ]]; then
+elif [[ ${TYPE} == "CURSEFORGE" && "${SERVER}" ]]; then
-    mcServerRunnerArgs="${mcServerRunnerArgs} --shell bash"
+  copyFilesForCurseForge
 
-    if [ ! -e "${FTB_DIR}/ops.json" -a -e /data/ops.txt ]; then
+  cd "${FTB_DIR}"
-      cp -f /data/ops.txt ${FTB_DIR}/
+  log "Starting CurseForge server in ${FTB_DIR}..."
-    fi
+  if isTrue ${DEBUG_EXEC}; then
+    set -x
+  fi
+  exec mc-server-runner ${bootstrapArgs} ${mcServerRunnerArgs} java $JVM_XX_OPTS $JVM_OPTS $expandedDOpts -jar $(basename "${SERVER}") "$@" $EXTRA_ARGS
+elif [[ ${TYPE} == "CURSEFORGE" ]]; then
+  mcServerRunnerArgs="${mcServerRunnerArgs} --shell bash"
 
-    if [ ! -e "${FTB_DIR}/whitelist.json" -a -e /data/white-list.txt ]; then
+  copyFilesForCurseForge
-      cp -f /data/white-list.txt ${FTB_DIR}/
-    fi
 
-    if [ ! -e "${FTB_DIR}/server-icon.png" -a -e /data/server-icon.png ]; then
+  cat > "${FTB_DIR}/settings-local.sh" <<EOF
-      cp -f /data/server-icon.png ${FTB_DIR}/
-    fi
-
-    cp -f /data/eula.txt "${FTB_DIR}/"
-
-    cat > "${FTB_DIR}/settings-local.sh" <<EOF
 export MIN_RAM="${INIT_MEMORY}"
 export MAX_RAM="${MAX_MEMORY}"
 export JAVA_PARAMETERS="${JVM_XX_OPTS} -Xms${INIT_MEMORY} ${JVM_OPTS} $expandedDOpts"
 EOF
 
-    # patch CurseForge cfg file, if present
+  # patch CurseForge cfg file, if present
-    if [ -f "${FTB_DIR}/settings.cfg" ]; then
+  if [ -f "${FTB_DIR}/settings.cfg" ]; then
-      sed -i "s/MAX_RAM=[^;]*/MAX_RAM=${MAX_MEMORY}/" "${FTB_DIR}/settings.cfg"
+    sed -i "s/MAX_RAM=[^;]*/MAX_RAM=${MAX_MEMORY}/" "${FTB_DIR}/settings.cfg"
-    fi
+  fi
 
-    cd "${FTB_DIR}"
+  cd "${FTB_DIR}"
-    log "Running FTB ${FTB_SERVER_START} in ${FTB_DIR} ..."
+  log "Running FTB ${FTB_SERVER_START} in ${FTB_DIR} ..."
-    if isTrue ${DEBUG_EXEC}; then
+  if isTrue ${DEBUG_EXEC}; then
-      set -x
+    set -x
-    fi
+  fi
-    exec mc-server-runner ${mcServerRunnerArgs} "${FTB_SERVER_START}"
+  exec mc-server-runner ${mcServerRunnerArgs} "${FTB_SERVER_START}"
 else
   # If we have a bootstrap.txt file... feed that in to the server stdin
   if [ -f /data/bootstrap.txt ]; then
@@ -208,7 +219,6 @@ else
   fi
 
   log "Starting the Minecraft server..."
-  JVM_OPTS="-Xms${INIT_MEMORY} -Xmx${MAX_MEMORY} ${JVM_OPTS}"
   if isTrue ${DEBUG_EXEC}; then
     set -x
   fi

start-utils

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+function join_by { local d=$1; shift; echo -n "$1"; shift; printf "%s" "${@/#/$d}"; }
+
 function isURL {
   local value=$1
 
@@ -106,4 +108,17 @@ requireVar() {
     log "ERROR: $1 is required to be set"
     exit 1
   fi
+  if [ -z "${!1}" ]; then
+    log "ERROR: $1 is required to be set"
+    exit 1
+  fi
+}
+
+function writeEula() {
+if ! echo "# Generated via Docker on $(date)
+eula=${EULA,,}
+" > /data/eula.txt; then
+  log "ERROR: unable to write eula to /data. Please make sure attached directory is writable by uid=${UID}"
+  exit 2
+fi
 }

tests/docker-compose.test.yml

@@ -0,0 +1,17 @@
+version: "3.8"
+
+services:
+  sut:
+    depends_on:
+      - mc
+    image: itzg/mc-monitor:0.6.0
+    command: status --host mc --retry-interval 1s --retry-limit 120
+  mc:
+    restart: "no"
+    build:
+      context: ..
+      cache_from:
+      - itzg/minecraft-server:latest
+    environment:
+      EULA: "TRUE"
+

tests/test.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+cd $(dirname $0)
+
+failed=false
+args="-f docker-compose.test.yml"
+docker-compose $args run sut || failed=true
+echo "
+Result: failed=$failed"
+
+$failed && docker-compose $args logs mc
+docker-compose $args down -v
+
+if $failed; then
+  exit 1
+fi
+