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>

.circleci/config.yml

@@ -0,0 +1,25 @@
+version: 2
+jobs:
+  minecraft_server:
+    docker:
+      - image: circleci/buildpack-deps:stable
+    steps:
+      - checkout
+      - setup_remote_docker
+      - run:
+          name: Build image
+          command: docker build -t itzg/minecraft-server:${CIRCLE_BRANCH} .
+#      - run:
+#          name: Build arm v7 image
+#          command: docker build -t itzg/minecraft-server:${CIRCLE_BRANCH}-arm-v7 --platform linux/arm/v7 --build-arg ARCH=armv7 .
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - minecraft_server:
+          filters:
+            branches:
+              ignore:
+                - armv7
+                - multiarch

.dockerignore

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

BUILDING.md

@@ -1,5 +0,0 @@
-Ensure buildx/BuildKit support is enabled and run:
-
-```
-docker buildx build --platform=linux/arm64 --platform=linux/arm/v7 --platform=linux/amd64 --tag itzg/minecraft-server:multiarch --push .
-```

Dockerfile

@@ -1,27 +1,32 @@
-FROM ubuntu:18.04
+FROM adoptopenjdk/openjdk8-openj9:alpine
 
 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 \
-    curl wget \
-    jq \
-    dos2unix \
-    mysql-client \
-    tzdata \
-    rsync \
-    nano \
-    unzip \
-    knockd \
-    ttf-dejavu \
-    && apt-get clean
+# upgrade all packages since alpine jre8 base image tops out at 8u212
+RUN apk -U --no-cache upgrade
 
-RUN addgroup --gid 1000 minecraft \
-  && adduser --system --shell /bin/false --uid 1000 --ingroup minecraft --home /data minecraft
+RUN apk add --no-cache -U \
+  openssl \
+  imagemagick \
+  lsof \
+  su-exec \
+  shadow \
+  bash \
+  curl iputils wget \
+  git \
+  jq \
+  mysql-client \
+  tzdata \
+  rsync \
+  nano \
+  sudo \
+  knock \
+  ttf-dejavu
+
+RUN addgroup -g 1000 minecraft \
+  && adduser -Ss /bin/false -u 1000 -G minecraft -h /home/minecraft minecraft \
+  && mkdir -m 777 /data \
+  && chown minecraft:minecraft /data /home/minecraft
 
 COPY files/sudoers* /etc/sudoers.d
 
@@ -29,9 +34,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
-ARG TARGETARCH
-ARG TARGETVARIANT
+ARG TARGETOS=linux
+ARG TARGETARCH=amd64
+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

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.
@@ -390,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.
@@ -1056,6 +1069,14 @@ via a `JVM_XX_OPTS` environment variable.
 For some cases, if e.g. after removing mods, it could be necessary to startup minecraft with an additional `-D` parameter like `-Dfml.queryResult=confirm`. To address this you can use the environment variable `JVM_DD_OPTS`, which builds the params from a given list of values separated by space, but without the `-D` prefix. To make things running under systems (e.g. Plesk), which doesn't allow `=` inside values, a `:` (colon) could be used instead. The upper example would look like this:
 `JVM_DD_OPTS=fml.queryResult:confirm`, and will be converted to `-Dfml.queryResult=confirm`.
 
+The container uses [OpenJ9](https://www.eclipse.org/openj9/docs) and a couple of J9 options are
+simplified by environment variables:
+
+- `-e TUNE_VIRTUALIZED=TRUE` : enables the option to 
+  [optimize for virtualized environments](https://www.eclipse.org/openj9/docs/xtunevirtualized/)
+- `-e TUNE_NURSERY_SIZES=TRUE` : configures nursery sizes where the initial size is 50%
+  of the `MAX_MEMORY` and the max size is 80%.
+
 ### 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:

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 gosu ${runAsUser}:${runAsGroup} ${SCRIPTS:-/}start-configuration $@
+  exec su-exec ${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)
-if ! [[ $(awk "NR==$linenum" /autopause/knockd-config.cfg) =~ $regseq ]]; then
-  sed -i "${linenum}s/sequence.*/sequence = $SERVER_PORT/" /autopause/knockd-config.cfg
+linenum=$(grep -nm1 sequence /tmp/knockd-config.cfg | cut -d : -f 1 | tail -n1)
+if ! [[ $(awk "NR==$linenum" /tmp/knockd-config.cfg) =~ $regseq ]]; then
+  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)
-if ! [[ $(awk "NR==$linenum" /autopause/knockd-config.cfg) =~ $regseq ]]; then
-  sed -i "${linenum}s/sequence.*/sequence = $RCON_PORT/" /autopause/knockd-config.cfg
+linenum=$(grep -nm2 sequence /tmp/knockd-config.cfg | cut -d : -f 1 | tail -n1)
+if ! [[ $(awk "NR==$linenum" /tmp/knockd-config.cfg) =~ $regseq ]]; then
+  sed -i "${linenum}s/sequence.*/sequence = $RCON_PORT/" /tmp/knockd-config.cfg
   log "Updated rcon port in knockd config"
 fi
 

start-configuration

@@ -7,11 +7,8 @@ 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 [ "$EULA" != "true" ]; then
+  if ! isTrue "$EULA"; then
     log ""
     log "Please accept the Minecraft EULA at"
     log "  https://account.mojang.com/documents/minecraft_eula"
@@ -21,15 +18,19 @@ if [ ! -e /data/eula.txt ]; then
     exit 1
   fi
 
-  echo "# Generated via Docker on $(date)" > /data/eula.txt
-
-  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
+  writeEula
 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"
@@ -101,11 +102,7 @@ case "${TYPE^^}" in
     exec ${SCRIPTS:-/}start-deployFabric "$@"
   ;;
 
-  FTBA)
-    exec ${SCRIPTS:-/}start-deployFTB "$@"
-  ;;
-
-  CURSEFORGE|FTB)
+  FTB|CURSEFORGE)
     exec ${SCRIPTS:-/}start-deployCF "$@"
   ;;
 

start-deployCF

@@ -6,7 +6,7 @@ set -e
 
 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=CURSEFORGE
+export TYPE=FEED-THE-BEAST
 
 FTB_SERVER_MOD=${FTB_SERVER_MOD:-$CF_SERVER_MOD}
 

start-deployFTB

@@ -1,70 +0,0 @@
-#!/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}
-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-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)
-case "X$EFFECTIVE_MODPACK_URL" in
-  X[Hh][Tt][Tt][Pp]*.zip)
+  if isURL "${MODPACK}"; then
+    if [[ "${MODPACK}" == *.zip ]]; then
+      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 ..."
-    if ! curl -sSL -o /tmp/modpack.zip "$EFFECTIVE_MODPACK_URL"; then
-      log "ERROR: failed to download from $EFFECTIVE_MODPACK_URL"
+    log "  from $downloadUrl ..."
+    if ! curl -sSL -o /tmp/modpack.zip "$downloadUrl"; then
+      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
-    ;;
-  *)
-    log "Invalid URL given for modpack: Must be HTTP or HTTPS and a ZIP file"
-    ;;
-esac
+
+  else
+    log "ERROR Invalid URL given for MODPACK: $MODPACK"
+    exit 1
+  fi
 fi
 
 # If supplied with a URL for a plugin download it.
 if [[ "$MODS" ]]; then
-for i in ${MODS//,/ }
-do
-  EFFECTIVE_MOD_URL=$(curl -Ls -o /dev/null -w %{url_effective} $i)
-  case "X$EFFECTIVE_MOD_URL" in
-    X[Hh][Tt][Tt][Pp]*.jar)
+  for i in ${MODS//,/ }
+  do
+    if isURL $i; then
+      if [[ $i == *.jar ]]; then
+        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##*/}
-      ;;
-    *)
-      log "Invalid URL given for modpack: Must be HTTP or HTTPS and a JAR file"
-      ;;
-  esac
-done
+
+    else
+      log "ERROR Invalid URL given in MODS: $i"
+      exit 1
+    fi
+  done
 fi
 
 if [[ "$MANIFEST" ]]; then

start-minecraftFinalSetup

@@ -88,6 +88,23 @@ if [ -n "$JVM_DD_OPTS" ]; then
       done
 fi
 
+if isTrue ${TUNE_VIRTUALIZED}; then
+  JVM_XX_OPTS="${JVM_XX_OPTS} -Xtune:virtualized"
+fi
+
+if isTrue ${TUNE_NURSERY_SIZES}; then
+  case ${MAX_MEMORY^^} in
+    *G)
+      MAX_MEMORY_MB=$(( ${MAX_MEMORY%?} * 1024 )) ;;
+    *M)
+      MAX_MEMORY_MB=${MAX_MEMORY%?} ;;
+  esac
+
+  NURSERY_MINIMUM=$(( ${MAX_MEMORY_MB} / 2 ))
+  NURSERY_MAXIMUM=$(( ${MAX_MEMORY_MB} * 4/5 ))
+  JVM_XX_OPTS="${JVM_XX_OPTS} -Xmns${NURSERY_MINIMUM}M -Xmnx${NURSERY_MAXIMUM}M"
+fi
+
 if isTrue ${ENABLE_JMX}; then
   : ${JMX_HOST:=0.0.0.0}
   : ${JMX_PORT:=7091}
@@ -181,7 +198,7 @@ if [[ ${TYPE} == "CURSE_INSTANCE" ]]; then
     exec mc-server-runner ${mcServerRunnerArgs} \
       --cf-instance-file "${CURSE_INSTANCE_JSON}" \
       java $JVM_XX_OPTS $JVM_OPTS $expandedDOpts -jar _SERVERJAR_ "$@" $EXTRA_ARGS
-elif [[ ${TYPE} == "CURSEFORGE" && "${SERVER}" ]]; then
+elif [[ ${TYPE} == "FEED-THE-BEAST" && "${SERVER}" ]]; then
   copyFilesForCurseForge
 
   cd "${FTB_DIR}"
@@ -190,7 +207,7 @@ elif [[ ${TYPE} == "CURSEFORGE" && "${SERVER}" ]]; 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
+elif [[ ${TYPE} == "FEED-THE-BEAST" ]]; then
   mcServerRunnerArgs="${mcServerRunnerArgs} --shell bash"
 
   copyFilesForCurseForge

start-utils

@@ -113,3 +113,12 @@ requireVar() {
     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
+}