Added note on tweaking settings and using own map (#602)

* 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

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.
@@ -329,7 +342,7 @@ Specific files can be excluded by listing their name (without path) in the varia
 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/"
+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`.
@@ -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.
@@ -513,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,11 +36,6 @@ 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

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

@@ -8,8 +8,7 @@ shopt -s nullglob
 export HOME=/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"
@@ -19,12 +18,7 @@ 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
 
 
@@ -71,11 +65,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
@@ -112,7 +103,7 @@ case "${TYPE^^}" in
   ;;
 
   FTB|CURSEFORGE)
-    exec ${SCRIPTS:-/}start-deployFTB "$@"
+    exec ${SCRIPTS:-/}start-deployCF "$@"
   ;;
 
   VANILLA)

start-deployCF

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+set -e
+
 . ${SCRIPTS:-/}start-utils
 
 export FTB_BASE_DIR=/data/FeedTheBeast
@@ -9,18 +11,67 @@ export TYPE=FEED-THE-BEAST
 FTB_SERVER_MOD=${FTB_SERVER_MOD:-$CF_SERVER_MOD}
 
 log "Looking for Feed-The-Beast / CurseForge server modpack."
-if [[ -z $FTB_SERVER_MOD ]]; then
-    log "Environment variable FTB_SERVER_MOD not set."
-    log "Set FTB_SERVER_MOD to the file name of the FTB server modpack."
-    log "(And place the modpack in the /data directory.)"
+requireVar FTB_SERVER_MOD
+
+if ! isTrue ${USE_MODPACK_START_SCRIPT:-true}; then
+  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-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

@@ -6,20 +6,21 @@
 
 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
 
   # Directory excludes (recursive)
   dirExcludes=$(join_by " -o -path " ${REPLACE_ENV_VARIABLES_EXCLUDE_PATHS})
   if [[ $dirExcludes ]]; then
-    findExcludes+=" -type d ( -path ${dirExcludes} ) -prune"
+    dirExcludes=" -type d ( -path ${dirExcludes} ) -prune -o"
   fi
 
-  isDebugging && echo "Using find exclusions: $findExcludes"
+  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
@@ -34,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)
-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

@@ -158,46 +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" && "${SERVER}" ]]; then
+  copyFilesForCurseForge
+
+  cd "${FTB_DIR}"
+  log "Starting CurseForge server in ${FTB_DIR}..."
+  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} == "FEED-THE-BEAST" ]]; then
-    mcServerRunnerArgs="${mcServerRunnerArgs} --shell bash"
+  mcServerRunnerArgs="${mcServerRunnerArgs} --shell bash"
 
-    # 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}/
+  copyFilesForCurseForge
 
-    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}/"
-
-    cat > "${FTB_DIR}/settings-local.sh" <<EOF
+  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
-    if [ -f "${FTB_DIR}/settings.cfg" ]; then
-      sed -i "s/MAX_RAM=[^;]*/MAX_RAM=${MAX_MEMORY}/" "${FTB_DIR}/settings.cfg"
-    fi
+  # patch CurseForge cfg file, if present
+  if [ -f "${FTB_DIR}/settings.cfg" ]; then
+    sed -i "s/MAX_RAM=[^;]*/MAX_RAM=${MAX_MEMORY}/" "${FTB_DIR}/settings.cfg"
+  fi
 
-    cd "${FTB_DIR}"
-    log "Running FTB ${FTB_SERVER_START} in ${FTB_DIR} ..."
-    if isTrue ${DEBUG_EXEC}; then
-      set -x
-    fi
-    exec mc-server-runner ${mcServerRunnerArgs} "${FTB_SERVER_START}"
+  cd "${FTB_DIR}"
+  log "Running FTB ${FTB_SERVER_START} in ${FTB_DIR} ..."
+  if isTrue ${DEBUG_EXEC}; then
+    set -x
+  fi
+  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
@@ -205,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

@@ -108,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
 }