Auto-merging via docker-versions-create

Co-authored-by: Erik Selberg <erik.selberg@grabtaxi.com>
Co-authored-by: Geoff Bourne <itzgeoff@gmail.com>

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/build-multiarch.yml

@@ -2,57 +2,61 @@ name: Build and publish multiarch
 on:
   push:
     branches:
-      - multiarch
-      - java8-multiarch
-      - multiarch-latest
-      - java15
-      - java15-openj9
+      - master
+      - "*-multiarch"
+      - "multiarch*"
+      - java8-openj9
+      - java11*
+      - java16*
       - test/multiarch/*
     tags:
-      - "[0-9]+.[0-9]+.[0-9]+-multiarch"
-      - "[0-9]+.[0-9]+.[0-9]+-multiarch-latest"
-      - "[0-9]+.[0-9]+.[0-9]+-java15"
+      - "[0-9]+.[0-9]+.[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+-multiarch*"
+      - "[0-9]+.[0-9]+.[0-9]+-*multiarch"
+      - "[0-9]+.[0-9]+.[0-9]+-java8-openj9"
+      - "[0-9]+.[0-9]+.[0-9]+-java11*"
+      - "[0-9]+.[0-9]+.[0-9]+-java16*"
+    paths-ignore:
+      - "*.md"
+      - "docs/**"
+      - "examples/**"
 
 jobs:
   docker-buildx:
     runs-on: ubuntu-20.04
+    env:
+      CACHE_NAME: java11-openj9
     steps:
       - name: Checkout
-        uses: actions/checkout@v2.2.0
+        uses: actions/checkout@v2.3.4
 
-      - name: Prepare
-        id: prep
-        run: |
-          DOCKER_IMAGE=itzg/minecraft-server
-          VERSION=edge
-          if [[ $GITHUB_REF == refs/tags/* ]]; then
-            VERSION=${GITHUB_REF#refs/tags/}
-          fi
-          if [[ $GITHUB_REF == refs/heads/* ]]; then
-            VERSION=${GITHUB_REF#refs/heads/}
-            if [[ $VERSION == master ]]; then
-              VERSION=latest
-            fi
-          fi
-          TAGS="${DOCKER_IMAGE}:${VERSION//\//-}"
-          echo ::set-output name=tags::${TAGS}
-          echo ::set-output name=cache_from::${TAGS}
-          echo ::set-output name=version::${VERSION//\//-}
-          echo ::set-output name=cache_version::${VERSION//\//-}
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v3
+        with:
+          images: |
+            itzg/minecraft-server
+          tags: |
+            type=ref,event=branch
+            type=ref,event=tag
+            type=edge,branch=master
+          flavor: |
+            latest=false
 
       - name: Setup Docker Buildx
         uses: docker/setup-buildx-action@v1
 
       - name: Cache Docker layers
-        uses: actions/cache@v2
+        uses: actions/cache@v2.1.6
         with:
           path: /tmp/.buildx-cache
-          key: ${{ runner.os }}-buildx-${{ steps.prep.outputs.cache_version }}-${{ github.sha }}
+          key: ${{ runner.os }}-buildx-${{ env.CACHE_NAME }}-${{ github.sha }}
           restore-keys: |
-            ${{ runner.os }}-buildx-${{ steps.prep.outputs.cache_version }}-
+            ${{ runner.os }}-buildx-${{ env.CACHE_NAME }}-
+            ${{ runner.os }}-buildx-
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v1
+        uses: docker/setup-qemu-action@v1.2.0
 
       - name: Login to DockerHub
         uses: docker/login-action@v1
@@ -62,22 +66,17 @@ jobs:
 
       - name: Build and push
         id: docker_build
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v2.5.0
         with:
           context: .
-          file: ./Dockerfile
-          platforms: linux/amd64,linux/arm/v7,linux/arm64
+          platforms: linux/amd64
           push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.prep.outputs.tags }}
+          tags: ${{ steps.meta.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: |
-            org.opencontainers.image.documentation=https://github.com/itzg/docker-minecraft-server
-            org.opencontainers.image.source=https://github.com/itzg/docker-minecraft-server
-            org.opencontainers.image.version=${{ steps.prep.outputs.version }}
-            org.opencontainers.image.revision=${{ github.sha }}
+          labels: ${{ steps.meta.outputs.labels }}
 
       - name: Image digest
         run: echo ${{ steps.docker_build.outputs.digest }}

.github/workflows/generate-toc.yml

@@ -0,0 +1,20 @@
+name: Generate README table of contents
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - README.md
+jobs:
+  generate:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v2.3.4
+      - run: |
+          curl https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc -o gh-md-toc
+          chmod a+x gh-md-toc
+          ./gh-md-toc --insert --no-backup README.md
+      - uses: stefanzweifel/git-auto-commit-action@v4.11.0
+        with:
+          commit_message: "docs: Auto update markdown TOC"

.github/workflows/main.yml

@@ -3,14 +3,12 @@ name: Build and Publish
 on:
   push:
     branches:
-      - master
       - java8
       - openj9
       - openj9-11
       - adopt11
       - test/*
     tags:
-      - "[0-9]+.[0-9]+.[0-9]+"
       - "[0-9]+.[0-9]+.[0-9]+-java8"
       - "[0-9]+.[0-9]+.[0-9]+-openj9"
       - "[0-9]+.[0-9]+.[0-9]+-openj9-11"
@@ -22,7 +20,7 @@ jobs:
     runs-on: ubuntu-20.04
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v2.3.4
 
       - name: Run tests
         run: |
@@ -31,9 +29,11 @@ jobs:
     needs:
       - test
     runs-on: ubuntu-20.04
+    env:
+      CACHE_NAME: java11-openj9
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v2.3.4
 
     - name: Prepare
       id: prep
@@ -59,12 +59,12 @@ jobs:
       uses: docker/setup-buildx-action@v1
 
     - name: Cache Docker layers
-      uses: actions/cache@v2
+      uses: actions/cache@v2.1.6
       with:
         path: /tmp/.buildx-cache
-        key: ${{ runner.os }}-buildx-${{ steps.prep.outputs.cache_version }}-${{ github.sha }}
+        key: ${{ runner.os }}-buildx-${{ env.CACHE_NAME }}-${{ github.sha }}
         restore-keys: |
-          ${{ runner.os }}-buildx-${{ steps.prep.outputs.cache_version }}-
+          ${{ runner.os }}-buildx-${{ env.CACHE_NAME }}-
           ${{ runner.os }}-buildx-
 
     - name: Login to DockerHub
@@ -75,7 +75,7 @@ jobs:
 
     - name: Build and push
       id: docker_build
-      uses: docker/build-push-action@v2
+      uses: docker/build-push-action@v2.5.0
       with:
         context: .
         file: ./Dockerfile

.github/workflows/pr.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v2.3.4
 
       - name: Run tests
         run: |

.gitignore

@@ -1,3 +1,4 @@
 /data/
 /.idea/
-*.iml
+*.iml
+/gh-md-toc

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,29 @@
-FROM adoptopenjdk/openjdk11:alpine-jre
+FROM adoptopenjdk:11-jre-openj9
 
 LABEL org.opencontainers.image.authors="Geoff Bourne <itzgeoff@gmail.com>"
 
-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 apt-get update \
+  && DEBIAN_FRONTEND=noninteractive \
+  apt-get install -y \
+    imagemagick \
+    gosu \
+    sudo \
+    net-tools \
+    curl wget \
+    git \
+    jq \
+    dos2unix \
+    mysql-client \
+    tzdata \
+    rsync \
+    nano \
+    unzip \
+    knockd \
+    ttf-dejavu \
+    && apt-get clean
 
-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
+RUN addgroup --gid 1000 minecraft \
+  && adduser --system --shell /bin/false --uid 1000 --ingroup minecraft --home /data minecraft
 
 COPY files/sudoers* /etc/sudoers.d
 
@@ -31,9 +31,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 TARGETARCH=amd64
-ARG TARGETVARIANT=""
+ARG TARGETOS
+ARG TARGETARCH
+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
@@ -69,7 +69,7 @@ WORKDIR /data
 STOPSIGNAL SIGTERM
 
 ENV UID=1000 GID=1000 \
-  JVM_XX_OPTS="-XX:+UseG1GC" MEMORY="1G" \
+  MEMORY="1G" \
   TYPE=VANILLA VERSION=LATEST \
   ENABLE_RCON=true RCON_PORT=25575 RCON_PASSWORD=minecraft \
   SERVER_PORT=25565 ONLINE_MODE=TRUE SERVER_NAME="Dedicated Server" \
@@ -84,5 +84,6 @@ RUN dos2unix /start* && chmod +x /start*
 RUN dos2unix /health.sh && chmod +x /health.sh
 RUN dos2unix /autopause/* && chmod +x /autopause/*.sh
 
+
 ENTRYPOINT [ "/start" ]
 HEALTHCHECK --start-period=1m CMD /health.sh

README.md

@@ -38,6 +38,117 @@ With that you can easily view the logs, stop, or re-start the container:
 
 > Be sure to always include `-e EULA=TRUE` in your commands, as Mojang/Microsoft requires EULA acceptance.
 
+By default, the container will download the latest version of the "vanilla" [Minecraft: Java Edition server](https://www.minecraft.net/en-us/download/server) provided by Mojang. The [`VERSION`](#versions) and the [`TYPE`](#server-types) can be configured to create many variations of desired Minecraft server. 
+
+**TABLE OF CONTENTS**
+
+<!--ts-->
+   * [Looking for a Bedrock Dedicated Server](#looking-for-a-bedrock-dedicated-server)
+   * [Interacting with the server](#interacting-with-the-server)
+   * [Data Directory](#data-directory)
+      * [Attaching data directory to host filesystem](#attaching-data-directory-to-host-filesystem)
+      * [Converting anonymous /data volume to named volume](#converting-anonymous-data-volume-to-named-volume)
+   * [Versions](#versions)
+   * [Running Minecraft server on different Java version](#running-minecraft-server-on-different-java-version)
+      * [Deprecated Image Tags](#deprecated-image-tags)
+   * [Healthcheck](#healthcheck)
+   * [Deployment Templates and Examples](#deployment-templates-and-examples)
+      * [Helm Charts](#helm-charts)
+      * [Examples](#examples)
+      * [Amazon Web Services (AWS) Deployment](#amazon-web-services-aws-deployment)
+      * [Using Docker Compose](#using-docker-compose)
+   * [Server types](#server-types)
+      * [Running a Forge Server](#running-a-forge-server)
+      * [Running a Bukkit/Spigot server](#running-a-bukkitspigot-server)
+      * [Running a Paper server](#running-a-paper-server)
+      * [Running a Tuinity server](#running-a-tuinity-server)
+      * [Running an Airplane server](#running-an-airplane-server)
+      * [Running a Purpur server](#running-a-purpur-server)
+      * [Running a Yatopia server](#running-a-yatopia-server)
+      * [Running a Magma server](#running-a-magma-server)
+      * [Running a Mohist server](#running-a-mohist-server)
+      * [Running a Catserver type server](#running-a-catserver-type-server)
+      * [Running an Canyon server](#running-an-canyon-server)
+      * [Running a SpongeVanilla server](#running-a-spongevanilla-server)
+      * [Running a Fabric Server](#running-a-fabric-server)
+   * [Running a server with a Feed the Beast modpack](#running-a-server-with-a-feed-the-beast-modpack)
+      * [Environment Variables:](#environment-variables)
+      * [Upgrading](#upgrading)
+      * [Example](#example)
+   * [Running a server with a CurseForge modpack](#running-a-server-with-a-curseforge-modpack)
+         * [Modpack data directory](#modpack-data-directory)
+         * [Buggy start scripts](#buggy-start-scripts)
+      * [Fixing "unable to launch forgemodloader"](#fixing-unable-to-launch-forgemodloader)
+   * [Working with mods and plugins](#working-with-mods-and-plugins)
+      * [Optional plugins, mods, and config attach points](#optional-plugins-mods-and-config-attach-points)
+      * [Auto-downloading SpigotMC/Bukkit/PaperMC plugins](#auto-downloading-spigotmcbukkitpapermc-plugins)
+      * [Downloadable mod/plugin pack for Forge, Bukkit, and Spigot Servers](#downloadable-modplugin-pack-for-forge-bukkit-and-spigot-servers)
+      * [Remove old mods/plugins](#remove-old-modsplugins)
+   * [Working with world data](#working-with-world-data)
+      * [Downloadable world](#downloadable-world)
+      * [Cloning world from a container path](#cloning-world-from-a-container-path)
+      * [Overwrite world on start](#overwrite-world-on-start)
+   * [Server configuration](#server-configuration)
+      * [Server name](#server-name)
+      * [Server port](#server-port)
+      * [Difficulty](#difficulty)
+      * [Whitelist Players](#whitelist-players)
+      * [Op/Administrator Players](#opadministrator-players)
+      * [Server icon](#server-icon)
+      * [Rcon](#rcon)
+      * [Query](#query)
+      * [Max players](#max-players)
+      * [Max world size](#max-world-size)
+      * [Allow Nether](#allow-nether)
+      * [Announce Player Achievements](#announce-player-achievements)
+      * [Enable Command Block](#enable-command-block)
+      * [Force Gamemode](#force-gamemode)
+      * [Generate Structures](#generate-structures)
+      * [Hardcore](#hardcore)
+      * [Snooper](#snooper)
+      * [Max Build Height](#max-build-height)
+      * [Max Tick Time](#max-tick-time)
+      * [Spawn Animals](#spawn-animals)
+      * [Spawn Monsters](#spawn-monsters)
+      * [Spawn NPCs](#spawn-npcs)
+      * [Set spawn protection](#set-spawn-protection)
+      * [View Distance](#view-distance)
+      * [Level Seed](#level-seed)
+      * [Game Mode](#game-mode)
+      * [Message of the Day](#message-of-the-day)
+      * [PVP Mode](#pvp-mode)
+      * [Level Type and Generator Settings](#level-type-and-generator-settings)
+      * [Custom Server Resource Pack](#custom-server-resource-pack)
+      * [World Save Name](#world-save-name)
+      * [Online mode](#online-mode)
+      * [Allow flight](#allow-flight)
+      * [Other server property mappings](#other-server-property-mappings)
+   * [Miscellaneous Options](#miscellaneous-options)
+      * [Replacing variables inside configs](#replacing-variables-inside-configs)
+      * [Running with a custom server JAR](#running-with-a-custom-server-jar)
+      * [Force re-download of the server file](#force-re-download-of-the-server-file)
+      * [Running as alternate user/group ID](#running-as-alternate-usergroup-id)
+      * [Memory Limit](#memory-limit)
+      * [JVM Options](#jvm-options)
+      * [Interactive and Color Console](#interactive-and-color-console)
+      * [OpenJ9 Specific Options](#openj9-specific-options)
+      * [Enabling rolling logs](#enabling-rolling-logs)
+   * [Timezone Configuration](#timezone-configuration)
+      * [Enable Remote JMX for Profiling](#enable-remote-jmx-for-profiling)
+      * [Enable Aikar's Flags](#enable-aikars-flags)
+      * [HTTP Proxy](#http-proxy)
+      * [Using "noconsole" option](#using-noconsole-option)
+      * [Explicitly disable GUI](#explicitly-disable-gui)
+      * [Stop Duration](#stop-duration)
+   * [Autopause](#autopause)
+      * [Description](#description)
+      * [Enabling Autopause](#enabling-autopause)
+   * [Running on RaspberryPi](#running-on-raspberrypi)
+
+<!-- Added by: runner, at: Sun May 23 17:29:02 UTC 2021 -->
+
+<!--te-->
+
 ## Looking for a Bedrock Dedicated Server
 
 For Minecraft clients running on consoles, mobile, or native Windows, you'll need to
@@ -101,7 +212,7 @@ When attached in this way you can stop the server, edit the configuration under
 With Docker Compose, setting up a host attached directory is even easier since relative paths can be configured. For example, with the following `docker-compose.yml` Docker will automatically create/attach the relative directory `minecraft-data` to the container.
 
 ```yaml
-version: "3"
+version: "3.8"
 
 services:
   mc:
@@ -163,15 +274,14 @@ To use a different version of Java, please use a docker tag to run your Minecraf
 
 | Tag name       | Java version | Linux  | JVM Type | Architecture      |
 | -------------- | -------------|--------|----------|-------------------|
-| latest         | 11           | Alpine | Hotspot  | amd64             |
+| latest         | 16           | Debian | Hotspot  | amd64,arm64,armv7 |
 | java8          | 8            | Alpine | Hotspot  | amd64             |
 | java8-multiarch | 8           | Debian | Hotspot  | amd64,arm64,armv7 |
-| java15         | 15           | Debian | Hotspot  | amd64,arm64,armv7 |
-| java15-openj9  | 15           | Debian | OpenJ9   | amd64,arm64       |
-| adopt11        | 11           | Alpine | Hotspot  | amd64             |
-| openj9         | 8            | Alpine | OpenJ9   | amd64             |
-| openj9-11      | 11           | Alpine | OpenJ9   | amd64             |
-| multiarch      | 11           | Debian | Hotspot  | amd64,arm64,armv7 |
+| java8-openj9   | 8            | Debian | OpenJ9   | amd64             |
+| java11         | 11           | Debian | Hotspot  | amd64,arm64,armv7 |
+| java11-openj9  | 11           | Debian | OpenJ9   | amd64             |
+| java16         | 16           | Debian | Hotspot  | amd64,arm64,armv7 |
+| java16-openj9  | 16           | Debian | OpenJ9   | amd64             |
 | multiarch-latest | 15+        | Debian | Hotspot  | amd64,arm64,armv7 |
 
 For example, to use Java version 15 on any supported architecture:
@@ -212,7 +322,9 @@ Some orchestration systems, such as Portainer, don't allow for disabling the def
 
 ### Helm Charts
 
-- [stable/minecraft](https://hub.helm.sh/charts/stable/minecraft) ([chart source](https://github.com/helm/charts/tree/master/stable/minecraft))
+- itzg Helm Chart:
+  - [GitHub repo](https://github.com/itzg/minecraft-server-charts)
+  - [Helm Chart repo](https://itzg.github.io/minecraft-server-charts/)
 - [mcsh/server-deployment](https://github.com/mcserverhosting-net/charts)
 
 ### Examples
@@ -223,13 +335,46 @@ The [examples directory](https://github.com/itzg/docker-minecraft-server/tree/ma
 
 If you're looking for a simple way to deploy this to the Amazon Web Services Cloud, check out the [Minecraft Server Deployment (CloudFormation) repository](https://github.com/vatertime/minecraft-spot-pricing). This repository contains a CloudFormation template that will get you up and running in AWS in a matter of minutes. Optionally it uses Spot Pricing so the server is very cheap, and you can easily turn it off when not in use.
 
-## Running a Forge Server
+### Using Docker Compose
+
+Rather than type the server options below, the port mappings above, etc
+every time you want to create new Minecraft server, you can now use
+[Docker Compose](https://docs.docker.com/compose/). Start with a
+`docker-compose.yml` file like the following:
+
+```yml
+version: "3.8"
+
+minecraft-server:
+  image: itzg/minecraft-server
+
+  ports:
+    - "25565:25565"
+
+  environment:
+    EULA: "TRUE"
+
+  tty: true
+  stdin_open: true
+  restart: always
+```
+
+and in the same directory as that file run
+
+    docker-compose up -d
+
+Now, go play...or adjust the `environment` section to configure
+this server instance.
+
+## Server types
+
+### Running a Forge Server
 
 Enable [Forge server](http://www.minecraftforge.net/wiki/) mode by adding a `-e TYPE=FORGE` to your command-line.
 
 The overall version is specified by `VERSION`, [as described in the section above](#versions) and will run the recommended Forge version by default. You can also choose to run a specific Forge version with `FORGEVERSION`, such as `-e FORGEVERSION=14.23.5.2854`.
 
-    $ docker run -d -v /path/on/host:/data \
+    docker run -d -v /path/on/host:/data \
         -e TYPE=FORGE \
         -e VERSION=1.12.2 -e FORGEVERSION=14.23.5.2854 \
         -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
@@ -237,36 +382,18 @@ The overall version is specified by `VERSION`, [as described in the section abov
 To use a pre-downloaded Forge installer, place it in the attached `/data` directory and
 specify the name of the installer file with `FORGE_INSTALLER`, such as:
 
-    $ docker run -d -v /path/on/host:/data ... \
+    docker run -d -v /path/on/host:/data ... \
         -e FORGE_INSTALLER=forge-1.11.2-13.20.0.2228-installer.jar ...
 
 To download a Forge installer from a custom location, such as your own file repository, specify
 the URL with `FORGE_INSTALLER_URL`, such as:
 
-    $ docker run -d -v /path/on/host:/data ... \
+    docker run -d -v /path/on/host:/data ... \
         -e FORGE_INSTALLER_URL=http://HOST/forge-1.11.2-13.20.0.2228-installer.jar ...
 
 In both of the cases above, there is no need for the `VERSION` or `FORGEVERSION` variables.
 
-### Managing mods
-
-In order to manage mods, you have two options:
-
-1. [Attach a host directory to the /data path](#attaching-data-directory-to-host-filesystem) and manage the contents of the `mods` subdirectory
-
-2. Using a mods-mount
-
-If the container paths `/mods` and/or `/config` exist, such as by attaching a docker volume or host path, then any files in either of these directories will be copied over to the respective `/data` subdirectory before starting Minecraft. 
-
-If you want old mods to be removed as the `/mods` content is updated, then add `-e REMOVE_OLD_MODS=TRUE`. You can fine tune the removal process by specifying the `REMOVE_OLD_MODS_INCLUDE` and `REMOVE_OLD_MODS_EXCLUDE` variables. By default, everything will be removed. You can also specify the `REMOVE_OLD_MODS_DEPTH` (default is 16) variable to only delete files up to a certain level.
-
-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.
-
-> 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.
-    
-## Running a Bukkit/Spigot server
+### Running a Bukkit/Spigot server
 
 Enable Bukkit/Spigot server mode by adding a `-e TYPE=BUKKIT` or `-e TYPE=SPIGOT` to your command-line.
 
@@ -287,7 +414,7 @@ Plugins can either be managed within the `plugins` subdirectory of the [data dir
 
 > NOTE some of the `VERSION` values are not as intuitive as you would think, so make sure to click into the version entry to find the **exact** version needed for the download. For example, "1.8" is not sufficient since their download naming expects `1.8-R0.1-SNAPSHOT-latest` exactly.
 
-## Running a Paper server
+### Running a Paper server
 
 Enable Paper server mode by adding a `-e TYPE=PAPER` to your command-line.
 
@@ -309,7 +436,7 @@ If you have attached a host directory to the `/data` volume, then you can instal
 
 [You can also auto-download plugins using `SPIGET_RESOURCES`.](#auto-downloading-spigotmcbukkitpapermc-plugins)
 
-## Running a Tuinity server
+### Running a Tuinity server
 
 A [Tuinity](https://github.com/Spottedleaf/Tuinity) server, which is a fork of Paper aimed at improving server performance at high playercounts.
 
@@ -317,7 +444,7 @@ A [Tuinity](https://github.com/Spottedleaf/Tuinity) server, which is a fork of P
 
 > **NOTE** only `VERSION=LATEST` is supported
 
-## Running an Airplane server
+### Running an Airplane server
 
 An [Airplane](https://github.com/TECHNOVE/Airplane) server, which is a fork of Tuinity aimed at further improving server performance at high playercounts.
 
@@ -331,7 +458,7 @@ 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
+### 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".
 
@@ -344,7 +471,7 @@ 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 Yatopia server
+### Running a Yatopia server
 
 A [Yatopia](https://github.com/YatopiaMC/Yatopia) server, which is a "blazing fast Tuinity fork with best in class performance".
 
@@ -357,7 +484,7 @@ 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 Magma server
+### Running a Magma server
 
 A [Magma](https://magmafoundation.org/) server, which is a combination of Forge and PaperMC, can be used with
 
@@ -366,9 +493,9 @@ A [Magma](https://magmafoundation.org/) server, which is a combination of Forge
 > **NOTE** there are limited base versions supported, so you will also need to  set `VERSION`, such as "1.12.2"
 
 
-## Running a Mohist server
+### Running a Mohist server
 
-A [Mohist](https://github.com/Mohist-Community/Mohist) server can be used with
+A [Mohist](https://github.com/MohistMC/Mohist) server can be used with
 
     -e TYPE=MOHIST
 
@@ -378,7 +505,7 @@ By default the latest build will be used; however, a specific build number can b
 
     -e VERSION=1.16.5 -e MOHIST_BUILD=374
 
-## Running a Catserver type server
+### Running a Catserver type server
 
 A [Catserver](http://catserver.moe/) type server can be used with
 
@@ -386,6 +513,63 @@ A [Catserver](http://catserver.moe/) type server can be used with
 
 > **NOTE** Catserver only provides a single release stream, so `VERSION` is ignored
 
+### Running an Canyon server
+
+[Canyon](https://github.com/canyonmodded/canyon) is a fork of CraftBukkit for Minecraft Beta 1.7.3. It includes multiple enhancements whilst also retaining compatibility with old Bukkit plugins and mods as much as possible.
+
+    -e VERSION=b1.7.3 -e TYPE=CANYON
+
+> **NOTE** only `VERSION=b1.7.3` is supported
+
+> **NOTE** only Java 8 is supported
+
+By default the latest build will be used; however, a specific build number can be selected by setting `CANYON_BUILD`, such as
+
+    -e CANYON_BUILD=11
+
+### Running a SpongeVanilla server
+
+Enable SpongeVanilla server mode by adding a `-e TYPE=SPONGEVANILLA` to your command-line.
+By default the container will run the latest `STABLE` version.
+If you want to run a specific version, you can add `-e SPONGEVERSION=1.11.2-6.1.0-BETA-19` to your command-line.
+
+    docker run -d -v /path/on/host:/data -e TYPE=SPONGEVANILLA \
+        -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
+
+You can also choose to use the `EXPERIMENTAL` branch.
+Just change it with `SPONGEBRANCH`, such as:
+
+    $ docker run -d -v /path/on/host:/data ... \
+        -e TYPE=SPONGEVANILLA -e SPONGEBRANCH=EXPERIMENTAL ...
+
+### Running a Fabric Server
+
+Enable [Fabric server](http://fabricmc.net/use/) mode by adding a `-e TYPE=FABRIC` to your command-line. By default, the container will run the latest version, but you can also choose to run a specific version with `VERSION`.
+
+```
+docker run -d -v /path/on/host:/data \
+    -e TYPE=FABRIC \
+    -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
+```
+
+A specific installer version can be requested using `FABRIC_INSTALLER_VERSION`.
+
+To use a pre-downloaded Fabric installer, place it in a directory attached into the container, such as the `/data` volume and specify the name of the installer file with `FABRIC_INSTALLER`, such as:
+
+```
+docker run -d -v /path/on/host:/data ... \
+    -e FABRIC_INSTALLER=fabric-installer-0.5.0.32.jar ...
+```
+
+To download a Fabric installer from a custom location, such as your own file repository, specify the URL with `FABRIC_INSTALLER_URL`, such as:
+
+```
+docker run -d -v /path/on/host:/data ... \
+    -e FABRIC_INSTALLER_URL=http://HOST/fabric-installer-0.5.0.32.jar ...
+```
+
+In order to add mods, you have two options:
+
 ## Running a server with a Feed the Beast modpack
 
 > **NOTE** requires one of the Debian based images listed in [the Java versions section](#running-minecraft-server-on-different-java-version).
@@ -457,96 +641,32 @@ then you apply a workaround by adding this to the run invocation:
 
     -e FTB_LEGACYJAVAFIXER=true
 
-## Running a SpongeVanilla server
+## Working with mods and plugins
 
-Enable SpongeVanilla server mode by adding a `-e TYPE=SPONGEVANILLA` to your command-line.
-By default the container will run the latest `STABLE` version.
-If you want to run a specific version, you can add `-e SPONGEVERSION=1.11.2-6.1.0-BETA-19` to your command-line.
+### Optional plugins, mods, and config attach points
 
-    docker run -d -v /path/on/host:/data -e TYPE=SPONGEVANILLA \
-        -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
+There are optional volume paths that can be attached to supply content to be copied into the data area:
 
-You can also choose to use the `EXPERIMENTAL` branch.
-Just change it with `SPONGEBRANCH`, such as:
+`/plugins`
+: 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`.
 
-    $ docker run -d -v /path/on/host:/data ... \
-        -e TYPE=SPONGEVANILLA -e SPONGEBRANCH=EXPERIMENTAL ...
+`/mods`
+: contents are copied into `/data/mods` for Forge related server types
 
-## Running a Fabric Server
+`/config`
+: contents are copied into `/data/config` by default, but can be changed with `COPY_CONFIG_DEST`
 
-Enable [Fabric server](http://fabricmc.net/use/) mode by adding a `-e TYPE=FABRIC` to your command-line. By default, the container will run the latest version, but you can also choose to run a specific version with `VERSION`.
+If you want old mods/plugins to be removed before the content is brought over from those attach points, then add `-e REMOVE_OLD_MODS=TRUE`. You can fine tune the removal process by specifying the `REMOVE_OLD_MODS_INCLUDE` and `REMOVE_OLD_MODS_EXCLUDE` variables. By default, everything will be removed. You can also specify the `REMOVE_OLD_MODS_DEPTH` (default is 16) variable to only delete files up to a certain level.
 
-```
-docker run -d -v /path/on/host:/data \
-    -e TYPE=FABRIC \
-    -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
-```
+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.
 
-A specific installer version can be requested using `FABRIC_INSTALLER_VERSION`. 
+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.
 
-To use a pre-downloaded Fabric installer, place it in a directory attached into the container, such as the `/data` volume and specify the name of the installer file with `FABRIC_INSTALLER`, such as:
+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.
 
-```
-docker run -d -v /path/on/host:/data ... \
-    -e FABRIC_INSTALLER=fabric-installer-0.5.0.32.jar ...
-```
+> For more flexibility with mods/plugins preparation, you can declare directories to use in [the `MODS` variable](#downloadable-modplugin-pack-for-forge-bukkit-and-spigot-servers)
 
-To download a Fabric installer from a custom location, such as your own file repository, specify the URL with `FABRIC_INSTALLER_URL`, such as:
-
-```
-docker run -d -v /path/on/host:/data ... \
-    -e FABRIC_INSTALLER_URL=http://HOST/fabric-installer-0.5.0.32.jar ...
-```
-
-In order to add mods, you have two options:
-
-### Using the /data volume
-
-This is the easiest way if you are using a persistent `/data` mount.
-
-To do this, you will need to attach the container's `/data` directory
-(see "Attaching data directory to host filesystem”).
-Then, you can add mods to the `/path/on/host/mods` folder you chose. From the example above,
-the `/path/on/host` folder contents look like:
-
-```
-/path/on/host
-├── mods
-│   └── ... INSTALL MODS HERE ...
-├── config
-│   └── ... CONFIGURE MODS HERE ...
-├── ops.json
-├── server.properties
-├── whitelist.json
-└── ...
-```
-
-If you add mods while the container is running, you'll need to restart it to pick those
-up:
-
-    docker stop mc
-    docker start mc
-
-### Using separate mounts
-
-This is the easiest way if you are using an ephemeral `/data` filesystem,
-or downloading a world with the `WORLD` option.
-
-There are two additional volumes that can be mounted; `/mods` and `/config`.
-Any files in either of these filesystems will be copied over to the main
-`/data` filesystem before starting Minecraft.
-
-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.
-
-## Deploying plugins from attached volume
-
-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`.
-
-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
+### Auto-downloading SpigotMC/Bukkit/PaperMC plugins
 
 The `SPIGET_RESOURCES` variable can be set with a comma-separated list of SpigotMC resource IDs to automatically download [SpigotMC resources/plugins](https://www.spigotmc.org/resources/) using [the spiget API](https://spiget.org/). Resources that are zip files will be expanded into the plugins directory and resources that are simply jar files will be moved there.
 
@@ -561,157 +681,65 @@ For example, the following will auto-download the [EssentialsX](https://www.spig
 
     -e SPIGET_RESOURCES=9089,34315
 
-## Replacing variables inside configs
+### Downloadable mod/plugin pack for Forge, Bukkit, and Spigot Servers
 
-Sometimes you have mods or plugins that require configuration information that is only available at runtime.
-For example if you need to configure a plugin to connect to a database,
-you don't want to include this information in your Git repository or Docker image.
-Or maybe you have some runtime information like the server name that needs to be set
-in your config files after the container starts.
+Like the `WORLD` option above, you can specify the URL or path of a "mod pack"
+to download and install into `mods` for Forge or `plugins` for Bukkit/Spigot.
+To use this option pass the environment variable `MODPACK`, such as
 
-For those cases there is the option to replace defined variables inside your configs
-with environment variables defined at container runtime.
+    docker run -d -e MODPACK=http://www.example.com/mods/modpack.zip ...
 
-If you set the enviroment variable `REPLACE_ENV_VARIABLES` to `TRUE` the startup script
-will go thru all files inside your `/data` volume and replace variables that match your
-defined environment variables. Variables that you want to replace need to be wrapped
-inside `${YOUR_VARIABLE}` curly brackets and prefixed with a dollar sign. This is the regular
-syntax for enviromment variables inside strings or config files.
+**NOTE:** The referenced URL must be a zip file with one or more jar files at the
+top level of the zip archive. Make sure the jars are compatible with the
+particular `TYPE` of server you are running.
 
-Optionally you can also define a prefix to only match predefined environment variables.
+You may also download or copy over individual mods using the `MODS` environment variable. `MODS` contains a comma-separated list of
+- URL of a jar file
+- container path to a jar file
+- container path to a directory containing jar files
 
-`ENV_VARIABLE_PREFIX="CFG_"` <-- this is the default prefix
+  docker run -d -e MODS=https://www.example.com/mods/mod1.jar,/plugins/common,/plugins/special/mod2.jar ...
 
-If you want use file for value (like when use secrets) you can add suffix `_FILE` to your variable name (in  run command).
+### Remove old mods/plugins
 
-There are some limitations to what characters you can use.
+When the option above is specified (`MODPACK`) you can also instruct script to
+delete old mods/plugins prior to installing new ones. This behaviour is desirable
+in case you want to upgrade mods/plugins from downloaded zip file.
+To use this option pass the environment variable `REMOVE_OLD_MODS="TRUE"`, such as
 
-| Type  | Allowed Characters  |
-| ----- | ------------------- |
-| Name  | `0-9a-zA-Z_-`       |
-| Value | `0-9a-zA-Z_-:/=?.+` |
+    docker run -d -e REMOVE_OLD_MODS="TRUE" -e MODPACK=http://www.example.com/mods/modpack.zip ...
 
-Variables will be replaced in files with the following extensions:
-`.yml`, `.yaml`, `.txt`, `.cfg`, `.conf`, `.properties`.
+**WARNING:** All content of the `mods` or `plugins` directory will be deleted
+before unpacking new content from the MODPACK or MODS.
 
-Specific files can be excluded by listing their name (without path) in the variable `REPLACE_ENV_VARIABLES_EXCLUDES`.
+## Working with world data
 
-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"
-```
+### Downloadable world
 
-Here is a full example where we want to replace values inside a `database.yml`.
+Instead of mounting the `/data` volume, you can instead specify the URL of a ZIP file containing an archived world. It will be searched for a file `level.dat` and the containing subdirectory moved to the directory named by `$LEVEL`. This means that most of the archived Minecraft worlds downloadable from the Internet will already be in the correct format.
 
-```yml
+    docker run -d -e WORLD=http://www.example.com/worlds/MySave.zip ...
 
----
-database:
-  host: ${CFG_DB_HOST}
-  name: ${CFG_DB_NAME}
-  password: ${CFG_DB_PASSWORD}
-```
+**NOTE:** This URL must be accessible from inside the container. Therefore,
+you should use an IP address or a globally resolvable FQDN, or else the
+name of a linked container.
 
-This is how your `docker-compose.yml` file could look like:
+**NOTE:** If the archive contains more than one `level.dat`, then the one to select can be picked with `WORLD_INDEX`, which defaults to 1.
 
-```yml
-version: "3"
-# Other docker-compose examples in /examples
+### Cloning world from a container path
 
-services:
-  minecraft:
-    image: itzg/minecraft-server
-    ports:
-      - "25565:25565"
-    volumes:
-      - "mc:/data"
-    environment:
-      EULA: "TRUE"
-      ENABLE_RCON: "true"
-      RCON_PASSWORD: "testing"
-      RCON_PORT: 28016
-      # enable env variable replacement
-      REPLACE_ENV_VARIABLES: "TRUE"
-      # define an optional prefix for your env variables you want to replace
-      ENV_VARIABLE_PREFIX: "CFG_"
-      # and here are the actual variables
-      CFG_DB_HOST: "http://localhost:3306"
-      CFG_DB_NAME: "minecraft"
-      CFG_DB_PASSWORD_FILE: "/run/secrets/db_password"
-    restart: always
-  rcon:
-    image: itzg/rcon
-    ports:
-      - "4326:4326"
-      - "4327:4327"
-    volumes:
-      - "rcon:/opt/rcon-web-admin/db"
+The `WORLD` option can also be used to reference a directory or zip file that will be used as a source to clone or unzip the world directory.
 
-volumes:
-  mc:
-  rcon:
-
-secrets:
-  db_password:
-    file: ./db_password
-```
-
-The content of `db_password`:
-
-    ug23u3bg39o-ogADSs
-
-## Running with a custom server JAR
-
-If you would like to run a custom server JAR, set `-e TYPE=CUSTOM` and pass the custom server
-JAR via `CUSTOM_SERVER`. It can either be a URL or a container path to an existing JAR file.
-
-If it is a URL, it will only be downloaded into the `/data` directory if it wasn't already. As
-such, if you need to upgrade or re-download the JAR, then you will need to stop the container,
-remove the file from the container's `/data` directory, and start again.
-
-## Force re-download of the server file
-
-For VANILLA, FORGE, BUKKIT, SPIGOT, PAPER, CURSEFORGE, SPONGEVANILLA server types, set
-`$FORCE_REDOWNLOAD` to some value (e.g. 'true) to force a re-download of the server file for
-the particular server type. by adding a `-e FORCE_REDOWNLOAD=true` to your command-line.
-
-For example, with PaperSpigot, it would look something like this:
+For example, the following would initially clone the world's content
+from `/worlds/basic`. Also notice in the example that you can use a
+read-only volume attachment to ensure the clone source remains pristine.
 
 ```
-docker run -d -v /path/on/host:/data \
-    -e TYPE=PAPER -e FORCE_REDOWNLOAD=true \
-    -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
+docker run ... -v $HOME/worlds:/worlds:ro -e WORLD=/worlds/basic
 ```
 
-## Using Docker Compose
-
-Rather than type the server options below, the port mappings above, etc
-every time you want to create new Minecraft server, you can now use
-[Docker Compose](https://docs.docker.com/compose/). Start with a
-`docker-compose.yml` file like the following:
-
-```
-minecraft-server:
-  image: itzg/minecraft-server
-
-  ports:
-    - "25565:25565"
-
-  environment:
-    EULA: "TRUE"
-
-  tty: true
-  stdin_open: true
-  restart: always
-```
-
-and in the same directory as that file run
-
-    docker-compose up -d
-
-Now, go play...or adjust the `environment` section to configure
-this server instance.
+### Overwrite world on start
+The world will only be downloaded or copied if it doesn't exist already. Set `FORCE_WORLD_COPY=TRUE` to force overwrite the world on every server start.
 
 ## Server configuration
 
@@ -991,62 +1019,6 @@ where the default is "world":
 **NOTE:** if running multiple containers be sure to either specify a different `-v` host directory for each
 `LEVEL` in use or don't use `-v` and the container's filesystem will keep things encapsulated.
 
-### Downloadable world
-
-Instead of mounting the `/data` volume, you can instead specify the URL of a ZIP file containing an archived world. It will be searched for a file `level.dat` and the containing subdirectory moved to the directory named by `$LEVEL`. This means that most of the archived Minecraft worlds downloadable from the Internet will already be in the correct format.
-
-    docker run -d -e WORLD=http://www.example.com/worlds/MySave.zip ...
-
-**NOTE:** This URL must be accessible from inside the container. Therefore,
-you should use an IP address or a globally resolvable FQDN, or else the
-name of a linked container.
-
-**NOTE:** If the archive contains more than one `level.dat`, then the one to select can be picked with `WORLD_INDEX`, which defaults to 1.
-
-### Cloning world from a container path
-
-The `WORLD` option can also be used to reference a directory or zip file that will be used as a source to clone or unzip the world directory.
-
-For example, the following would initially clone the world's content
-from `/worlds/basic`. Also notice in the example that you can use a
-read-only volume attachment to ensure the clone source remains pristine.
-
-```
-docker run ... -v $HOME/worlds:/worlds:ro -e WORLD=/worlds/basic
-```
-
-### Overwrite world on start
-The world will only be downloaded or copied if it doesn't exist already. Set `FORCE_WORLD_COPY=TRUE` to force overwrite the world on every server start.
-
-### Downloadable mod/plugin pack for Forge, Bukkit, and Spigot Servers
-
-Like the `WORLD` option above, you can specify the URL of a "mod pack"
-to download and install into `mods` for Forge or `plugins` for Bukkit/Spigot.
-To use this option pass the environment variable `MODPACK`, such as
-
-    docker run -d -e MODPACK=http://www.example.com/mods/modpack.zip ...
-
-**NOTE:** The referenced URL must be a zip file with one or more jar files at the
-top level of the zip archive. Make sure the jars are compatible with the
-particular `TYPE` of server you are running.
-
-You may also download individual mods using the `MODS` environment variable and supplying the URL
-to the jar files. Multiple mods/plugins should be comma separated.
-
-    docker run -d -e MODS=https://www.example.com/mods/mod1.jar,https://www.example.com/mods/mod2.jar ...
-
-### Remove old mods/plugins
-
-When the option above is specified (`MODPACK`) you can also instruct script to
-delete old mods/plugins prior to installing new ones. This behaviour is desirable
-in case you want to upgrade mods/plugins from downloaded zip file.
-To use this option pass the environment variable `REMOVE_OLD_MODS="TRUE"`, such as
-
-    docker run -d -e REMOVE_OLD_MODS="TRUE" -e MODPACK=http://www.example.com/mods/modpack.zip ...
-
-**WARNING:** All content of the `mods` or `plugins` directory will be deleted
-before unpacking new content from the MODPACK or MODS.
-
 ### Online mode
 
 By default, server checks connecting players against Minecraft's account database. If you want to create an offline server or your server is not connected to the internet, you can disable the server to try connecting to minecraft.net to authenticate players with environment variable `ONLINE_MODE`, like this
@@ -1079,6 +1051,129 @@ Allows users to use flight on your server while in Survival mode, if they have a
 
 ## Miscellaneous Options
 
+### Replacing variables inside configs
+
+Sometimes you have mods or plugins that require configuration information that is only available at runtime.
+For example if you need to configure a plugin to connect to a database,
+you don't want to include this information in your Git repository or Docker image.
+Or maybe you have some runtime information like the server name that needs to be set
+in your config files after the container starts.
+
+For those cases there is the option to replace defined variables inside your configs
+with environment variables defined at container runtime.
+
+If you set the enviroment variable `REPLACE_ENV_VARIABLES` to `TRUE` the startup script
+will go thru all files inside your `/data` volume and replace variables that match your
+defined environment variables. Variables that you want to replace need to be wrapped
+inside `${YOUR_VARIABLE}` curly brackets and prefixed with a dollar sign. This is the regular
+syntax for enviromment variables inside strings or config files.
+
+Optionally you can also define a prefix to only match predefined environment variables.
+
+`ENV_VARIABLE_PREFIX="CFG_"` <-- this is the default prefix
+
+If you want use file for value (like when use secrets) you can add suffix `_FILE` to your variable name (in  run command).
+
+There are some limitations to what characters you can use.
+
+| Type  | Allowed Characters  |
+| ----- | ------------------- |
+| Name  | `0-9a-zA-Z_-`       |
+| Value | `0-9a-zA-Z_-:/=?.+` |
+
+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`. 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`.
+
+```yml
+
+---
+database:
+  host: ${CFG_DB_HOST}
+  name: ${CFG_DB_NAME}
+  password: ${CFG_DB_PASSWORD}
+```
+
+This is how your `docker-compose.yml` file could look like:
+
+```yml
+version: "3.8"
+# Other docker-compose examples in /examples
+
+services:
+  minecraft:
+    image: itzg/minecraft-server
+    ports:
+      - "25565:25565"
+    volumes:
+      - "mc:/data"
+    environment:
+      EULA: "TRUE"
+      ENABLE_RCON: "true"
+      RCON_PASSWORD: "testing"
+      RCON_PORT: 28016
+      # enable env variable replacement
+      REPLACE_ENV_VARIABLES: "TRUE"
+      # define an optional prefix for your env variables you want to replace
+      ENV_VARIABLE_PREFIX: "CFG_"
+      # and here are the actual variables
+      CFG_DB_HOST: "http://localhost:3306"
+      CFG_DB_NAME: "minecraft"
+      CFG_DB_PASSWORD_FILE: "/run/secrets/db_password"
+    restart: always
+  rcon:
+    image: itzg/rcon
+    ports:
+      - "4326:4326"
+      - "4327:4327"
+    volumes:
+      - "rcon:/opt/rcon-web-admin/db"
+
+volumes:
+  mc:
+  rcon:
+
+secrets:
+  db_password:
+    file: ./db_password
+```
+
+The content of `db_password`:
+
+    ug23u3bg39o-ogADSs
+
+### Running with a custom server JAR
+
+If you would like to run a custom server JAR, set `-e TYPE=CUSTOM` and pass the custom server
+JAR via `CUSTOM_SERVER`. It can either be a URL or a container path to an existing JAR file.
+
+If it is a URL, it will only be downloaded into the `/data` directory if it wasn't already. As
+such, if you need to upgrade or re-download the JAR, then you will need to stop the container,
+remove the file from the container's `/data` directory, and start again.
+
+### Force re-download of the server file
+
+For VANILLA, FORGE, BUKKIT, SPIGOT, PAPER, CURSEFORGE, SPONGEVANILLA server types, set
+`$FORCE_REDOWNLOAD` to some value (e.g. 'true) to force a re-download of the server file for
+the particular server type. by adding a `-e FORCE_REDOWNLOAD=true` to your command-line.
+
+For example, with PaperSpigot, it would look something like this:
+
+```
+docker run -d -v /path/on/host:/data \
+    -e TYPE=PAPER -e FORCE_REDOWNLOAD=true \
+    -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
+```
+
 ### Running as alternate user/group ID
 
 By default, the container will switch to user ID 1000 and group ID 1000;
@@ -1243,9 +1338,7 @@ The following environment variables define the behaviour of auto-pausing:
 
 ## Running on RaspberryPi
 
-To run this image on a RaspberryPi 3 B+, 4, or newer, use any of the image tags [list in the Java version section](#running-minecraft-server-on-different-java-version) that specify `armv7` for the architecture, such as
-
-    itzg/minecraft-server:multiarch
+To run this image on a RaspberryPi 3 B+, 4, or newer, use any of the image tags [list in the Java version section](#running-minecraft-server-on-different-java-version) that specify `armv7` for the architecture, which includes `itzg/minecraft-server:latest`.
 
 > NOTE: you may need to lower the memory allocation, such as `-e MEMORY=750m`
 

docker-versions-create.sh

@@ -4,12 +4,11 @@
 branches_list=(
   'java8'
   'java8-multiarch'
-  'openj9'
-  'openj9-11'
-  'adopt11'
-  'java15'
-  'java15-openj9'
-  'multiarch'
+  'java8-openj9'
+  'java11'
+  'java11-openj9'
+  'java16'
+  'java16-openj9'
   'multiarch-latest'
   )
 

examples/docker-compose-big.yml

@@ -1,4 +1,4 @@
-version: '3'
+version: '3.8'
 
 services:
   minecraft:

examples/docker-compose-curseforge.yml

@@ -1,4 +1,4 @@
-version: '3.2'
+version: '3.8'
 
 services:
   mc:

examples/docker-compose-forge.yml

@@ -1,4 +1,4 @@
-version: "3.7"
+version: "3.8"
 
 services:
   mc:

examples/docker-compose-ftba.yml

@@ -1,4 +1,4 @@
-version: "3.7"
+version: "3.8"
 
 services:
   mc:

examples/docker-compose-paper.yml

@@ -1,4 +1,4 @@
-version: '3.7'
+version: '3.8'
 
 services:
   mc:

examples/docker-compose-proxied.yml

@@ -1,4 +1,4 @@
-version: '3'
+version: '3.8'
 
 services:
   mc:

examples/docker-compose-simple.yml

@@ -1,4 +1,4 @@
-version: "3"
+version: "3.8"
 
 services:
   mc:

examples/docker-compose-spongeforge.yml

@@ -1,4 +1,4 @@
-version: '3'
+version: '3.8'
 # Forge with Sponge API support. THIS REQUIRES DOWNLOADING SPONGEFORGE.
 # Place the SpongeForge jar file in /data/mods. Other Forge mods go here as well.
 # Place Sponge mods in /data/mods/plugins. Yes, this is a directory inside the Forge mod directory. Do NOT use /data/plugins.

examples/docker-compose-world-download.yml

@@ -1,4 +1,4 @@
-version: "3.7"
+version: "3.8"
 
 services:
   mc:

examples/modpacks/README.md

@@ -1,3 +1,3 @@
 Place server [modpacks downloaded from CurseForge](https://www.curseforge.com/minecraft/modpacks) in this directory.
 
-The example [`docker-compose-curseforge.yml`](../docker-compose-curseforge.yml) references a modpack downloaded from <https://www.curseforge.com/minecraft/modpacks/skyfactory-4/files/2787018>.
+The example [`docker-compose-curseforge.yml`](../docker-compose-curseforge.yml) references a modpack downloaded from <https://www.curseforge.com/minecraft/modpacks/skyfactory-4/files/3012800>.

files/autopause/autopause-fcns.sh

@@ -5,15 +5,15 @@ current_uptime() {
 }
 
 java_running() {
-  [[ $( ps -a -o stat,comm | grep 'java' | awk '{ print $1 }') =~ ^S.*$ ]]
+  [[ $( ps -ax -o stat,comm | grep 'java' | awk '{ print $1 }') =~ ^S.*$ ]]
 }
 
 java_process_exists() {
-  [[ -n "$(ps -a -o comm | grep 'java')" ]]
+  [[ -n "$(ps -ax -o comm | grep 'java')" ]]
 }
 
 rcon_client_exists() {
-  [[ -n "$(ps -a -o comm | grep 'rcon-cli')" ]]
+  [[ -n "$(ps -ax -o comm | grep 'rcon-cli')" ]]
 }
 
 mc_server_listening() {

files/autopause/knockd-config.cfg

@@ -3,10 +3,10 @@
 [unpauseMCServer-server]
  sequence = 25565
  seq_timeout = 1
- command = /sbin/su-exec minecraft:minecraft /autopause/resume.sh
+ command = /usr/sbin/gosu minecraft:minecraft /autopause/resume.sh
  tcpflags = syn
 [unpauseMCServer-rcon]
  sequence = 25575
  seq_timeout = 1
- command = /sbin/su-exec minecraft:minecraft /autopause/resume.sh
+ command = /usr/sbin/gosu minecraft:minecraft /autopause/resume.sh
  tcpflags = syn

files/autopause/pause.sh

@@ -2,7 +2,7 @@
 
 . /start-utils
 
-if [[ $( ps -a -o stat,comm | grep 'java' | awk '{ print $1 }') =~ ^S.*$ ]] ; then
+if [[ $( ps -ax -o stat,comm | grep 'java' | awk '{ print $1 }') =~ ^S.*$ ]] ; then
   # save world
   rcon-cli save-all >/dev/null
 

files/autopause/resume.sh

@@ -2,7 +2,7 @@
 
 . /start-utils
 
-if [[ $( ps -a -o stat,comm | grep 'java' | awk '{ print $1 }') =~ ^T.*$ ]] ; then
+if [[ $( ps -ax -o stat,comm | grep 'java' | awk '{ print $1 }') =~ ^T.*$ ]] ; then
   logAutopauseAction "Knocked, resuming Java process"
   pkill -CONT java
 fi

health.sh

@@ -5,7 +5,7 @@
 if isTrue "${DISABLE_HEALTHCHECK}"; then
   echo "Healthcheck disabled"
   exit 0
-elif isTrue "${ENABLE_AUTOPAUSE}" && [[ "$( ps -a -o stat,comm | grep 'java' | awk '{ print $1 }')" =~ ^T.*$ ]]; then
+elif isTrue "${ENABLE_AUTOPAUSE}" && [[ "$( ps -ax -o stat,comm | grep 'java' | awk '{ print $1 }')" =~ ^T.*$ ]]; then
   echo "Java process suspended by Autopause function"
   exit 0
 else

start

@@ -40,7 +40,7 @@ if ! isTrue "${SKIP_SUDO:-false}" && [ $(id -u) = 0 ]; 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-configuration

@@ -13,6 +13,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
   if ! isTrue "$EULA"; then
     log ""
@@ -28,15 +30,6 @@ if [ ! -e /data/eula.txt ]; then
 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"
@@ -118,6 +111,10 @@ case "${TYPE^^}" in
     exec ${SCRIPTS:-/}start-deployFabric "$@"
   ;;
 
+  FTBA)
+    exec ${SCRIPTS:-/}start-deployFTBA "$@"
+  ;;
+
   FTB|CURSEFORGE)
     log "**********************************************************************"
     log "WARNING: The image tag itzg/minecraft-server:java8 is recommended"
@@ -163,16 +160,20 @@ case "${TYPE^^}" in
   YATOPIA)
     exec ${SCRIPTS:-/}start-deployYatopia "$@"
   ;;
-  
-   AIRPLANE)
+
+  AIRPLANE)
     exec ${SCRIPTS:-/}start-deployAirplane "$@"
   ;;
 
+  CANYON)
+    exec ${SCRIPTS:-/}start-deployCanyon "$@"
+  ;;
+
   *)
       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, YATOPIA, AIRPLANE"
+      log "         CUSTOM, MAGMA, MOHIST, CATSERVER, YATOPIA, AIRPLANE, CANYON"
       exit 1
   ;;
 

start-deployAirplane

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

start-deployCF

@@ -27,7 +27,7 @@ isDebugging && set -x
 export FTB_BASE_DIR
 
 legacyJavaFixerUrl=https://ftb.forgecdn.net/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}
 
@@ -60,7 +60,7 @@ 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")
+    serverJar=$(find ${FTB_BASE_DIR} -type f \( -path "*/libraries/*" -o -path "*/mods/*" \) -prune -o -name "forge*.jar" -not -name "forge*installer.jar" -print)
     if [[ -z "$serverJar" ]]; then
 
       if [ -f "${FTB_BASE_DIR}/settings.cfg" ]; then
@@ -85,13 +85,14 @@ if ! isTrue ${USE_MODPACK_START_SCRIPT:-true}; then
       fi
 
       log "Installing forge server"
-      (cd $(dirname "${forgeInstallerJar}"); java -jar $(basename "${forgeInstallerJar}") --installServer)
+      dirOfInstaller=$(dirname "${forgeInstallerJar}")
+      (cd "${dirOfInstaller}"; java -jar $(basename "${forgeInstallerJar}") --installServer)
     fi
 
     echo "${FTB_SERVER_MOD}" > $installMarker
   fi
 
-  export SERVER=$(find ${FTB_BASE_DIR}  -path "*/libraries/*" -prune -type f -o  -not -name "forge*installer.jar" -name "forge*.jar")
+  export SERVER=$(find ${FTB_BASE_DIR} -type f \( -path "/libraries/*" -o -path "/mods/*" \) -prune -o -name "forge*.jar" -not -name "forge*installer.jar" -maxdepth 2 -print)
   if [[ -z "${SERVER}" || ! -f "${SERVER}" ]]; then
     log "ERROR unable to locate installed forge server jar"
     isDebugging && find ${FTB_BASE_DIR} -name "forge*.jar"
@@ -109,6 +110,7 @@ entryScriptExpr="
   -o -name ServerStartLinux.sh
   -o -name LaunchServer.sh
   -o -name server-start.sh
+  -o -name start-server.sh
   -o -name startserver.sh
   -o -name StartServer.sh
   "
@@ -167,13 +169,23 @@ 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
 
     # Allow up to 2 levels since some modpacks have a top-level directory named
     # for the modpack
-    forgeJar=$(find ${FTB_BASE_DIR} -maxdepth 2 -name 'forge*.jar' -a -not -name 'forge*installer')
+    forgeJar=$(find ${FTB_BASE_DIR} -type f \( -path "/libraries/*" -o -path "/mods/*" \) -prune -o -name "forge*.jar" -not -name "forge*installer.jar" -maxdepth 2 -print)
     if [[ "$forgeJar" ]]; then
       export FTB_BASE_DIR=$(dirname "${forgeJar}")
       log "No entry script found, so building one for ${forgeJar}"

start-deployCanyon

@@ -0,0 +1,54 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+. ${SCRIPTS:-/}start-utils
+isDebugging && set -x
+
+: ${CANYON_BUILD:=lastSuccessfulBuild}
+JAVA_VER=$(java -version 2>&1 | head -1 | cut -d'"' -f2 | sed '/^1\./s///' | cut -d'.' -f1)
+
+if [ "${JAVA_VER}" != "8" ]; then
+  log "ERROR: Canyon server type only supports Java version 8"
+  exit 1
+fi
+
+if [ "${VERSION}" != "b1.7.3" ]; then
+  log "ERROR: Canyon server type only supports VERSION=b1.7.3"
+  exit 1
+fi
+
+canyonJob="https://ci.velocitypowered.com/job/Canyon"
+
+buildRelPath=$(
+  curl -fsSL "${canyonJob}/${CANYON_BUILD}/api/json" |
+    jq -r '.artifacts[0].relativePath'
+)
+buildNumber=$(
+  curl -fsSL "${canyonJob}/${CANYON_BUILD}/api/json" |
+    jq -r '.number'
+)
+baseName=$(basename "${buildRelPath}")
+
+# Add build tag to non-tagged builds for version detection
+if [ ${baseName%.*} = 'canyon-server' ]; then
+    export SERVER=${baseName%.*}_build${buildNumber}.jar
+else
+    export SERVER="${baseName}"
+fi
+
+if [ ! -f "$SERVER" ]; then
+    downloadUrl="${canyonJob}/${CANYON_BUILD}/artifact/${buildRelPath}"
+    log "Downloading Canyon build ${buildNumber} 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 later operations
+export TYPE=SPIGOT
+export SKIP_LOG4J_CONFIG=true
+
+exec ${SCRIPTS:-/}start-spiget "$@"

start-deployFTBA

@@ -0,0 +1,75 @@
+#!/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
+
+  # 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
+
+isDebugging && cat version.json
+forgeVersion=$(jq -r '.targets|unique[] | select(.name == "forge") | .version' version.json)
+mcVersion=$(jq -r '.targets|unique[] | 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-deployForge

@@ -68,7 +68,7 @@ if [ ! -e $installMarker ]; then
           log "Unable to compute URL for $normForgeVersion"
           exit 2
         fi
-        downloadUrl=http://files.minecraftforge.net/maven/net/minecraftforge/forge/$fn
+        downloadUrl=https://maven.minecraftforge.net/net/minecraftforge/forge/$fn
         log "...trying $downloadUrl"
         if curl -o $FORGE_INSTALLER -fsSL $downloadUrl; then
           break

start-deployMohist

@@ -8,12 +8,12 @@ isDebugging && set -x
 requireVar VANILLA_VERSION
 : ${MOHIST_BUILD:=lastSuccessfulBuild}
 
-mohistJobs=https://ci.codemc.io/job/Mohist-Community/job/
+mohistJobs=https://ci.codemc.io/job/MohistMC/job/
 mohistJob=${mohistJobs}Mohist-${VANILLA_VERSION}/
 
 if ! curl -X HEAD -o /dev/null -fsSL "${mohistJob}"; then
   log "ERROR: mohist builds do not exist for ${VANILLA_VERSION}"
-  log "       check https://ci.codemc.io/job/Mohist-Community/ for available versions"
+  log "       check https://ci.codemc.io/job/MohistMC/ for available versions"
   log "       and set VERSION accordingly"
   exit 1
 fi
@@ -26,7 +26,7 @@ buildRelPath=$(
 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"
+  log "       check https://ci.codemc.io/job/MohistMC/ for available versions"
   log "       and set VERSION accordingly"
   exit 1
 fi

start-deployPurpur

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

start-deployTuinity

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

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
-  remove_mods_dest="/data/mods"
-  case ${TYPE} in
-    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
+if isTrue ${REMOVE_OLD_MODS:-false}; then
+  removeOldMods /data/mods
+  removeOldMods /data/plugins
 fi
 
 # If supplied with a URL for a modpack (simple zip of jars), download it and unpack
@@ -37,35 +25,39 @@ 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"
       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 $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 $downloadUrl"
-      fi
+  elif [[ "$MODPACK" =~ .*\.zip ]]; then
+    if ! cp $MODPACK /tmp/modpack.zip; then
+      log "ERROR: failed to copy from $MODPACK"
+      exit 2
     fi
-    rm -f /tmp/modpack.zip
-
   else
-    log "ERROR Invalid URL given for MODPACK: $MODPACK"
+    log "ERROR Invalid URL or Path given for MODPACK: $MODPACK"
     exit 1
   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 $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 $downloadUrl"
+    fi
+  fi
+  rm -f /tmp/modpack.zip
 fi
 
 # If supplied with a URL for a plugin download it.
@@ -99,8 +91,18 @@ if [[ "$MODS" ]]; then
           exit 2
         fi
       fi
+    elif [[ -f "$i" && "$i" =~ .*\.jar ]]; then
+      log "Copying plugin located at $i ..."
+      out_file=$(basename "$i")
+      if ! cp "$i" "${out_dir}/$out_file"; then
+        log "ERROR: failed to copy from $i into $out_dir"
+        exit 2
+      fi
+    elif [[ -d "$i" ]]; then
+      log "Copying plugin jars from $i ..."
+      cp "$i"/*.jar "${out_dir}"
     else
-      log "ERROR Invalid URL given in MODS: $i"
+      log "ERROR Invalid URL or path given in MODS: $i"
       exit 2
     fi
   done

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
-  rsync -a --out-format="update:%f:Last Modified %M" "${rsyncArgs[@]}" --prune-empty-dirs --update /mods /data
+  mkdir -p $COPY_MODS_DEST
+  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
-  export SERVER_PROPERTIES=${FTB_DIR}/server.properties
+if [[ ${TYPE} == "CURSEFORGE" ]]; then
+  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

@@ -180,7 +180,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} == "FEED-THE-BEAST" && "${SERVER}" ]]; then
+elif [[ ${TYPE} == "CURSEFORGE" && "${SERVER}" ]]; then
   copyFilesForCurseForge
 
   cd "${FTB_DIR}"
@@ -189,7 +189,7 @@ elif [[ ${TYPE} == "FEED-THE-BEAST" && "${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} == "FEED-THE-BEAST" ]]; then
+elif [[ ${TYPE} == "CURSEFORGE" ]]; then
   mcServerRunnerArgs="${mcServerRunnerArgs} --shell bash"
 
   copyFilesForCurseForge
@@ -212,6 +212,11 @@ EOF
     "${FTB_SERVER_START}"
   )
 
+  if isTrue ${SETUP_ONLY:=false}; then
+    echo "SETUP_ONLY: ${finalArgs[@]}"
+    exit
+  fi
+
   if isTrue ${DEBUG_EXEC}; then
     set -x
   fi
@@ -236,6 +241,11 @@ else
     "$@" $EXTRA_ARGS
   )
 
+  if isTrue ${SETUP_ONLY:=false}; then
+    echo "SETUP_ONLY: java ${finalArgs[@]}"
+    exit
+  fi
+
   if isTrue ${DEBUG_EXEC}; then
     set -x
   fi
@@ -246,3 +256,4 @@ else
     exec mc-server-runner ${bootstrapArgs} ${mcServerRunnerArgs} java "${finalArgs[@]}"
   fi
 fi
+

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}"
-  for resource in "${resources[@]}"
-  do
+  IFS=',' read -r -a resources <<<"${SPIGET_RESOURCES}"
+  for resource in "${resources[@]}"; 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
+}

tests/docker-compose.test.yml

@@ -10,6 +10,9 @@ services:
     restart: "no"
     build:
       context: ..
+      args:
+        TARGETOS: linux
+        TARGETARCH: amd64
       cache_from:
       - itzg/minecraft-server:latest
     environment: