Merge branch 'master' into java8-multiarch

# Conflicts:
#	start-minecraftFinalSetup

.github/workflows/build-multiarch.yml

@@ -68,6 +68,8 @@ jobs:
           platforms: linux/amd64,linux/arm/v7,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.prep.outputs.tags }}
+          # ensure latest base image is used
+          pull: true
           cache-from: type=local,src=/tmp/.buildx-cache
           cache-to: type=local,dest=/tmp/.buildx-cache
           labels: |

Dockerfile

@@ -1,10 +1,11 @@
-FROM adoptopenjdk:15-jre
+FROM ubuntu:18.04
 
 LABEL org.opencontainers.image.authors="Geoff Bourne <itzgeoff@gmail.com>"
 
 RUN apt-get update \
   && DEBIAN_FRONTEND=noninteractive \
   apt-get install -y \
+    openjdk-8-jre-headless \
     imagemagick \
     gosu \
     sudo \

README.md

@@ -132,7 +132,7 @@ services:
       EULA: "TRUE"
     volumes:
       # attach the relative directory 'data' to the container's /data path
-      ./data:/data
+      - ./data:/data
 ```
 
 ## Versions
@@ -499,6 +499,18 @@ Extra variables:
 - `PURPUR_BUILD=LATEST` : set a specific Purpur build to use
 - `FORCE_REDOWNLOAD=false` : set to true to force the located server jar to be re-downloaded
 
+## Running a Yatopia server
+
+A [Yatopia](https://github.com/YatopiaMC/Yatopia) server, which is a "blazing fast Tuinity fork with best in class performance".
+
+    -e TYPE=YATOPIA
+
+> NOTE: the `VERSION` variable is used to locate the Yatopia version to download
+
+Extra variables:
+- `RELEASE=stable` : set to `stable` or `latest`
+- `FORCE_REDOWNLOAD=false` : set to true to force the located server jar to be re-downloaded
+
 ## Running a Magma server
 
 A [Magma](https://magmafoundation.org/) server, which is a combination of Forge and PaperMC, can be used with
@@ -516,6 +528,9 @@ A [Mohist](https://github.com/Mohist-Community/Mohist) server can be used with
 
 > **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
 
 ## Running a Catserver type server
 
@@ -717,16 +732,14 @@ every time you want to create new Minecraft server, you can now use
 
 ```
 minecraft-server:
+  image: itzg/minecraft-server
+
   ports:
     - "25565:25565"
 
   environment:
     EULA: "TRUE"
 
-  image: itzg/minecraft-server
-
-  container_name: mc
-
   tty: true
   stdin_open: true
   restart: always
@@ -934,7 +947,11 @@ It determines the server-side viewing distance.
 
 If you want to create the Minecraft level with a specific seed, use `SEED`, such as
 
-    docker run -d -e SEED=1785852800490497919 ...
+    -e SEED=1785852800490497919
+
+If using a negative value for the seed, make sure to quote the value such as:
+
+    -e SEED="-1785852800490497919"
 
 ### Game Mode
 
@@ -956,16 +973,13 @@ For example:
 
 The message of the day, shown below each server entry in the UI, can be changed with the `MOTD` environment variable, such as
 
-    docker run -d -e 'MOTD=My Server' ...
+    -e MOTD="My Server"
 
 If you leave it off, a default is computed from the server type and version, such as
 
     A Paper Minecraft Server powered by Docker
 
-when `TYPE` is `PAPER`. That way you can easily differentiate between several servers you may have started.
-
-_The example shows how to specify a server message of the day that contains spaces by putting quotes
-around the whole thing._
+That way you can easily differentiate between several servers you may have started.
 
 ### PVP Mode
 
@@ -1140,9 +1154,11 @@ For some cases, if e.g. after removing mods, it could be necessary to startup mi
 
 ### Enable Remote JMX for Profiling
 
-To enable remote JMX, such as for profiling with VisualVM or JMC, add the environment variable `ENABLE_JMX=true` and add a port forwarding of TCP port 7091, such as:
+To enable remote JMX, such as for profiling with VisualVM or JMC, add the environment variable `ENABLE_JMX=true`, set `JMX_HOST` to the IP/host running the Docker container, and add a port forwarding of TCP port 7091, such as:
 
-    -e ENABLE_JMX=true -p 7091:7091
+```
+-e ENABLE_JMX=true -e JMX_HOST=$HOSTNAME -p 7091:7091
+```
 
 ### Enable Aikar's Flags
 

examples/docker-compose-curseforge.yml

@@ -2,7 +2,7 @@ version: '3.2'
 
 services:
   mc:
-    image: itzg/minecraft-server
+    image: itzg/minecraft-server:java8
     volumes:
     - ./modpacks:/modpacks:ro
     environment:

examples/docker-compose-curseinstance.yml

@@ -1,20 +0,0 @@
-version: "3.7"
-
-services:
-  mc:
-    image: itzg/minecraft-server
-    ports:
-      - 25565:25565
-    volumes:
-      # Attach .../Curse/Minecraft/Instances for use at /instances
-      - ./Instances:/instances:ro
-      # Attach /data as usual
-      - ./ServerData:/data
-    environment:
-      EULA: "TRUE"
-      # Modpacks generally need more memory, so let's give at 2 GB
-      MEMORY: 2G
-      # Use new CURSE_INSTANCE type
-      TYPE: CURSE_INSTANCE
-      # Reference directory of or full path to minecraftinstance.json
-      CURSE_INSTANCE_JSON: /instances/FTB Presents SkyFactory 3

examples/docker-compose-forge.yml

@@ -2,7 +2,7 @@ version: "3.7"
 
 services:
   mc:
-    image: itzg/minecraft-server
+    image: itzg/minecraft-server:java8
     ports:
     # expose the Minecraft server port outside of container
     - 25565:25565

examples/docker-compose-ftba.yml

@@ -2,8 +2,8 @@ version: "3.7"
 
 services:
   mc:
-    # FTBA support is only available in multiarch image tag
-    image: itzg/minecraft-server:multiarch
+    # FTBA support is only available in non-Alpine images
+    image: itzg/minecraft-server:java8-multiarch
     ports:
       # expose the Minecraft server port outside of container
       - 25565:25565

examples/docker-compose-spongeforge.yml

@@ -5,7 +5,7 @@ version: '3'
 
 services:
   minecraft:
-    image: itzg/minecraft-server
+    image: itzg/minecraft-server:java8
     ports:
       - "25565:25565"
     volumes:

start-configuration

@@ -4,6 +4,7 @@ IFS=$'\n\t'
 
 . ${SCRIPTS:-/}start-utils
 
+: ${EULA:=}
 : ${PROXY:=}
 : ${RCON_PASSWORD_FILE:=}
 
@@ -53,7 +54,6 @@ if [[ $RCON_PASSWORD_FILE ]]; then
     log ""
 fi
 
-export SERVER_PROPERTIES=/data/server.properties
 export VERSIONS_JSON=https://launchermeta.mojang.com/mc/game/version_manifest.json
 
 case "X$VERSION" in
@@ -93,10 +93,6 @@ case "${TYPE^^}" in
   ;;
 
   FORGE)
-    log "**********************************************************************"
-    log "WARNING: The image tag itzg/minecraft-server:java8 is recommended"
-    log "         since some mods require Java 8"
-    log "**********************************************************************"
     exec ${SCRIPTS:-/}start-deployForge "$@"
   ;;
 
@@ -144,11 +140,15 @@ case "${TYPE^^}" in
     exec ${SCRIPTS:-/}start-deployPurpur "$@"
   ;;
 
+  YATOPIA)
+    exec ${SCRIPTS:-/}start-deployYatopia "$@"
+  ;;
+
   *)
       log "Invalid type: '$TYPE'"
       log "Must be: VANILLA, FORGE, BUKKIT, SPIGOT, PAPER, FTBA (multiarch-only),"
       log "         CURSE_INSTANCE, CURSEFORGE, SPONGEVANILLA, TUINITY, PURPUR"
-      log "         CUSTOM, MAGMA, MOHIST, CATSERVER"
+      log "         CUSTOM, MAGMA, MOHIST, CATSERVER, YATOPIA"
       exit 1
   ;;
 

start-deployFTBA

@@ -43,6 +43,9 @@ if ! [ -f "${ftbInstallMarker}" ] || [ $(cat "${ftbInstallMarker}") != "${FTB_MO
   echo "${FTB_MODPACK_ID}=${FTB_MODPACK_VERSION_ID}" > ${ftbInstallMarker}
 
   writeEula
+
+  # some modpacks result in --w----r-- permissions
+  chmod a+r version.json
 else
   log "FTB modpack ID ${FTB_MODPACK_ID}, version ID ${FTB_MODPACK_VERSION_ID} is ready to go"
 fi

start-deployMohist

@@ -6,6 +6,7 @@ set -e
 isDebugging && set -x
 
 requireVar VANILLA_VERSION
+: ${MOHIST_BUILD:=lastSuccessfulBuild}
 
 mohistJobs=https://ci.codemc.io/job/Mohist-Community/job/
 mohistJob=${mohistJobs}Mohist-${VANILLA_VERSION}/
@@ -17,12 +18,12 @@ if ! curl -X HEAD -o /dev/null -fsSL "${mohistJob}"; then
   exit 1
 fi
 
-latestBuildRelPath=$(
-  curl -fsSL "${mohistJob}lastSuccessfulBuild/api/json" |
+buildRelPath=$(
+  curl -fsSL "${mohistJob}${MOHIST_BUILD}/api/json" |
     jq -r '.artifacts[0].relativePath'
 )
 
-baseName=$(basename "${latestBuildRelPath}")
+baseName=$(basename "${buildRelPath}")
 if [[ ${baseName} != *-server.jar* ]]; then
   log "ERROR: mohist build for ${VANILLA_VERSION} is not a valid server jar, found ${baseName}"
   log "       check https://ci.codemc.io/job/Mohist-Community/ for available versions"
@@ -34,7 +35,7 @@ export SERVER="/data/${baseName}"
 
 if [ ! -f ${SERVER} ]; then
   log "Downloading ${baseName}"
-  curl -o "${SERVER}" -fsSL "${mohistJob}lastSuccessfulBuild/artifact/${latestBuildRelPath}"
+  curl -o "${SERVER}" -fsSL "${mohistJob}${MOHIST_BUILD}/artifact/${buildRelPath}"
 fi
 
 export SKIP_LOG4J_CONFIG=true

start-deployPaper

@@ -57,8 +57,9 @@ else
   fi
 
   log "Removing old PaperMC versions ..."
-  paperJarSearchString=${SERVER/$build/[0-9]*}
-  find . -maxdepth 1 -name "$paperJarSearchString" ! -name "$SERVER" -delete -print
+  for f in paper-*.jar; do
+    [[ $f != $SERVER ]] && rm $f
+  done
 
   log "Downloading PaperMC $VANILLA_VERSION (build $build) ..."
   curl -fsSL -o "$SERVER" "${zarg[@]}" \

start-deployYatopia

@@ -0,0 +1,30 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+. ${SCRIPTS:-/}start-utils
+isDebugging && set -x
+
+: ${VANILLA_VERSION:?}
+: ${RELEASE:=stable}
+: ${FORCE_REDOWNLOAD:=false}
+
+requireEnum RELEASE stable latest
+
+export SERVER="yatopia-${RELEASE}-${VANILLA_VERSION}.jar"
+
+if [ ! -f "$SERVER" ] || isTrue "$FORCE_REDOWNLOAD"; then
+    downloadUrl="https://api.yatopiamc.org/v2/${RELEASE}Build/download?branch=ver/${VANILLA_VERSION}"
+    log "Downloading Yatopia from $downloadUrl ..."
+    if ! curl -fsSL -o "$SERVER" "$downloadUrl"; then
+      log "ERROR: failed to download from $downloadUrl (status=$?)"
+      exit 3
+    fi
+fi
+
+# Normalize on Spigot for later operations
+export TYPE=SPIGOT
+export SKIP_LOG4J_CONFIG=true
+
+# Continue to Final Setup
+exec ${SCRIPTS:-/}start-finalSetupWorld $@

start-finalSetupEnvVariables

@@ -5,7 +5,7 @@
 : ${ENV_VARIABLE_PREFIX:=CFG_}
 
 if isTrue "${REPLACE_ENV_VARIABLES}"; then
-  log "Replacing env variables in configs that match the prefix $ENV_VARIABLE_PREFIX..."
+  log "Replacing env variables in configs that match the prefix $ENV_VARIABLE_PREFIX ..."
 
   # File excludes
   fileExcludes=
@@ -22,28 +22,30 @@ if isTrue "${REPLACE_ENV_VARIABLES}"; then
   isDebugging && echo "Using find file exclusions: $fileExcludes"
   isDebugging && echo "Using find directory exclusions: $dirExcludes"
 
-  while IFS='=' read -r name value ; do
+  for name in $(compgen -v $ENV_VARIABLE_PREFIX); do
     # check if name of env variable matches the prefix
     # sanity check environment variables to avoid code injections
-    if [[ "$name" = $ENV_VARIABLE_PREFIX* ]] \
-        && [[ $value =~ ^[0-9a-zA-Z_:/=?.+\-]*$ ]] \
-        && [[ $name =~ ^[0-9a-zA-Z_\-]*$ ]]; then
-      # Read content from file environment
-      if [[ $name = *"_FILE" ]] && [[ -f $value ]]; then
-        name="${name/_FILE/}"
-        value=$(<$value)
-      fi
-
-      log "Replacing $name with $value ..."
-      find /data/ \
-          $dirExcludes \
-          -type f \
-          \( -name "*.yml" -or -name "*.yaml" -or -name "*.txt" -or -name "*.cfg" \
-          -or -name "*.conf" -or -name "*.properties" \) \
-          $fileExcludes \
-          -exec sed -i 's#${'"$name"'}#'"$value"'#g' {} \;
+    # Read content from file environment
+    if [[ $name = *"_FILE" ]]; then
+      value=$(<${!name})
+      name="${name%_FILE}"
+    else
+      value=${!name}
     fi
-  done < <(env)
+
+    log "Replacing $name with $value ..."
+
+    value=${value//\\/\\\\}
+    value=${value//#/\\#}
+
+    find /data/ \
+        $dirExcludes \
+        -type f \
+        \( -name "*.yml" -or -name "*.yaml" -or -name "*.txt" -or -name "*.cfg" \
+        -or -name "*.conf" -or -name "*.properties" \) \
+        $fileExcludes \
+        -exec sed -i 's#${'"$name"'}#'"$value"'#g' {} \;
+  done
 fi
 
 exec ${SCRIPTS:-/}start-minecraftFinalSetup $@

start-finalSetupServerProperties

@@ -2,6 +2,8 @@
 
 . ${SCRIPTS:-/}start-utils
 
+: ${SERVER_PROPERTIES:=/data/server.properties}
+
 # FUNCTIONS
 function setServerProp {
   local prop=$1
@@ -12,10 +14,15 @@ function setServerProp {
       TRUE|FALSE)
         var=${var,,} ;;
     esac
-    log "Setting ${prop} to '${var}' in ${SERVER_PROPERTIES}"
-    sed -i "/^${prop}\s*=/ c ${prop}=${var//\\/\\\\}" "$SERVER_PROPERTIES"
+    if grep "${prop}" "$SERVER_PROPERTIES" > /dev/null; then
+      log "Setting ${prop} to '${var}' in ${SERVER_PROPERTIES}"
+      sed -i "/^${prop}\s*=/ c ${prop}=${var//\\/\\\\}" "$SERVER_PROPERTIES"
+    else
+      log "Adding ${prop} with '${var}' in ${SERVER_PROPERTIES}"
+      echo "${prop}=${var//\\/\\\\}" >> "$SERVER_PROPERTIES"
+    fi
   else
-    log "Skip setting ${prop}"
+    isDebugging && log "Skip setting ${prop}"
   fi
 }
 

start-minecraftFinalSetup

@@ -84,7 +84,6 @@ if [ -n "$JVM_DD_OPTS" ]; then
 fi
 
 if isTrue ${ENABLE_JMX}; then
-  : ${JMX_HOST:=0.0.0.0}
   : ${JMX_PORT:=7091}
   JVM_OPTS="${JVM_OPTS}
   -Dcom.sun.management.jmxremote.local.only=false
@@ -92,8 +91,8 @@ if isTrue ${ENABLE_JMX}; then
   -Dcom.sun.management.jmxremote.rmi.port=${JMX_PORT}
   -Dcom.sun.management.jmxremote.authenticate=false
   -Dcom.sun.management.jmxremote.ssl=false
-  -Dcom.sun.management.jmxremote.host=${JMX_HOST}
-  -Djava.rmi.server.hostname=${JMX_HOST}"
+  -Dcom.sun.management.jmxremote.host=${JMX_BINDING:-0.0.0.0}
+  -Djava.rmi.server.hostname=${JMX_HOST:-localhost}"
 
   log "JMX is enabled. Make sure you have port forwarding for ${JMX_PORT}"
 fi
@@ -168,6 +167,11 @@ function copyFilesForCurseForge() {
   cp -f /data/eula.txt "${FTB_DIR}/"
 }
 
+if ! which java > /dev/null; then
+  log "Fixing PATH to include java"
+  PATH="${PATH}:/usr/bin"
+fi
+
 mcServerRunnerArgs="--stop-duration ${STOP_DURATION:-60}s"
 if [[ ${TYPE} == "CURSE_INSTANCE" ]]; then
     if isTrue ${DEBUG_EXEC}; then

start-utils

@@ -144,6 +144,20 @@ requireVar() {
   fi
 }
 
+requireEnum() {
+  var=${1?}
+  shift
+
+  for allowed in $*; do
+    if [[ ${!var} = $allowed ]]; then
+      return 0
+    fi
+  done
+
+  log "ERROR: $var must be set to one of $@"
+#  exit 1
+}
+
 function writeEula() {
   if ! echo "# Generated via Docker
 # $(date)