Auto-merging via docker-versions-create

#851

README.md

@@ -262,7 +262,7 @@ If you want old mods to be removed as the `/mods` content is updated, then add `
 
 For example: `-e REMOVE_OLD_MODS=TRUE -e REMOVE_OLD_MODS_INCLUDE="*.jar" -e REMOVE_OLD_MODS_DEPTH=1` will remove all old jar files that are directly inside the `plugins/` or `mods/` directory.
 
-You can specify the destination of the files that are copied from `/config` by setting the `COPY_CONFIG_DEST` variable, where the default is `/data/config`. For example, `-v ./config:/config -e COPY_CONFIG_DEST=/data` will allow you to copy over files like `bukkit.yml` and so on directly into the server directory.
+You can specify the destination of the files that are copied from `/mods` and `/config` by setting the `COPY_MODS_DEST` and `COPY_CONFIG_DEST`, where the default is `/data/mods` and `/data/config`. For example, `-v ./config:/config -e COPY_CONFIG_DEST=/data` will allow you to copy over files like `bukkit.yml` and so on directly into the server directory.
 
 > NOTE: If a file was updated in the destination path and is newer than the source file from `/config`, then it will not be overwritten.
     
@@ -327,6 +327,10 @@ An [Airplane](https://github.com/TECHNOVE/Airplane) server, which is a fork of T
 
 > **NOTE** only Java 8 and 11 are supported
 
+Extra variables:
+- `FORCE_REDOWNLOAD=false` : set to true to force the located server jar to be re-downloaded
+- `USE_FLARE_FLAGS=false` : set to true to add appropriate flags for the [Flare](https://blog.airplane.gg/flare) profiler
+
 ## Running a Purpur server
 
 A [Purpur](https://purpur.pl3x.net/) server, which is "a fork of Paper, Tuinity, Airplane with the goal of providing new and interesting configuration options".
@@ -338,6 +342,7 @@ A [Purpur](https://purpur.pl3x.net/) server, which is "a fork of Paper, Tuinity,
 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
+- `USE_FLARE_FLAGS=false` : set to true to add appropriate flags for the [Flare](https://blog.airplane.gg/flare) profiler
 
 ## Running a Yatopia server
 
@@ -350,6 +355,7 @@ A [Yatopia](https://github.com/YatopiaMC/Yatopia) server, which is a "blazing fa
 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
+- `USE_FLARE_FLAGS=false` : set to true to add appropriate flags for the [Flare](https://blog.airplane.gg/flare) profiler
 
 ## Running a Magma server
 
@@ -506,9 +512,9 @@ the `/path/on/host` folder contents look like:
 ```
 /path/on/host
 ├── mods
-│   └── ... INSTALL MODS HERE ...
+│   └── ... INSTALL MODS HERE ...
 ├── config
-│   └── ... CONFIGURE MODS HERE ...
+│   └── ... CONFIGURE MODS HERE ...
 ├── ops.json
 ├── server.properties
 ├── whitelist.json
@@ -521,24 +527,20 @@ up:
     docker stop mc
     docker start mc
 
-### Using separate mounts
+## Optional plugins, mods, and config attach points
 
-This is the easiest way if you are using an ephemeral `/data` filesystem,
+There are optional volume paths that can be attached to supply content to be copied into the data area:
-or downloading a world with the `WORLD` option.
 
-There are two additional volumes that can be mounted; `/mods` and `/config`.
+`/plugins`
-Any files in either of these filesystems will be copied over to the main
+: contents are copied into `/data/plugins` for Bukkit related server types. Set `PLUGINS_SYNC_UPDATE=false` if you want files from `/plugins` to take precedence over newer files in `/data/plugins`.
-`/data` filesystem before starting Minecraft.
 
-This works well if you want to have a common set of modules in a separate
+`/mods`
-location, but still have multiple worlds with different server requirements
+: contents are copied into `/data/mods` for Forge related server types
-in either persistent volumes or a downloadable archive.
 
-## Deploying plugins from attached volume
+`/config`
+: contents are copied into `/data/config` by default, but can be changed with `COPY_CONFIG_DEST`
 
-If the `/plugins` directory exists in the container, such as from an attached volume, any files in this directory will be copied over to `/data/plugins` before starting Minecraft. Set `PLUGINS_SYNC_UPDATE=false` if you want files from `/plugins` to take precedence over newer files in `/data/plugins`.
+These paths work 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.
-
-This works well if you want to have a common set of plugins in a separate location, but still have multiple worlds with different server requirements in either persistent volumes or a downloadable archive.
 
 ## Auto-downloading SpigotMC/Bukkit/PaperMC plugins
 

start-deployAirplane

@@ -19,7 +19,7 @@ fi
 
 export SERVER=airplane-${VANILLA_VERSION}-jdk${JAVA_VER}.jar
 
-if [ ! -f "$SERVER" ] || [ -n "$FORCE_REDOWNLOAD" ]; then
+if [ ! -f "$SERVER" ] || isTrue "$FORCE_REDOWNLOAD"; then
     downloadUrl="https://dl.airplane.gg/latest/Airplane-JDK${JAVA_VER}/launcher-airplane.jar"
     log "Downloading Airplane from $downloadUrl ..."
     curl -fsSL -o "$SERVER" "$downloadUrl"
@@ -33,5 +33,4 @@ fi
 export TYPE=SPIGOT
 export SKIP_LOG4J_CONFIG=true
 
-# Continue to Final Setup
+exec ${SCRIPTS:-/}start-spiget "$@"
-exec ${SCRIPTS:-/}start-finalSetupWorld $@

start-deployCF

@@ -60,8 +60,8 @@ if ! isTrue ${USE_MODPACK_START_SCRIPT:-true}; then
     mkdir -p ${FTB_BASE_DIR}
     unzip -o "${FTB_SERVER_MOD}" -d ${FTB_BASE_DIR} | awk '{printf "."} END {print ""}'
 
-    serverJar=$(find ${FTB_BASE_DIR}  -path "*/libraries/*" -prune -type f -o  -not -name "forge*installer.jar" -name "forge*.jar")
+    SERVER=$(find ${FTB_BASE_DIR} -type f -not -name "forge*installer.jar" -name "forge*.jar")
-    if [[ -z "$serverJar" ]]; then
+    if [[ -z "$SERVER" ]]; then
 
       if [ -f "${FTB_BASE_DIR}/settings.cfg" ]; then
         loadForgeVars "${FTB_BASE_DIR}/settings.cfg"
@@ -89,14 +89,15 @@ if ! isTrue ${USE_MODPACK_START_SCRIPT:-true}; then
     fi
 
     echo "${FTB_SERVER_MOD}" > $installMarker
+    SERVER=$(find ${FTB_BASE_DIR} -type f -not -name "forge*installer.jar" -name "forge*.jar")
   fi
 
-  export SERVER=$(find ${FTB_BASE_DIR}  -path "*/libraries/*" -prune -type f -o  -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 SERVER
 
   export FTB_DIR=$(dirname "${SERVER}")
 
@@ -167,6 +168,16 @@ if [[ $startScriptCount = 0 ]]; then
   log "Unpacking FTB server modpack ${srv_modpack} ..."
   mkdir -p ${FTB_BASE_DIR}
   unzip -o "${srv_modpack}" -d ${FTB_BASE_DIR} | awk '{printf "."} END {print ""}'
+
+  installScript=$(find "${FTB_BASE_DIR}" -maxdepth 2 -type f -name install.sh)
+  if [[ "$installScript" ]]; then
+    (
+      cd "$(dirname "${installScript}")"
+      chmod +x ./install.sh
+      log "Running included install.sh"
+      ./install.sh
+    )
+  fi
 fi
 
 if [[ $(find ${FTB_BASE_DIR} $entryScriptExpr | wc -l) = 0 ]]; then

start-deployPurpur

@@ -34,5 +34,4 @@ fi
 export TYPE=SPIGOT
 export SKIP_LOG4J_CONFIG=true
 
-# Continue to Final Setup
+exec ${SCRIPTS:-/}start-spiget "$@"
-exec ${SCRIPTS:-/}start-finalSetupWorld $@

start-deployTuinity

@@ -23,5 +23,4 @@ fi
 # Normalize on Spigot for later operations
 export TYPE=SPIGOT
 
-# Continue to Final Setup
+exec ${SCRIPTS:-/}start-spiget "$@"
-exec ${SCRIPTS:-/}start-finalSetupWorld $@

start-finalSetupEnvVariables

@@ -42,7 +42,7 @@ if isTrue "${REPLACE_ENV_VARIABLES}"; then
         $dirExcludes \
         -type f \
         \( -name "*.yml" -or -name "*.yaml" -or -name "*.txt" -or -name "*.cfg" \
-        -or -name "*.conf" -or -name "*.properties" \) \
+        -or -name "*.conf" -or -name "*.properties" -or -name "*.hjson" -or -name "*.json" \) \
         $fileExcludes \
         -exec sed -i 's#${'"$name"'}#'"$value"'#g' {} \;
   done

start-finalSetupModpack

@@ -11,21 +11,9 @@ fi
 CURSE_URL_BASE=${CURSE_URL_BASE:-https://minecraft.curseforge.com/projects}
 
 # Remove old mods/plugins
-if isTrue ${REMOVE_OLD_MODS}; then
+if isTrue ${REMOVE_OLD_MODS:-false}; then
-  remove_mods_dest="/data/mods"
+  removeOldMods /data/mods
-  case ${TYPE} in
+  removeOldMods /data/plugins
-    SPIGOT|BUKKIT|PAPER)
-      remove_mods_dest="/data/plugins"
-      ;;
-  esac
-
-  # only try to remove existing mods dir
-  if [ -d "$remove_mods_dest" ]; then
-    log "Removing old mods in $remove_mods_dest..."
-    find $remove_mods_dest -mindepth 1 -maxdepth ${REMOVE_OLD_MODS_DEPTH:-16} -wholename "${REMOVE_OLD_MODS_INCLUDE:-*}" -not -wholename "${REMOVE_OLD_MODS_EXCLUDE}" -delete
-  else
-    log "Directory $remove_mods_dest does not exist; removing nothing."
-  fi
 fi
 
 # If supplied with a URL for a modpack (simple zip of jars), download it and unpack
@@ -37,12 +25,12 @@ if [[ "$MODPACK" ]]; then
       downloadUrl=$(curl -Ls -o /dev/null -w %{effective_url} $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"
+        log "      Must be HTTP, HTTPS or FTP and a ZIP file"
         exit 1
       fi
     fi
 
-    log "Downloading mod/plugin pack via HTTP"
+    log "Downloading mod/plugin pack"
     log "  from $downloadUrl ..."
     if ! curl -sSL -o /tmp/modpack.zip "$downloadUrl"; then
       log "ERROR: failed to download from $downloadUrl"

start-finalSetupMounts

@@ -21,10 +21,12 @@ if [ -d /plugins ]; then
 fi
 
 # If any modules have been provided, copy them over
+: ${COPY_MODS_DEST:="/data/mods"}
+
 if [ -d /mods ]; then
   log "Copying any mods over..."
-  mkdir -p /data/mods
+  mkdir -p $COPY_MODS_DEST
-  rsync -a --out-format="update:%f:Last Modified %M" "${rsyncArgs[@]}" --prune-empty-dirs --update /mods /data
+  rsync -a --out-format="update:%f:Last Modified %M" "${rsyncArgs[@]}" --prune-empty-dirs --update /mods/ $COPY_MODS_DEST
 fi
 
 : ${COPY_CONFIG_DEST:="/data/config"}

start-finalSetupServerProperties

@@ -181,8 +181,8 @@ function customizeServerProps {
 }
 
 # Deploy server.properties file
-if [[ ${TYPE} == "FEED-THE-BEAST" ]]; then
+if [[ ${TYPE} == "CURSEFORGE" ]]; then
-  export SERVER_PROPERTIES=${FTB_DIR}/server.properties
+  export SERVER_PROPERTIES="${FTB_DIR}/server.properties"
   log "detected FTB, changing properties path to ${SERVER_PROPERTIES}"
 fi
 
@@ -214,7 +214,7 @@ fi
 
 if isDebugging; then
   log "DEBUG Dumping server.properties"
-  cat /data/server.properties
+  cat "${SERVER_PROPERTIES}"
 fi
 
 exec ${SCRIPTS:-/}start-finalSetupEnvVariables $@

start-finalSetupWorld

@@ -7,7 +7,7 @@ isDebugging && set -x
 : ${LEVEL:=world}
 export LEVEL
 
-if [ $TYPE = "FEED-THE-BEAST" ]; then
+if [ $TYPE = "CURSEFORGE" ]; then
   worldDest=$FTB_DIR/$LEVEL
 else
   worldDest=/data/$LEVEL

start-minecraftFinalSetup

@@ -144,6 +144,13 @@ if isTrue "${USE_LARGE_PAGES}"; then
   "
 fi
 
+if isTrue "${USE_FLARE_FLAGS}"; then
+  JVM_XX_OPTS="${JVM_XX_OPTS}
+  -XX:+UnlockDiagnosticVMOptions
+  -XX:+DebugNonSafepoints
+  "
+fi
+
 if isTrue "${DEBUG_MEMORY}"; then
   log "Memory usage and availability (in MB)"
   uname -a

start-spiget

@@ -16,7 +16,7 @@ containsJars() {
     if [[ $line =~ $pat ]]; then
       return 0
     fi
-  done <<< $(unzip -l "$file")
+  done <<<$(unzip -l "$file")
 
   return 1
 }
@@ -46,10 +46,14 @@ getResourceFromSpiget() {
 }
 
 if [[ ${SPIGET_RESOURCES} ]]; then
+  if isTrue ${REMOVE_OLD_MODS:-false}; then
+    removeOldMods /data/plugins
+    REMOVE_OLD_MODS=false
+  fi
+
   log "Getting plugins via Spiget"
-  IFS=',' read -r -a resources <<< "${SPIGET_RESOURCES}"
+  IFS=',' read -r -a resources <<<"${SPIGET_RESOURCES}"
-  for resource in "${resources[@]}"
+  for resource in "${resources[@]}"; do
-  do
     getResourceFromSpiget "${resource}"
   done
 fi

start-utils

@@ -11,7 +11,7 @@ function join_by() {
 function isURL() {
   local value=$1
 
-  if [[ ${value:0:8} == "https://" || ${value:0:7} == "http://" ]]; then
+  if [[ ${value:0:8} == "https://" || ${value:0:7} == "http://" || ${value:0:6} == "ftp://" ]]; then
     return 0
   else
     return 1
@@ -174,3 +174,9 @@ eula=${EULA,,}
     exit 2
   fi
 }
+
+function removeOldMods {
+  if [ -d "$1" ]; then
+    find "$1" -mindepth 1 -maxdepth ${REMOVE_OLD_MODS_DEPTH:-16} -wholename "${REMOVE_OLD_MODS_INCLUDE:-*}" -not -wholename "${REMOVE_OLD_MODS_EXCLUDE}" -delete
+  fi
+}