Clarify in docs to not port forward RCON unless secure (#2004)

This reverts commit 3624dc02a3.

.github/ISSUE_TEMPLATE/bug.yml

@@ -10,9 +10,9 @@ body:
         Thanks for taking the time to report a bug.
         
         Please double check some things first:
-        - Do you just have a question about something? If so, asking in the [Q&A Discussions](https://github.com/itzg/docker-minecraft-server/discussions/categories/q-a) or asking on [the Discord server](https://discord.gg/DXfKpjB) would be best.
-        - Is this bug happening after the `[init]` prefixed logs and after the log that says "Starting the Minecraft server"? If so, please report the bug with Mojang or the respective server provider.
-        - Are you seeing a performance problem? If so, that is typically outside the scope of the image setup mechanims. Ask a question as above or contact the respective server provider.
+        1. Do you just have a question about something? If so, asking in the [Q&A Discussions](https://github.com/itzg/docker-minecraft-server/discussions/categories/q-a) or asking on [the Discord server](https://discord.gg/DXfKpjB) would be best.
+        2. Is this bug happening after the `[init]` prefixed logs and after the log that says "Starting the Minecraft server"? If so, please report the bug with Mojang or the respective server provider.
+        3. Are you seeing a performance problem? If so, that is typically outside the scope of the image setup mechanims. Ask a question as above or contact the respective server provider.
   - type: textarea
     id: problem
     attributes:

.github/release.yml

@@ -2,3 +2,16 @@ changelog:
   exclude:
     authors:
       - dependabot
+  categories:
+    - title: Enhancements
+      labels:
+        - enhancement
+    - title: Bug Fixes
+      labels:
+        - bug
+    - title: Documentation
+      labels:
+        - documentation
+    - title: Other Changes
+      labels:
+        - "*"

.github/workflows/build-multiarch.yml

@@ -16,7 +16,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
+        # NOTE: the "latest" variant is identified in the Docker meta step's 'latest' config
         variant:
+          - java19
           - java17
           - java17-graalvm-ce
           - java17-jdk
@@ -31,6 +33,11 @@ jobs:
           - java11-openj9
           - java11-jdk
         include:
+        # JAVA 19:
+          - variant: java19
+            baseImage: eclipse-temurin:19-jre-jammy
+            platforms: linux/amd64,linux/arm/v7,linux/arm64
+            mcVersion: 1.19.3
         # JAVA 17:
           - variant: java17
             # jammy doesn't work until minecraft updates to https://github.com/netty/netty/issues/12343
@@ -77,7 +84,7 @@ jobs:
             mcVersion: 1.12.2
           - variant: java8-multiarch
             baseImage: eclipse-temurin:8u312-b07-jre-focal
-            platforms: linux/amd64,linux/arm64
+            platforms: linux/amd64,linux/arm/v7,linux/arm64
             mcVersion: 1.12.2
           - variant: java8-jdk
             baseImage: eclipse-temurin:8u312-b07-jdk-focal
@@ -110,6 +117,8 @@ jobs:
             type=ref,event=tag,enable=${{ matrix.variant == 'java17' }}
             type=ref,event=tag,suffix=-${{ matrix.variant }}
             type=raw,value=${{ matrix.variant }}
+          # NOTE this identifies which variant will be published as "latest", which isn't
+          # necessarily the newest version of Java
           flavor: |
             latest=${{ matrix.variant == 'java17' }}
           labels: |
@@ -119,10 +128,10 @@ jobs:
         uses: docker/setup-buildx-action@v2
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2.0.0
+        uses: docker/setup-qemu-action@v2.1.0
 
       - name: Build for test
-        uses: docker/build-push-action@v3.1.1
+        uses: docker/build-push-action@v3.3.0
         with:
           platforms: linux/amd64
           tags: ${{ env.IMAGE_TO_TEST }}
@@ -152,7 +161,7 @@ jobs:
           password: ${{ secrets.DOCKER_PASSWORD }}
 
       - name: Build and push
-        uses: docker/build-push-action@v3.1.1
+        uses: docker/build-push-action@v3.3.0
         if: github.actor == github.repository_owner
         with:
           platforms: ${{ matrix.platforms }}
@@ -169,6 +178,9 @@ jobs:
           # ensure latest base image is used
           pull: true
           labels: ${{ steps.meta.outputs.labels }}
+          # Since some consumers, like Watchtower are broken https://github.com/containrrr/watchtower/discussions/1529
+          # Also refer to https://github.com/docker/build-push-action/releases/tag/v3.3.0
+          provenance: false
           build-args: |
             BASE_IMAGE=${{ matrix.baseImage }}
             BUILD_FILES_REV=${{ steps.build-files-rev.outputs.REV }}

.github/workflows/stale-check.yml

@@ -12,7 +12,7 @@ jobs:
       pull-requests: write
     steps:
       - name: Process Stale Issues
-        uses: actions/stale@v5
+        uses: actions/stale@v7
         with:
           stale-issue-label: status/stale
           stale-pr-label: status/stale

.github/workflows/verify-pr.yml

@@ -16,17 +16,22 @@ jobs:
         variant:
           - java17
           - java17-alpine
+          - java8-multiarch
         include:
         # JAVA 17:
           - variant: java17
             # jammy doesn't work until minecraft updates to https://github.com/netty/netty/issues/12343
             baseImage: eclipse-temurin:17-jre-focal
-            platforms: linux/amd64,linux/arm/v7,linux/arm64
+            platforms: linux/amd64
             mcVersion: 1.18.2
           - variant: java17-alpine
             baseImage: eclipse-temurin:17-jre-alpine
             platforms: linux/amd64
             mcVersion: 1.18.2
+          - variant: java8-multiarch
+            baseImage: eclipse-temurin:8u312-b07-jre-focal
+            platforms: linux/amd64
+            mcVersion: 1.12.2
     env:
       IMAGE_TO_TEST: ${{ github.repository_owner }}/minecraft-server:test-${{ matrix.variant }}-${{ github.run_id }}
     runs-on: ubuntu-20.04
@@ -41,7 +46,7 @@ jobs:
         uses: docker/setup-buildx-action@v2
 
       - name: Build for test
-        uses: docker/build-push-action@v3.1.1
+        uses: docker/build-push-action@v3.3.0
         with:
           platforms: linux/amd64
           tags: ${{ env.IMAGE_TO_TEST }}
@@ -59,5 +64,6 @@ jobs:
           MINECRAFT_VERSION: ${{ matrix.mcVersion }}
           VARIANT: ${{ matrix.variant }}
           MODS_FORGEAPI_KEY: ${{ secrets.MODS_FORGEAPI_KEY }}
+          DEBUG: ${{ runner.debug }}
         run: |
           tests/test.sh

Dockerfile

@@ -14,7 +14,7 @@ RUN --mount=target=/build,source=build \
 
 COPY --chmod=644 files/sudoers* /etc/sudoers.d
 
-EXPOSE 25565 25575
+EXPOSE 25565
 
 # hook into docker BuildKit --platform support
 # see https://docs.docker.com/engine/reference/builder/#automatic-platform-args-in-the-global-scope
@@ -31,23 +31,23 @@ RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
   --from https://github.com/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
 RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
-  --var version=1.6.0 --var app=rcon-cli --file {{.app}} \
+  --var version=1.6.1 --var app=rcon-cli --file {{.app}} \
   --from https://github.com/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
 RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
-  --var version=0.10.3 --var app=mc-monitor --file {{.app}} \
+  --var version=0.11.0 --var app=mc-monitor --file {{.app}} \
   --from https://github.com/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
 RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
-  --var version=1.8.1 --var app=mc-server-runner --file {{.app}} \
+  --var version=1.8.3 --var app=mc-server-runner --file {{.app}} \
   --from https://github.com/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
 RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
   --var version=0.1.1 --var app=maven-metadata-release --file {{.app}} \
   --from https://github.com/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
-ARG MC_HELPER_VERSION=1.20.3
-ARG MC_HELPER_BASE_URL=https://github.com/itzg/mc-image-helper/releases/download/v${MC_HELPER_VERSION}
+ARG MC_HELPER_VERSION=1.25.11
+ARG MC_HELPER_BASE_URL=https://github.com/itzg/mc-image-helper/releases/download/${MC_HELPER_VERSION}
 RUN curl -fsSL ${MC_HELPER_BASE_URL}/mc-image-helper-${MC_HELPER_VERSION}.tgz \
   | tar -C /usr/share -zxf - \
   && ln -s /usr/share/mc-image-helper-${MC_HELPER_VERSION}/bin/mc-image-helper /usr/bin
@@ -63,13 +63,12 @@ ENV TYPE=VANILLA VERSION=LATEST EULA="" UID=1000 GID=1000 RCON_PASSWORD=minecraf
 COPY --chmod=755 scripts/start* /
 COPY --chmod=755 bin/ /usr/local/bin/
 COPY --chmod=755 bin/mc-health /health.sh
-COPY --chmod=644 files/server.properties /tmp/server.properties
-COPY --chmod=644 files/log4j2.xml /tmp/log4j2.xml
-COPY --chmod=755 files/autopause /autopause
-COPY --chmod=755 files/autostop /autostop
-COPY --chmod=755 files/rconcmds /rconcmds
+COPY --chmod=644 files/log4j2.xml /image/log4j2.xml
+# By default this file gets retrieved from repo, but bundle in image as potential fallback
+COPY --chmod=644 files/cf-exclude-include.json /image/cf-exclude-include.json
+COPY --chmod=755 files/auto /auto
 
-RUN dos2unix /start* /autopause/* /autostop/* /rconcmds/*
+RUN dos2unix /start* /auto/*
 
 ENTRYPOINT [ "/start" ]
 HEALTHCHECK --start-period=1m --interval=5s --retries=24 CMD mc-health

README.md

@@ -5,6 +5,8 @@
 [![Build and Publish](https://github.com/itzg/docker-minecraft-server/workflows/Build%20and%20Publish/badge.svg)](https://github.com/itzg/docker-minecraft-server/actions)
 [![](https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-orange.svg)](https://www.buymeacoffee.com/itzg)
 
+## Intro
+
 This docker image provides a Minecraft Server that will automatically download the latest stable
 version at startup. You can also run/upgrade to any specific version or the
 latest snapshot. See the _Versions_ section below for more information.
@@ -19,12 +21,10 @@ where, in this case, the standard server port 25565, will be exposed on your hos
 
 > Be sure to always include `-e EULA=TRUE` in your commands and container definitions, as Mojang/Microsoft requires EULA acceptance.
 
+> **DO NOT** port forward RCON on 25575 without first setting `RCON_PASSWORD` to a secure value. It is highly recommended to only use RCON within the container, such as with `rcon-cli`. 
+
 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. 
 
-## Mitigated Log4jShell Vulnerability
-
-**Please ensure you have pulled the latest image** since [all official mitigations](https://www.minecraft.net/en-us/article/important-message--security-vulnerability-java-edition) are automatically applied by the container startup process.
-
 ## Looking for a Bedrock Dedicated Server
 
 For Minecraft clients running on consoles, mobile, or native Windows, you'll need to
@@ -142,6 +142,16 @@ Now you can recreate the container with any environment variable changes, etc by
 docker run -d -it --name mc-new -v mc:/data -p 25565:25565 -e EULA=TRUE -e MEMORY=2G itzg/minecraft-server
 ```
 
+### Locating filesystem path of anonymous volume
+
+The `Source` field from the output of this command will show where the anonymous volume is mounted from:
+
+```shell
+docker inspect -f "{{json .Mounts}}" CONTAINER_NAME_OR_ID
+```
+
+> **NOTE** On Windows with WSL the volumes path is `\\wsl$\docker-desktop-data\data\docker\volumes`
+
 ## Versions
 
 To use a different Minecraft version, pass the `VERSION` environment variable (case sensitive), which can have the value
@@ -165,6 +175,8 @@ the server jar remain in the `/data` directory. It is safe to remove those._
 
 ## Running Minecraft server on different Java version
 
+> **For Forge versions less than 1.18, you _must_ use the `java8-multiarch` (or other java8) image tag.**
+
 When using the image `itzg/minecraft-server` without a tag, the `latest` image tag is implied from the table below. To use a different version of Java, please use an alternate tag to run your Minecraft server container.
 
 | Tag name          | Java version | Linux  | JVM Type    | Architecture      |
@@ -183,6 +195,7 @@ When using the image `itzg/minecraft-server` without a tag, the `latest` image t
 | java17-openj9     | 17           | Debian | OpenJ9      | amd64             |
 | java17-graalvm-ce | 17           | Oracle | GraalVM CE  | amd64,arm64       |
 | java17-alpine     | 17           | Alpine | Hotspot     | amd64             |
+| java19            | 19           | Ubuntu | Hotspot     | amd64,arm64,armv7 |
 
 For example, to use Java version 8 on any supported architecture:
 
@@ -324,11 +337,11 @@ To troubleshoot any issues with memory allocation reported by the JVM, set the e
 
 Enable [Forge server](http://www.minecraftforge.net/) 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`.
+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 `FORGE_VERSION`, such as `-e FORGE_VERSION=14.23.5.2854`.
 
     docker run -d -v /path/on/host:/data \
         -e TYPE=FORGE \
-        -e VERSION=1.12.2 -e FORGEVERSION=14.23.5.2854 \
+        -e VERSION=1.12.2 -e FORGE_VERSION=14.23.5.2854 \
         -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
 
 To use a pre-downloaded Forge installer, place it in the attached `/data` directory and
@@ -345,6 +358,8 @@ the URL with `FORGE_INSTALLER_URL`, such as:
 
 In both of the cases above, there is no need for the `VERSION` or `FORGEVERSION` variables.
 
+> If an error occurred while installing Forge, it might be possible to resolve by temporarily setting `FORGE_FORCE_REINSTALL` to "true". Be sure to remove that variable after successfully starting the server.
+
 ### Running a Fabric Server
 
 Enable [Fabric server](https://fabricmc.net/) mode by adding a `-e TYPE=FABRIC` to your command-line.
@@ -407,6 +422,8 @@ Enable Bukkit/Spigot server mode by adding a `-e TYPE=BUKKIT` or `-e TYPE=SPIGOT
         -e TYPE=SPIGOT \
         -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
 
+If the downloaded server jar is corrupted, set `FORCE_REDOWNLOAD` to "true" to force a re-download during next container startup. After successfully re-downloading, you should remove that or set to "false".
+
 If you are hosting your own copy of Bukkit/Spigot you can override the download URLs with:
 
 - -e BUKKIT_DOWNLOAD_URL=<url>
@@ -416,7 +433,7 @@ You can build spigot from source by adding `-e BUILD_FROM_SOURCE=true`
 
 Plugins can either be managed within the `plugins` subdirectory of the [data directory](#data-directory) or you can also [attach a `/plugins` volume](#optional-plugins-mods-and-config-attach-points). If you add plugins while the container is running, you'll need to restart it to pick those up.
 
-[You can also auto-download plugins using `SPIGET_RESOURCES`.](#auto-downloading-spigotmcbukkitpapermc-plugins)
+[You can also auto-download plugins using `SPIGET_RESOURCES`.](#auto-downloading-spigotmcbukkitpapermc-plugins-with-spiget)
 
 > 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.
 
@@ -434,7 +451,7 @@ If you are hosting your own copy of Paper you can override the download URL with
 
 If you have attached a host directory to the `/data` volume, then you can install plugins via the `plugins` subdirectory. You can also [attach a `/plugins` volume](#optional-plugins-mods-and-config-attach-points). If you add plugins while the container is running, you'll need to restart it to pick those up.
 
-[You can also auto-download plugins using `SPIGET_RESOURCES`.](#auto-downloading-spigotmcbukkitpapermc-plugins)
+[You can also auto-download plugins using `SPIGET_RESOURCES`.](#auto-downloading-spigotmcbukkitpapermc-plugins-with-spiget)
 
 ### Running a Pufferfish server
 
@@ -544,7 +561,10 @@ Configuration options with defaults:
 
 - `FORCE_REDOWNLOAD`=false
 - `LIMBO_SCHEMA_FILENAME`=default.schem
-- `LEVEL`="Default;${LIMBO_SCHEMA_FILENAME}"
+- `LEVEL`="Default;${LIMBO_SCHEMA
+
+
+NAME}"
 
 > NOTE: instead of using format codes in the MOTD, Limbo requires [JSON chat content](https://minecraft.fandom.com/wiki/Raw_JSON_text_format#Java_Edition). If a plain string is provided, which is the default, then it gets converted into the required JSON structure. 
 
@@ -560,13 +580,17 @@ Crucible is only available for 1.7.10, so be sure to set `VERSION=1.7.10`.
 
 ## 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).
+> **NOTE** requires one of the Ubuntu with Hotspot images listed in [the Java versions section](#running-minecraft-server-on-different-java-version).
 
 [Feed the Beast application](https://www.feed-the-beast.com/) modpacks are supported by using `-e TYPE=FTBA` (**note** the "A" at the end of the type). This server type will automatically take care of downloading and installing the modpack and appropriate version of Forge, so the `VERSION` does not need to be specified.
 
 ### Environment Variables:
-- `FTB_MODPACK_ID`: **required**, the numerical ID of the modpack to install. The ID can be located by [finding the modpack](https://www.feed-the-beast.com/modpack) and hovering over the name of the modpack, [as shown here](docs/ftba-identifier-popup.png).
-- `FTB_MODPACK_VERSION_ID`: optional, the numerical Id of the version to install. If not specified, the latest version will be installed. The "Version ID" can be obtained by drilling into the Versions tab and hovering over the version name, [as shown here](docs/ftba-version-id-popup.png).
+- `FTB_MODPACK_ID`: **required**, the numerical ID of the modpack to install. The ID can be located by [finding the modpack](https://www.feed-the-beast.com/modpack) and locating the ID in this part of the URL:
+  ```
+  https://www.feed-the-beast.com/modpacks/23-ftb-infinity-evolved-17
+                                          ^^
+  ```
+- `FTB_MODPACK_VERSION_ID`: optional, the numerical ID of the version to install. If not specified, the latest version will be installed. The "Version ID" can be obtained by hovering over a server file entry and grabbing [this ID in the URL](docs/ftba-version-id-popup.png).
 
 ### Upgrading
 
@@ -587,6 +611,79 @@ docker run -d --name mc-ftb -e EULA=TRUE \
 
 ## Running a server with a CurseForge modpack
 
+### Auto CurseForge Management
+
+To manage a CurseForge modpack automatically with upgrade support, pinned or latest version tracking, set `TYPE` to "AUTO_CURSEFORGE". The appropriate mod loader (Forge / Fabric) version will be automatically installed as declared by the modpack. This mode will also take care of cleaning up unused files installed by previous versions of the modpack, but world data is never auto-removed.
+
+> **NOTES:**
+> Be sure to use the appropriate [image tag for the Java version compatible with the modpack](#running-minecraft-server-on-different-java-version).
+> 
+> Most modpacks require a good amount of memory, so it best to set `MEMORY` to at least "4G" since the default is only 1 GB.
+
+Use one of the following to specify the modpack to install:
+
+Pass a page URL to the modpack or a specific file with `CF_PAGE_URL` such as the modpack page "https://www.curseforge.com/minecraft/modpacks/all-the-mods-8" or a specific file "https://www.curseforge.com/minecraft/modpacks/all-the-mods-8/files/4248390". For example:
+
+```
+-e TYPE=AUTO_CURSEFORGE -e CF_PAGE_URL=https://www.curseforge.com/minecraft/modpacks/all-the-mods-8
+```
+
+Instead of a URL, the modpack slug can be provided as `CF_SLUG`. The slug is the short identifier visible in the URL after "/modpacks/", such as
+
+![cf-slug](docs/cf-slug.png)
+
+For example:
+```
+-e TYPE=AUTO_CURSEFORGE -e CF_SLUG=all-the-mods-8
+```
+
+The latest file will be located and used by default, but if a specific version is desired you can use one of the following options. With any of these options **do not select a server file** -- they lack the required manifest and defeat the ability to consistently automate startup.
+
+- Use `CF_PAGE_URL`, but include the full URL to a specific file
+- Set `CF_FILE_ID` to the numerical file ID 
+- Specify a substring to match the desired filename with `CF_FILENAME_MATCHER`
+
+The following shows where to get the URL to the specific file and also shows where the file ID is located:
+
+![cf-file-id](docs/cf-file-id.png)
+
+The following examples all refer to version 1.0.7 of ATM8:
+
+```
+-e CF_PAGE_URL=https://www.curseforge.com/minecraft/modpacks/all-the-mods-8/files/4248390
+```
+
+```
+-e CF_SLUG=all-the-mods-8 -e CF_FILE_ID=4248390
+```
+
+```
+-e CF_SLUG=all-the-mods-8 -e CF_FILENAME_MATCHER=1.0.7
+```
+
+Quite often there are mods that need to be excluded, such as ones that did not properly declare as a client mod via the file's game versions. Similarly, there are some mods that are incorrectly tagged as client only. The following describes two options to exclude/include mods:
+
+Global and per modpack exclusions can be declared in a JSON file and referenced with `CF_EXCLUDE_INCLUDE_FILE`. By default, [the file bundled with the image](files/cf-exclude-include.json) will be used. The schema of this file [is documented here](https://github.com/itzg/mc-image-helper#excludeinclude-file-schema).
+
+Alternatively, they can be excluded by passing a comma or space delimited list of **project** slugs or IDs via `CF_EXCLUDE_MODS`. Similarly, there are some mods that are incorrectly tagged as client only. For those, pass the **project** slugs or IDs via `CF_FORCE_INCLUDE_MODS`. If either of these are set, then `CF_EXCLUDE_INCLUDE_FILE` will be **disabled**.
+
+A mod's project ID can be obtained from the right hand side of the project page:
+![cf-project-id](docs/cf-project-id.png)
+
+If needing to iterate on the options above, set `CF_FORCE_SYNCHRONIZE` to "true" to ensure the exclude/includes are re-evaluated.
+
+> **NOTE:** these options are provided to empower you to get your server up and running quickly. Please help out by reporting an issue with the respective mod project. Ideally mod developers should [use correct registrations for one-sided client mods](https://docs.minecraftforge.net/en/latest/concepts/sides/#writing-one-sided-mods). Understandably, those code changes may be non-trivial, so mod authors can also add "Client" to the game versions when publishing.
+
+Some modpacks come with world/save data via a worlds file and/or the overrides provided with the modpack. Either approach can be selected to set the `LEVEL` to the resulting saves directory by setting `CF_SET_LEVEL_FROM` to either:
+- `WORLD_FILE`
+- `OVERRIDES`
+
+Other configuration available:
+- `CF_PARALLEL_DOWNLOADS` (default is 4): specify how many parallel mod downloads to perform
+- `CF_OVERRIDES_SKIP_EXISTING` (default is false): if set, files in the overrides that already exist in the data directory are skipped. **NOTE** world data is always skipped, if present.
+
+### Old approach
+
 Enable this server mode by adding `-e TYPE=CURSEFORGE` to your command-line,
 but note the following additional steps needed...
 
@@ -650,13 +747,13 @@ packwiz modpack defitions are processed before other mod definitions (`MODPACK`,
 There are optional volume paths that can be attached to supply content to be copied into the data area:
 
 `/plugins`
-: contents are synchronized into `/data/plugins` for Bukkit related server types. Set `SYNC_SKIP_NEWER_IN_DESTINATION=false` if you want files from `/plugins` to take precedence over newer files in `/data/plugins`.
+: contents are synchronized into `/data/plugins` for Bukkit related server types. The source can be changed by setting `COPY_PLUGINS_SRC`. The destination can be changed by setting `COPY_PLUGINS_DEST`. Set `SYNC_SKIP_NEWER_IN_DESTINATION=false` if you want files from `/plugins` to take precedence over newer files in `/data/plugins`.
 
 `/mods`
-: contents are synchronized into `/data/mods` for Fabric and Forge related server types. The destination can be changed by setting `COPY_MODS_DEST`.
+: contents are synchronized into `/data/mods` for Fabric and Forge related server types. The source can be changed by setting `COPY_MODS_SRC`. The destination can be changed by setting `COPY_MODS_DEST`.
 
 `/config`
-: contents are synchronized into `/data/config` by default, but can be changed with `COPY_CONFIG_DEST`. 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. Set `SYNC_SKIP_NEWER_IN_DESTINATION=false` if you want files from `/config` to take precedence over newer files in `/data/config`.
+: contents are synchronized into `/data/config` by default, but can be changed with `COPY_CONFIG_DEST`. The source can be changed by setting `COPY_CONFIG_SRC`. 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. Set `SYNC_SKIP_NEWER_IN_DESTINATION=false` if you want files from `/config` to take precedence over newer files in `/data/config`.
 
 By default, the [environment variable processing](#replacing-variables-inside-configs) is performed on synchronized files that match the expected suffixes in `REPLACE_ENV_SUFFIXES` (by default "yml,yaml,txt,cfg,conf,properties,hjson,json,tml,toml") and are not excluded by `REPLACE_ENV_VARIABLES_EXCLUDES` and `REPLACE_ENV_VARIABLES_EXCLUDE_PATHS`. This processing can be disabled by setting `REPLACE_ENV_DURING_SYNC` to `false`.
 
@@ -670,7 +767,7 @@ These paths work well if you want to have a common set of modules in a separate
 
 > For more flexibility with mods/plugins preparation, you can declare directories to use in [the `MODS` variable](#downloadable-modplugin-pack-for-forge-fabric-and-bukkit-like-servers)
 
-### Auto-downloading SpigotMC/Bukkit/PaperMC plugins
+### Auto-downloading SpigotMC/Bukkit/PaperMC plugins with Spiget
 
 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.
 
@@ -696,6 +793,10 @@ For example, the following will auto-download the [EssentialsX](https://www.spig
                               |
                               +-- project slug
   ```
+  Also, specific version/type can be declared using colon symbol and version id/type after the project slug. The version id can be found at 'Metadata' section. Valid version types are `release`, `beta`, `alpha`. For instance:
+  ```
+    -e MODRINTH_PROJECTS=fabric-api,fabric-api:PbVeub96,fabric-api:beta
+  ```
 - **MODRINTH_DOWNLOAD_OPTIONAL_DEPENDENCIES**=true : required dependencies of the project will _always_ be downloaded and optional dependencies can also be downloaded by setting this to `true`
 - **MODRINTH_ALLOWED_VERSION_TYPE**=release : the version type is used to determine the newest version to use from each project. The allowed values are `release`, `beta`, `alpha`.
 
@@ -794,7 +895,9 @@ GENERIC_PACKS_SUFFIX=.zip
 
 would expand to `https://cdn.example.org/configs-v9.0.1.zip,https://cdn.example.org/mods-v4.3.6.zip`.
 
-If applying large generic packs, the update check can be time-consuming since a SHA1 checksum is compared. To skip the update check set `SKIP_GENERIC_PACK_UPDATE_CHECK` to "true". Conversely, the generic pack(s) can be forced to be applied without comparing the checksum by setting `FORCE_GENERIC_PACK_UPDATE` to "true".
+If applying large generic packs, the update can be time-consuming. To skip the update set `SKIP_GENERIC_PACK_UPDATE_CHECK` to "true". Conversely, the generic pack(s) can be forced to be applied by setting `FORCE_GENERIC_PACK_UPDATE` to "true".
+
+The most time consuming portion of the generic pack update is generating and comparing the SHA1 checksum. To skip the checksum generation, set `SKIP_GENERIC_PACK_CHECKSUM` to "true.
 
 ### Mod/Plugin URL Listing File 
 
@@ -869,12 +972,14 @@ docker run -d -e EXTRA_ARGS='--world-dir ./worlds/'
 
 ### Datapacks
 Datapacks can be installed in a similar manner to mods/plugins. There are many environment variables which function in the same way they do for [mods](#working-with-mods-and-plugins): 
-* `DATAPACKS`
-* `DATAPACKS_FILE` 
-* `REMOVE_OLD_DATAPACKS` 
-* `REMOVE_OLD_DATAPACKS_DEPTH` 
-* `REMOVE_OLD_DATAPACKS_INCLUDE`
-* `REMOVE_OLD_DATAPACKS_EXCLUDE`
+
+* `DATAPACKS`: comma-separated list of zip file URL, zip file in container, or directory in container
+* `DATAPACKS_FILE`: a text file within the container where each line is a zip file URL, zip file in container, or directory in container
+* `REMOVE_OLD_DATAPACKS`: if "true" the datapacks directory is removed of everything matching `REMOVE_OLD_DATAPACKS_INCLUDE`, but excluding `REMOVE_OLD_DATAPACKS_EXCLUDE` no deeper than `REMOVE_OLD_DATAPACKS_DEPTH`
+* `REMOVE_OLD_DATAPACKS_DEPTH`: default is 16
+* `REMOVE_OLD_DATAPACKS_INCLUDE`: default is `*.zip`
+* `REMOVE_OLD_DATAPACKS_EXCLUDE`: default is empty
+
 Datapacks will be placed in `/data/$LEVEL/datapacks`
 
 ### VanillaTweaks
@@ -953,13 +1058,7 @@ CraftingTweaks Json:
 
 By default, the server configuration will be created and set based on the following environment variables, but only the first time the server is started. If the `server.properties` file already exists, the values in them will not be changed.
 
-If you would like to override the server configuration each time the container starts up, you can set the `OVERRIDE_SERVER_PROPERTIES` environment variable like:
-
-    docker run -d -e OVERRIDE_SERVER_PROPERTIES=true ...
-
-This will reset any manual configuration of the `server.properties` file, so if you want to make any persistent configuration changes you will need to make sure you have properly set the proper environment variables in your container configuration.
-
-In the opposite case, you can skip the startup script's creation of `server.properties`, by setting `SKIP_SERVER_PROPERTIES` to "true".
+If you prefer to manually manage the `server.properties` file, set `OVERRIDE_SERVER_PROPERTIES` to "false". Similarly, you can entirely skip the startup script's creation of `server.properties` by setting `SKIP_SERVER_PROPERTIES` to "true".
 
 > NOTE: to clear a server property, set the variable to an empty string, such as `-e RESOURCE_PACK=""`. A variables that maps to a server property that is unset, is ignored and the existing `server.property` is left unchanged. 
 
@@ -983,6 +1082,10 @@ renders
 
 ![](docs/motd-example.png)
 
+To produce a multi-line MOTD, you will need to double escape the newline such as
+
+    -e MOTD="Line one\\nLine two"
+
 ### Difficulty
 
 The difficulty level (default: `easy`) can be set like:
@@ -998,12 +1101,12 @@ values.
 > **NOTE** it is very important to set this with servers exposed to the internet where you want only limited players to join.
 
 To whitelist players for your Minecraft server, you can:
-- Provide the url or path to a whitelist file via `WHITELIST_FILE` environment variable  
-    `docker run -d -e WHITELIST_FILE=/extra/whitelist.json ...`
 - Provide a list of usernames and/or UUIDs separated by commas via the `WHITELIST` environment variable  
-    `docker run -d -e WHITELIST=user1,uuid2 ...`
+  `docker run -d -e WHITELIST=user1,uuid2 ...`
+- Provide the url or path to a whitelist file via `WHITELIST_FILE` environment variable  
+  `docker run -d -e WHITELIST_FILE=/extra/whitelist.json ...`
 
-To enforce the whitelist and auto-kick players not included in whitelist configuration, set `ENFORCE_WHITELIST=TRUE`. **By default** any user can join your Minecraft server if it's publicly accessible, regardless of your whitelist configuration.
+When either is set, [whitelisting of connecting users](https://minecraft.fandom.com/wiki/Server.properties#white-list) is enabled . If managing the list manually, `ENABLE_WHITELIST` can be set to "true" to set the `white-list` property.
 
 If whitelist configuration already exists, `WHITELIST_FILE` will not be retrieved and any usernames in `WHITELIST` are **added** to the whitelist configuration. You can enforce regeneration of the whitelist on each server startup by setting `OVERRIDE_WHITELIST` to "true". This will delete the whitelist file before processing whitelist configuration.
 
@@ -1013,7 +1116,7 @@ If whitelist configuration already exists, `WHITELIST_FILE` will not be retrieve
 
 > If running Minecraft 1.7.5 or earlier, these variables will apply to `white-list.txt`, with 1.7.6 implementing support for `whitelist.json`. Make sure your `WHITELIST_FILE` is in the appropriate format.
 
-If either `WHITELIST_FILE` or `WHITELIST` is provided, the server property `white-list` is automatically set to `true`, enabline whitelist functionality. Alternatively you can set `ENABLE_WHITELIST=TRUE` to only set the server property `white-list` without modifying the whitelist file. In this case the whitelist can be managed using the `whitelist add` and `whitelist remove` commands. Remember you can set enforcement via the `ENFORCE_WHITELIST` variable.
+To [enforce the whitelist changes immediately](https://minecraft.fandom.com/wiki/Server.properties#enforce-whitelist) when whitelist commands are used , set `ENFORCE_WHITELIST` to "true".
 
 ### Op/Administrator Players
 
@@ -1027,6 +1130,14 @@ If ops configuration already exists, `OPS_FILE` will not be retrieved and any us
 
 > Similar to whitelists, you can provide both `OPS_FILE` and `OPS`, and Minecraft 1.7.5 or earlier will use `ops.txt` rather than `ops.json`.
 
+### Enable/disable initial selection of datapacks
+
+New to [22W42A](https://www.minecraft.net/en-us/article/minecraft-snapshot-22w42a), datapacks with feature flags can be controlled before initial world creation by setting these to a comma separated list of packs:
+
+- `INITIAL_ENABLED_PACKS`
+  such as "update_1_20,bundle"
+- `INITIAL_DISABLED_PACKS`
+
 ### Server icon
 
 A server icon can be configured using the `ICON` variable. The image will be automatically
@@ -1038,13 +1149,17 @@ The server icon which has been set doesn't get overridden by default. It can be
 
     docker run -d -e ICON=http://..../some/other/image.png -e OVERRIDE_ICON=TRUE...
 
-### Rcon
+### RCON
 
-To use rcon use the `ENABLE_RCON` and `RCON_PASSWORD` variables.
-The default RCON password is _"minecraft",_ but it's **highly** recommended to override that.
-By default rcon port will be `25575` but can easily be changed with the `RCON_PORT` variable.
+RCON is **enabled by default** to allow for graceful shut down the server and coordination of save state during backups. RCON can be disabled by setting `ENABLE_RCON` to "false".
 
-    docker run -d -e ENABLE_RCON=true -e RCON_PASSWORD=testing
+The default password is "minecraft" but **change the password before deploying into production** by setting `RCON_PASSWORD`.
+
+**DO NOT MAP THE RCON PORT EXTERNALLY** unless you aware of all the consequences and have set a **secure password** with `RCON_PASSWORD`. 
+
+> Mapping ports (`-p` command line or `ports` in compose) outside the container and docker networking needs to be a purposeful choice. Most production Docker deployments do not need any of the Minecraft ports mapped externally from the server itself.
+
+By default, the server listens for RCON on port 25575 within the container. It can be changed with `RCON_PORT` but only do this if you have a very good reason. **DO NOT change `rcon.port` via `server.properties`** or integrations will break.
 
 ### Query
 
@@ -1285,7 +1400,27 @@ Variables that you want to replace need to be declared inside curly brackets and
 
 You can also change `REPLACE_ENV_VARIABLE_PREFIX`, which defaults to "CFG_", to limit which environment variables are allowed to be used. For example, with "CFG_" as the prefix, the variable `${CFG_DB_HOST}` would be subsituted, but not `${DB_HOST}`.
 
-If you want to use a file for value (like when use secrets) you can add suffix `_FILE` to your variable name.
+If you want to use a file's content for value, such as when using secrets mounted as files, declare the placeholder named like normal in the file and declare an environment variable named the same but with the suffix `_FILE`. 
+
+For example, a `my.cnf` file could contain:
+
+```
+[client]
+password = ${CFG_DB_PASSWORD}
+```
+
+...a secret declared in the compose file with:
+```yaml
+secrets:
+  db_password:
+    external: true
+```
+
+...and finally the environment variable would be named with a `_FILE` suffix and point to the mounted secret:
+```yaml
+    environment:
+      CFG_DB_PASSWORD_FILE: /run/secrets/db_password
+```
 
 Variables will be replaced in files with the following extensions:
 `.yml`, `.yaml`, `.txt`, `.cfg`, `.conf`, `.properties`.
@@ -1443,15 +1578,47 @@ To let the JVM calculate the heap size from the container declared memory limit,
 
 General JVM options can be passed to the Minecraft Server invocation by passing a `JVM_OPTS`
 environment variable. The JVM requires `-XX` options to precede `-X` options, so those can be declared in `JVM_XX_OPTS`. Both variables are space-delimited, raw JVM arguments.
+
 ```
--e JVM_OPTS="-someJVMOption someJVMOptionValue"
+docker run ... -e JVM_OPTS="-someJVMOption someJVMOptionValue" ...
 ```
 
-For some cases, if e.g. after removing mods, it could be necessary to startup minecraft with an additional `-D` parameter like `-Dfml.queryResult=confirm`. To address this you can use the environment variable `JVM_DD_OPTS`, which builds the params from a given list of values separated by space, but without the `-D` prefix. To make things running under systems (e.g. Plesk), which doesn't allow `=` inside values, a `:` (colon) could be used instead. The upper example would look like this:
-`JVM_DD_OPTS=fml.queryResult:confirm`, and will be converted to `-Dfml.queryResult=confirm`.
+**NOTE** When declaring `JVM_OPTS` in a compose file's `environment` section with list syntax, **do not** include the quotes:
+
+```yaml
+    environment:
+      - EULA=true
+      - JVM_OPTS=-someJVMOption someJVMOptionValue 
+```
+
+Using object syntax is recommended and more intuitive:
+
+```yaml
+    environment:
+      EULA: "true"
+      JVM_OPTS: "-someJVMOption someJVMOptionValue"
+# or
+#     JVM_OPTS: -someJVMOption someJVMOptionValue
+```
+
+As a shorthand for passing several system properties as `-D` arguments, you can instead pass a comma separated list of `name=value` or `name:value` pairs with `JVM_DD_OPTS`. (The colon syntax is provided for management platforms like Plesk that don't allow `=` inside a value.)
+
+For example, instead of passing
+
+```yaml
+  JVM_OPTS: -Dfml.queryResult=confirm -Dname=value
+```
+
+you can use
+
+```yaml
+  JVM_DD_OPTS: fml.queryResult=confirm,name=value
+```
+
+### Extra Arguments
+
+Arguments that would usually be passed to the jar file (those which are written after the filename) can be passed via the `EXTRA_ARGS` environment variable.
 
-### Jarfile Options
-Options that would usually be passed to the jar file (those which are written after the filename) can be passed via the `EXTRA_ARGS` environment variable.
 See [Custom worlds directory path](#custom-worlds-directory-path) for an example.
 
 ### Interactive and Color Console
@@ -1525,7 +1692,7 @@ To enable remote JMX, such as for profiling with VisualVM or JMC, add the enviro
 
 ### Enable Aikar's Flags
 
-[Aikar has does some research](https://aikar.co/2018/07/02/tuning-the-jvm-g1gc-garbage-collector-flags-for-minecraft/) into finding the optimal JVM flags for GC tuning, which becomes more important as more users are connected concurrently. The set of flags documented there can be added using
+[Aikar has done some research](https://aikar.co/2018/07/02/tuning-the-jvm-g1gc-garbage-collector-flags-for-minecraft/) into finding the optimal JVM flags for GC tuning, which becomes more important as more users are connected concurrently. The set of flags documented there can be added using
 
     -e USE_AIKAR_FLAGS=true
 
@@ -1673,6 +1840,8 @@ On startup the `server.properties` file is checked and, if applicable, a warning
 
 The utility used to wake the server (`knock(d)`) works at network interface level. So the correct interface has to be set using the `AUTOPAUSE_KNOCK_INTERFACE` variable when using non-default networking environments (e.g. host-networking, Portainer oder NAS solutions). See the description of the variable below.
 
+A file called `.paused` is created in `/data` directory when the server is paused and removed when the server is resumed. Other services may check for this file's existence before waking the server.
+
 A starting, example compose file has been provided in [examples/docker-compose-autopause.yml](examples/docker-compose-autopause.yml).
 
 ### Enabling Autopause
@@ -1733,6 +1902,10 @@ To run this image on a RaspberryPi 3 B+, 4, or newer, use any of the image tags
 
 > If experiencing issues such as "sleep: cannot read realtime clock: Operation not permitted", ensure `libseccomp` is up to date on your host. In some cases adding `:Z` flag to the `/data` mount may be needed, [but use cautiously](https://docs.docker.com/storage/bind-mounts/#configure-the-selinux-label).
 
+## Mitigated Log4jShell Vulnerability
+
+**Please ensure you have pulled the latest image** since [all official mitigations](https://www.minecraft.net/en-us/article/important-message--security-vulnerability-java-edition) are automatically applied by the container startup process.
+
 ## Contributing
     
 See [Development](DEVELOPMENT.md) and [Building](BUILDING.md).

bin/rcon-cmds-daemon.sh

@@ -8,8 +8,8 @@
 : "${RCON_CMDS_PERIOD:=10}"
 
 # needed for the clients connected function residing in autopause
-# shellcheck source=/autopause/autopause-fcns.sh
-. /autopause/autopause-fcns.sh
+# shellcheck source=../auto/autopause-fcns.sh
+. /auto/autopause-fcns.sh
 
 # shellcheck source=start-utils
 . ${SCRIPTS:-/}start-utils

build/alpine/install-packages.sh

@@ -23,4 +23,5 @@ apk add --no-cache -U \
     sudo \
     knock \
     tar \
-    zstd
+    zstd \
+    nfs-utils

build/ubuntu/install-packages.sh

@@ -23,6 +23,7 @@ apt-get install -y \
   unzip \
   zstd \
   lbzip2 \
-  knockd
+  knockd \
+  nfs-common
 
 apt-get clean

docs/.gitignore

@@ -0,0 +1 @@
+/.*.bkp

examples/.gitignore

@@ -1 +1,2 @@
-/data/
+data/
+modpacks/

examples/atm8/docker-compose.yml

@@ -0,0 +1,18 @@
+version: "3.8"
+
+services:
+  mc:
+    image: itzg/minecraft-server
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: "true"
+      TYPE: AUTO_CURSEFORGE
+      CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-the-mods-8
+      CF_FILENAME_MATCHER: "1.0.6"
+      MEMORY: 4G
+    volumes:
+      - mc-data:/data
+
+volumes:
+  mc-data: {}

examples/docker-compose-curseforge-atm7.yaml

@@ -0,0 +1,150 @@
+version: '3.8'
+
+####################################################################
+#                         CURSEFORGE                               #
+#                                                                  #
+# Date: 20221005                                                   #
+#                                                                  #
+# Mod: All The Mods 7 0.4.32                                       #
+#                                                                  #
+# Notes: Verify that there is no EULA file in the modpack.zip      #
+#        if you do not delete it the EULA flag below will be       #
+#        overwritten when the modpack is copied.                   #
+#                                                                  #
+####################################################################
+services:
+
+####################################################################
+#                         Service Name                             #
+#                                                                  #
+# Define Service Name here. If using RCON this name will be        #
+# referenced again as RWA_RCON_HOST below.                         #
+#                                                                  #
+# Example: 'name:' or 'mc_atm6:'                                   #
+####################################################################
+  mc_atm7:
+
+####################################################################
+#                      Image & Container Name                      #
+#                                                                  #
+# Specify Image Name and Java Version. The 'image' will always be  #
+# 'itzg/minecraft-server' however the tag added to the end is      #
+# where you can specify the java version or container architecture.#
+# See readme.md for a full list.                                   #
+#                                                                  #
+# 'container_name:' This can be anything you like. This is the name#
+# that will show when you run 'docker ps' commands.                #
+####################################################################
+    image: itzg/minecraft-server
+    container_name: mc_atm7
+
+####################################################################
+#                         Server Ports                             #
+#                                                                  #
+# Specify external port.                                           #
+####################################################################
+    ports:
+      - 25565:25565
+
+####################################################################
+#                   Automatic Server Restart                       #
+#                                                                  #
+# Define a restart policy here.                                    #
+#    - 'no' = Do not restart.                                      #
+#    - 'on-failure' = Restart if container exits because an error. #
+#    - 'always' = Regardless of stop reason.                       #
+#    - 'unless-stopped' = Similar to always except if stopped.     #
+####################################################################
+    restart: unless-stopped
+
+####################################################################
+#                     Volume and Folder Access                     #
+#                                                                  #
+# This section defines what folders and volumes you want to give   #
+# this container access to. It is recommended to leaves these set  #
+# to the default values unless you know what you are doing.        #
+#                                                                  #
+# Place your mod zip file in a folder called 'modpacks' in the     #
+# same directory you place this docker-compose file.               #
+#                                                                  #
+# Specify the data volume name or directory here as well.          #
+# In this example the volume name is 'data'. When docker creates   #
+# the volume it will add what ever name you give it here to the    #
+# end of the container name specified above. In this example it    #
+# would be named 'mc_atm6_data'. If you change this be sure to     #
+# update the volume name at the bottom of this config.             #
+####################################################################
+    volumes:
+      - ./modpacks:/modpacks:ro
+      - data:/data
+
+####################################################################
+#                             EULA                                 #
+#                                                                  #
+# Accept EULA by setting to "true"                                 #
+####################################################################
+    environment:
+      EULA: "true"
+
+####################################################################
+#                       CURSEFORGE INSTALL                         #
+#                                                                  #
+# Sets install type to FORGE and specifys the zip folder name      #
+# and location of your mod pack.                                   #
+#                                                                  #
+# TYPE: Defines the install type as CURSEFORGE                     #
+#                                                                  #
+# CF_SERVER_MOD: Define where the modpack.zip is located.          #
+#                                                                  #
+# Place your mod zip file in a folder called 'modpacks' in the     #
+# same directory you place this docker-compose file.               #
+####################################################################
+      TYPE: CURSEFORGE
+      CF_SERVER_MOD: /modpacks/ATM7-0.4.32-server.zip
+
+####################################################################
+#                          Server Memory                           #
+#                                                                  #
+# Set Maximum amount of memory allowed for your server.            #
+####################################################################
+      MEMORY: "8G"
+
+####################################################################
+#                         Logging Options                          #
+#                                                                  #
+# Set to "true" to delete old logs                                 #
+####################################################################
+      ENABLE_ROLLING_LOGS: "true"
+
+####################################################################
+#                          Server Timezone                         #
+#                                                                  #
+# Specify server Timezone                                          #
+####################################################################
+      TZ: "America/New_York"
+
+####################################################################
+#                       Minecraft Game Options                     #
+#                                                                  #
+# List any game options you want to define here. A full list can   #
+# be found on the readme.md page on github.                        #
+####################################################################
+      OVERRIDE_SERVER_PROPERTIES: "true"
+      DIFFICULTY: "easy"
+      MAX_TICK_TIME: "-1"
+      ALLOW_FLIGHT: "true"
+      OPS: ""
+      VIEW_DISTANCE: 10
+      MAX_PLAYERS: 10
+      PVP: "false"
+      LEVEL_TYPE: "biomesoplenty"
+      MOTD: "Welcome Home"
+
+####################################################################
+#                            Volumes                               #
+#                                                                  #
+# Define data volume name here. You should leave this set to the   #
+# default.                                                         #
+####################################################################
+volumes:
+  data:

examples/docker-compose-forge-bettermcplus

@@ -0,0 +1,161 @@
+version: '3.8'
+
+####################################################################
+#                       FORGE_GENERIC_PACK                         #
+#                                                                  #
+# Date: 20221005                                                   #
+#                                                                  #
+# Mod: Better Minecraft Plus v40                                   #
+#                                                                  #
+# Game Version: 1.16.5                                             #
+#                                                                  #
+# Notes: Verify that there is no EULA file in the modpack.zip      #
+#        if you do not delete it the EULA flag below will be       #
+#        overwritten when the modpack is copied.                   #
+#                                                                  #
+####################################################################
+services:
+
+####################################################################
+#                         Service Name                             #
+#                                                                  #
+# Define Service Name here. If using RCON this name will be        #
+# referenced again as RWA_RCON_HOST below.                         #
+#                                                                  #
+# Example: 'name:' or 'mc_atm6:'                                   #
+####################################################################
+  mc_bmp:
+
+####################################################################
+#                      Image & Container Name                      #
+#                                                                  #
+# Specify Image Name and Java Version. The 'image' will always be  #
+# 'itzg/minecraft-server' however the tag added to the end is      #
+# where you can specify the java version or container architecture.#
+# See readme.md for a full list.                                   #
+#                                                                  #
+# 'container_name:' This can be anything you like. This is the name#
+# that will show when you run 'docker ps' commands.                #
+####################################################################
+    image: itzg/minecraft-server:java8
+    container_name: mc_bmp
+
+####################################################################
+#                         Server Ports                             #
+#                                                                  #
+# Specify external port.                                           #
+####################################################################
+    ports:
+      - 25565:25565
+
+####################################################################
+#                   Automatic Server Restart                       #
+#                                                                  #
+# Define a restart policy here.                                    #
+#    - 'no' = Do not restart.                                      #
+#    - 'on-failure' = Restart if container exits because an error. #
+#    - 'always' = Regardless of stop reason.                       #
+#    - 'unless-stopped' = Similar to always except if stopped.     #
+####################################################################
+    restart: unless-stopped
+
+####################################################################
+#                     Volume and Folder Access                     #
+#                                                                  #
+# This section defines what folders and volumes you want to give   #
+# this container access to. It is recommended to leaves these set  #
+# to the default values unless you know what you are doing.        #
+#                                                                  #
+# Place your mod zip file in a folder called 'modpacks' in the     #
+# same directory you place this docker-compose file.               #
+#                                                                  #
+# Specify the data volume name or directory here as well.          #
+# In this example the volume name is 'data'. When docker creates   #
+# the volume it will add what ever name you give it here to the    #
+# end of the container name specified above. In this example it    #
+# would be named 'mc_atm6_data'. If you change this be sure to     #
+# update the volume name at the bottom of this config.             #
+####################################################################
+    volumes:
+      - ./modpacks:/modpacks:ro
+      - data:/data
+
+####################################################################
+#                             EULA                                 #
+#                                                                  #
+# Accept EULA by setting to "true"                                 #
+####################################################################
+    environment:
+      EULA: "true"
+
+####################################################################
+#                          FORGE INSTALL                           #
+#                                                                  #
+# Sets install type to FORGE and specifys the zip folder name      #
+# and location of your mod pack.                                   #
+#                                                                  #
+# TYPE: Defines the install type as FORGE                          #
+#                                                                  #
+# VERSION: Defines the version of MC the modpack is based on.      #
+#                                                                  #
+# FORGE_VERSION: Defines the version of FORGE the modpack uses.     #
+#               This can usually be found in the modpack.zip as    #
+#               installer.jar                                      #
+#                                                                  #
+# GENERIC_PACK: Define where the modpack.zip is located.           #
+#                                                                  #
+# Place your mod zip file in a folder called 'modpacks' in the     #
+# same directory you place this docker-compose file.               #
+####################################################################
+      TYPE: FORGE
+      VERSION: 1.16.5
+      FORGE_VERSION: 36.2.39
+      GENERIC_PACK: /modpacks/Better+MC+Server+Pack+PLUS+1.16.5+v40+HF.zip
+
+####################################################################
+#                          Server Memory                           #
+#                                                                  #
+# Set Maximum amount of memory allowed for your server.            #
+####################################################################
+      MEMORY: "8G"
+
+####################################################################
+#                         Logging Options                          #
+#                                                                  #
+# Set to "true" to delete old logs                                 #
+####################################################################
+      ENABLE_ROLLING_LOGS: "true"
+
+####################################################################
+#                          Server Timezone                         #
+#                                                                  #
+# Specify server Timezone                                          #
+####################################################################
+      TZ: "America/New_York"
+
+####################################################################
+#                       Minecraft Game Options                     #
+#                                                                  #
+# List any game options you want to define here. A full list can   #
+# be found on the readme.md page on github.                        #
+####################################################################
+      OVERRIDE_SERVER_PROPERTIES: "true"
+      DIFFICULTY: "easy"
+      MAX_TICK_TIME: "-1"
+      VIEW_DISTANCE: "6"
+      ALLOW_FLIGHT: "true"
+      OPS: ""
+      VIEW_DISTANCE: 10
+      MAX_PLAYERS: 10
+      PVP: "false"
+      LEVEL_TYPE: "biomesoplenty"
+      MOTD: "Welcome Home"
+
+####################################################################
+#                            Volumes                               #
+#                                                                  #
+# Define data volume name here. You should leave this set to the   #
+# default.                                                         #
+####################################################################
+volumes:
+  data:

examples/docker-compose-generic-pack-atm7.yml

@@ -1,19 +0,0 @@
-version: '3.8'
-
-services:
-  mc:
-    image: itzg/minecraft-server
-    volumes:
-    - ./data:/data
-    - ./modpacks:/modpacks:ro
-    environment:
-      EULA: "true"
-      MEMORY: 2G
-      TYPE: FORGE
-      VERSION: 1.18.2
-      FORGEVERSION: 40.1.30
-      # Need to download Server-Files-0.4.13.zip and
-      # put it in modpacks directory next to this compose file
-      GENERIC_PACK: /modpacks/Server-Files-0.4.13.zip
-    ports:
-      - "25565:25565"

examples/docker-compose-generic-pack-tnp5.yml

@@ -0,0 +1,159 @@
+version: '3.8'
+
+####################################################################
+#                         FORGE GENERIC_PACK                       #
+#                                                                  #
+# Date: 20220828                                                   #
+#                                                                  #
+# Mod: TNP Limitless 5 v2.19.0                                     #
+#                                                                  #
+# Notes: Verify that there is no EULA file in the modpack.zip      #
+#        if you do not delete it the EULA flag below will be       #
+#        overwritten when the modpack is copied and the server     #
+#        will not start.                                           #
+#                                                                  #
+####################################################################
+services:
+
+####################################################################
+#                         Service Name                             #
+#                                                                  #
+# Define Service Name here. If using RCON this name will be        #
+# referenced again as RWA_RCON_HOST below.                         #
+#                                                                  #
+# Example: 'name:' or 'mc_atm6:'                                   #
+####################################################################
+  mc_tnp5:
+
+####################################################################
+#                      Image & Container Name                      #
+#                                                                  #
+# Specify Image Name and Java Version. The 'image' will always be  #
+# 'itzg/minecraft-server' however the tag added to the end is      #
+# where you can specify the java version or container architecture.#
+# See readme.md for a full list.                                   #
+#                                                                  #
+# 'container_name:' This can be anything you like. This is the name#
+# that will show when you run 'docker ps' commands.                #
+####################################################################
+    image: itzg/minecraft-server
+    container_name: mc_tnp5
+
+####################################################################
+#                         Server Ports                             #
+#                                                                  #
+# Specify external port.                                           #
+####################################################################
+    ports:
+      - 25565:25565
+
+####################################################################
+#                   Automatic Server Restart                       #
+#                                                                  #
+# Define a restart policy here.                                    #
+#    - 'no' = Do not restart.                                      #
+#    - 'on-failure' = Restart if container exits because an error. #
+#    - 'always' = Regardless of stop reason.                       #
+#    - 'unless-stopped' = Similar to always except if stopped.     #
+####################################################################
+    restart: unless-stopped
+
+####################################################################
+#                     Volume and Folder Access                     #
+#                                                                  #
+# This section defines what folders and volumes you want to give   #
+# this container access to. It is recommended to leaves these set  #
+# to the default values unless you know what you are doing.        #
+#                                                                  #
+# Place your mod zip file in a folder called 'modpacks' in the     #
+# same directory you place this docker-compose file.               #
+#                                                                  #
+# Specify the data volume name or directory here as well.          #
+# In this example the volume name is 'data'. When docker creates   #
+# the volume it will add what ever name you give it here to the    #
+# end of the container name specified above. In this example it    #
+# would be named 'mc_atm6_data'. If you change this be sure to     #
+# update the volume name at the bottom of this config.             #
+####################################################################
+    volumes:
+      - ./modpacks:/modpacks:ro
+      - data:/data
+
+####################################################################
+#                             EULA                                 #
+#                                                                  #
+# Accept EULA by setting to "true"                                 #
+####################################################################
+    environment:
+      EULA: "true"
+
+####################################################################
+#                          FORGE INSTALL                           #
+#                                                                  #
+# Sets install type to FORGE and specifys the zip folder name      #
+# and location of your mod pack.                                   #
+#                                                                  #
+# TYPE: Defines the install type as FORGE                          #
+#                                                                  #
+# VERSION: Defines the version of MC the modpack is based on.      #
+#                                                                  #
+# FORGE_VERSION: Defines the version of FORGE the modpack uses.     #
+#               This can usually be found in the modpack.zip as    #
+#               installer.jar                                      #
+#                                                                  #
+# GENERIC_PACK: Define where the modpack.zip is located.            #
+#                                                                  #
+# Place your mod zip file in a folder called 'modpacks' in the     #
+# same directory you place this docker-compose file.               #
+####################################################################
+      TYPE: FORGE
+      VERSION: 1.18.2
+      FORGE_VERSION: 40.1.73
+      GENERIC_PACK: /modpacks/tnp5.zip
+
+####################################################################
+#                          Server Memory                           #
+#                                                                  #
+# Set Maximum amount of memory allowed for your server.            #
+####################################################################
+      MEMORY: "8G"
+
+####################################################################
+#                         Logging Options                          #
+#                                                                  #
+# Set to "true" to delete old logs                                 #
+####################################################################
+      ENABLE_ROLLING_LOGS: "true"
+
+####################################################################
+#                          Server Timezone                         #
+#                                                                  #
+# Specify server Timezone                                          #
+####################################################################
+      TZ: "America/New_York"
+
+####################################################################
+#                       Minecraft Game Options                     #
+#                                                                  #
+# List any game options you want to define here. A full list can   #
+# be found on the readme.md page on github.                        #
+####################################################################
+      OVERRIDE_SERVER_PROPERTIES: "true"
+      DIFFICULTY: "easy"
+      MAX_TICK_TIME: "-1"
+      VIEW_DISTANCE: "6"
+      ALLOW_FLIGHT: "true"
+      OPS: ""
+      MAX_PLAYERS: 10
+      PVP: "false"
+      LEVEL_TYPE: "biomesoplenty"
+      MOTD: "Welcome Home"
+
+####################################################################
+#                            Volumes                               #
+#                                                                  #
+# Define data volume name here. You should leave this set to the   #
+# default.                                                         #
+####################################################################
+volumes:
+  data:

examples/docker-compose-generic-pack.yml

@@ -11,7 +11,7 @@ services:
       TYPE: FORGE
       DEBUG: "${DEBUG:-false}"
       VERSION: ${VERSION:-1.17.1}
-      FORGEVERSION: ${FORGEVERSION:-37.0.90}
+      FORGE_VERSION: ${FORGE_VERSION:-37.0.90}
       GENERIC_PACK: /modpacks/${MODPACK:-Server-Files-0.0.21.zip}
       REMOVE_OLD_MODS: "${REMOVE_OLD_MODS:-false}"
     ports:

examples/docker-compose-mods-mount.yml

@@ -0,0 +1,21 @@
+version: '3.8'
+
+services:
+  minecraft:
+    image: itzg/minecraft-server
+    volumes:
+      - data:/data
+      - ./mods:/mods
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: "true"
+      TYPE: "FORGE"
+      VERSION: "1.19.2"
+      DEBUG: "true"
+      SETUP_ONLY: "true"
+    tty: True
+    stdin_open: True
+
+volumes:
+  data: {}

examples/docker-compose-paper.yml

@@ -5,15 +5,13 @@ services:
     container_name: paper
     environment:
       EULA: "true"
-      ENABLE_RCON: "true"
       TYPE: PAPER
       VIEW_DISTANCE: 10
       MEMORY: 2G
-      CONSOLE: "false"
     ports:
-      - 25565:25565
+      - "25565:25565"
     volumes:
       - mc-paper:/data
     restart: unless-stopped
 volumes:
-  mc-paper:
+  mc-paper: {}

examples/docker-compose-rlcraft.yml

@@ -10,7 +10,7 @@ services:
       EULA: "true"
       TYPE: "FORGE"
       VERSION: "1.12.2"
-      FORGEVERSION: "14.23.5.2860"
+      FORGE_VERSION: "14.23.5.2860"
       OVERRIDE_SERVER_PROPERTIES: "true"
       DIFFICULTY: "hard"
       MAX_TICK_TIME: "-1"

examples/docker-compose-simple.yml

@@ -6,7 +6,7 @@ services:
     tty: true
     stdin_open: true
     ports:
-      - 25565:25565
+      - "25565:25565"
     environment:
       EULA: "TRUE"
     volumes:

examples/docker-compose-spongeforge.yml

@@ -14,8 +14,8 @@ services:
       EULA: "TRUE"
       #VERSION: "1.12.2" (Ensure this is compatbile with the version of SpongeForge you are using!)
       TYPE: "FORGE"
-      FORGEVERSION: "RECOMMENDED"
-      #FORGEVERSION: "14.23.5.2807"
+      FORGE_VERSION: "RECOMMENDED"
+      #FORGE_VERSION: "14.23.5.2807"
       CONSOLE: "false"
       ENABLE_RCON: "true"
       RCON_PASSWORD: "testing"

examples/modrinth-paper/docker-compose.yml

@@ -0,0 +1,13 @@
+version: "3"
+
+services:
+  mc:
+    image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
+    environment:
+      EULA: "true"
+      TYPE: PAPER
+      VERSION: 1.19.3
+      MODRINTH_PROJECTS: "coreprotect"
+      MODRINTH_ALLOWED_VERSION_TYPE: "release"
+    volumes:
+      - ./data:/data

examples/multi-project/README.md

@@ -0,0 +1,10 @@
+This project demonstrates the use of two compose projects, `dbs` and `servers`, where the following capabilities are demonstrated:
+
+- Managing databases, such as MariaDB, in its own compose project: `dbs`
+- Using an `.env` file to avoid including user details within the compose file 
+- Accessing the database from a separate project, `servers`, via an external network declaration
+  - LuckPerms is configured to access the MariaDB instance
+- Isolating the Minecraft server container by purposely **not** declaring port mappings
+- Running Waterfall as a proxy
+- Using configuration mount points to pre-configure Waterfall and the Minecraft server
+- Using Spiget to download plugins, in this case LuckPerms

examples/multi-project/dbs/.env

@@ -0,0 +1,2 @@
+LUCKPERMS_USER=luckperms
+LUCKPERMS_PASSWORD=luckpermspw

examples/multi-project/dbs/docker-compose.yml

@@ -0,0 +1,21 @@
+version: "3.8"
+
+services:
+  mariadb:
+    image: mariadb:10
+    environment:
+      MARIADB_RANDOM_ROOT_PASSWORD: yes
+      MARIADB_DATABASE: luckperms
+      # These are loaded by compose from .env
+      MARIADB_USER: ${LUCKPERMS_USER}
+      MARIADB_PASSWORD: ${LUCKPERMS_PASSWORD}
+    volumes:
+      - mariadb:/var/lib/mysql
+
+  adminer:
+    image: adminer
+    ports:
+      - "8806:8080"
+
+volumes:
+  mariadb: {}

examples/multi-project/servers/docker-compose.yml

@@ -0,0 +1,41 @@
+version: "3.8"
+
+services:
+  proxy:
+    image: itzg/bungeecord
+    environment:
+      TYPE: WATERFALL
+    ports:
+      - "25565:25577"
+    volumes:
+      - waterfall:/server
+      - ./waterfall-config:/config
+
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: "true"
+      TYPE: PAPER
+      # 28140: luckperms
+      SPIGET_RESOURCES: "28140"
+      # since we're behind a proxy
+      ONLINE_MODE: "false"
+    volumes:
+      - mc:/data
+      # mainly to drop in config files specific to plugins
+      - ./mc-plugins:/plugins
+    networks:
+      # so proxy can reach us
+      - default
+      # so we can use databases project
+      - dbs
+
+volumes:
+  mc: {}
+  waterfall: {}
+
+networks:
+  dbs:
+    # declared in ../dbs
+    external: true
+    name: dbs_default

examples/multi-project/servers/mc-plugins/LuckPerms/config.yml

@@ -0,0 +1,710 @@
+####################################################################################################
+# +----------------------------------------------------------------------------------------------+ #
+# |                                   __         __   ___  __         __                         | #
+# |                        |    |  | /  ` |__/  |__) |__  |__)  |\/| /__`                        | #
+# |                        |___ \__/ \__, |  \  |    |___ |  \  |  | .__/                        | #
+# |                                                                                              | #
+# |                                     https://luckperms.net                                    | #
+# |                                                                                              | #
+# |  WIKI:        https://luckperms.net/wiki                                                     | #
+# |  DISCORD:     https://discord.gg/luckperms                                                   | #
+# |  BUG REPORTS: https://github.com/lucko/LuckPerms/issues                                      | #
+# |                                                                                              | #
+# |  Each option in this file is documented and explained here:                                  | #
+# |   ==>  https://luckperms.net/wiki/Configuration                                              | #
+# |                                                                                              | #
+# |  New options are not added to this file automatically. Default values are used if an         | #
+# |  option cannot be found. The latest config versions can be obtained at the link above.       | #
+# +----------------------------------------------------------------------------------------------+ #
+####################################################################################################
+
+# +----------------------------------------------------------------------------------------------+ #
+# |                                                                                              | #
+# |                                      ESSENTIAL SETTINGS                                      | #
+# |                                                                                              | #
+# |                   Important settings that control how LuckPerms functions.                   | #
+# |                                                                                              | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# The name of the server, used for server specific permissions.
+#
+# - When set to "global" this setting is effectively ignored.
+# - In all other cases, the value here is added to all players in a "server" context.
+# - See: https://luckperms.net/wiki/Context
+server: global
+
+# If the servers own UUID cache/lookup facility should be used when there is no record for a player
+# already in LuckPerms.
+#
+# - When this is set to 'false', commands using a player's username will not work unless the player
+#   has joined since LuckPerms was first installed.
+# - To get around this, you can use a player's uuid directly in the command, or enable this option.
+# - When this is set to 'true', the server facility is used. This may use a number of methods,
+#   including checking the servers local cache, or making a request to the Mojang API.
+use-server-uuid-cache: false
+
+
+
+
+# +----------------------------------------------------------------------------------------------+ #
+# |                                                                                              | #
+# |                                       STORAGE SETTINGS                                       | #
+# |                                                                                              | #
+# |                Controls which storage method LuckPerms will use to store data.               | #
+# |                                                                                              | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# How the plugin should store data
+#
+# - The various options are explained in more detail on the wiki:
+#   https://luckperms.net/wiki/Storage-types
+#
+# - Possible options:
+#
+#   |  Remote databases - require connection information to be configured below
+#   |=> MySQL
+#   |=> MariaDB (preferred over MySQL)
+#   |=> PostgreSQL
+#   |=> MongoDB
+#
+#   |  Flatfile/local database - don't require any extra configuration
+#   |=> H2 (preferred over SQLite)
+#   |=> SQLite
+#
+#   |  Readable & editable text files - don't require any extra configuration
+#   |=> YAML (.yml files)
+#   |=> JSON (.json files)
+#   |=> HOCON (.conf files)
+#   |=> TOML (.toml files)
+#   |
+#   | By default, user, group and track data is separated into different files. Data can be combined
+#   | and all stored in the same file by switching to a combined storage variant.
+#   | Just add '-combined' to the end of the storage-method, e.g. 'yaml-combined'
+#
+# - A H2 database is the default option.
+# - If you want to edit data manually in "traditional" storage files, we suggest using YAML.
+storage-method: MariaDB
+
+# The following block defines the settings for remote database storage methods.
+#
+# - You don't need to touch any of the settings here if you're using a local storage method!
+# - The connection detail options are shared between all remote storage types.
+data:
+
+  # Define the address and port for the database.
+  # - The standard DB engine port is used by default
+  #   (MySQL: 3306, PostgreSQL: 5432, MongoDB: 27017)
+  # - Specify as "host:port" if differs
+  address: mariadb
+
+  # The name of the database to store LuckPerms data in.
+  # - This must be created already. Don't worry about this setting if you're using MongoDB.
+  database: luckperms
+
+  # Credentials for the database.
+  username: luckperms
+  password: 'luckpermspw'
+
+  # These settings apply to the MySQL connection pool.
+  # - The default values will be suitable for the majority of users.
+  # - Do not change these settings unless you know what you're doing!
+  pool-settings:
+
+    # Sets the maximum size of the MySQL connection pool.
+    # - Basically this value will determine the maximum number of actual
+    #   connections to the database backend.
+    # - More information about determining the size of connection pools can be found here:
+    #   https://github.com/brettwooldridge/HikariCP/wiki/About-Pool-Sizing
+    maximum-pool-size: 10
+
+    # Sets the minimum number of idle connections that the pool will try to maintain.
+    # - For maximum performance and responsiveness to spike demands, it is recommended to not set
+    #   this value and instead allow the pool to act as a fixed size connection pool.
+    #   (set this value to the same as 'maximum-pool-size')
+    minimum-idle: 10
+
+    # This setting controls the maximum lifetime of a connection in the pool in milliseconds.
+    # - The value should be at least 30 seconds less than any database or infrastructure imposed
+    #   connection time limit.
+    maximum-lifetime: 1800000 # 30 minutes
+
+    # This setting controls how frequently the pool will 'ping' a connection in order to prevent it
+    # from being timed out by the database or network infrastructure, measured in milliseconds.
+    # - The value should be less than maximum-lifetime and greater than 30000 (30 seconds).
+    # - Setting the value to zero will disable the keepalive functionality.
+    keepalive-time: 0
+
+    # This setting controls the maximum number of milliseconds that the plugin will wait for a
+    # connection from the pool, before timing out.
+    connection-timeout: 5000 # 5 seconds
+
+    # This setting allows you to define extra properties for connections.
+    #
+    # By default, the following options are set to enable utf8 encoding. (you may need to remove
+    # these if you are using PostgreSQL)
+    #   useUnicode: true
+    #   characterEncoding: utf8
+    #
+    # You can also use this section to disable SSL connections, by uncommenting the 'useSSL' and
+    # 'verifyServerCertificate' options below.
+    properties:
+      useUnicode: true
+      characterEncoding: utf8
+      #useSSL: false
+      #verifyServerCertificate: false
+
+  # The prefix for all LuckPerms SQL tables.
+  #
+  # - This only applies for remote SQL storage types (MySQL, MariaDB, etc).
+  # - Change this if you want to use different tables for different servers.
+  table-prefix: 'luckperms_'
+
+  # The prefix to use for all LuckPerms MongoDB collections.
+  #
+  # - This only applies for the MongoDB storage type.
+  # - Change this if you want to use different collections for different servers. The default is no
+  # prefix.
+  mongodb-collection-prefix: ''
+
+  # The connection string URI to use to connect to the MongoDB instance.
+  #
+  # - When configured, this setting will override anything defined in the address, database,
+  #   username or password fields above.
+  # - If you have a connection string that starts with 'mongodb://' or 'mongodb+srv://', enter it
+  #   below.
+  # - For more information, please see https://docs.mongodb.com/manual/reference/connection-string/
+  mongodb-connection-uri: ''
+
+# Define settings for a "split" storage setup.
+#
+# - This allows you to define a storage method for each type of data.
+# - The connection options above still have to be correct for each type here.
+split-storage:
+  # Don't touch this if you don't want to use split storage!
+  enabled: false
+  methods:
+    # These options don't need to be modified if split storage isn't enabled.
+    user: h2
+    group: h2
+    track: h2
+    uuid: h2
+    log: h2
+
+
+
+
+# +----------------------------------------------------------------------------------------------+ #
+# |                                                                                              | #
+# |                            UPDATE PROPAGATION & MESSAGING SERVICE                            | #
+# |                                                                                              | #
+# |    Controls the ways in which LuckPerms will sync data & notify other servers of changes.    | #
+# |     These options are documented on greater detail on the wiki under "Instant Updates".      | #
+# |                                                                                              | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# This option controls how frequently LuckPerms will perform a sync task.
+#
+# - A sync task will refresh all data from the storage, and ensure that the most up-to-date data is
+#   being used by the plugin.
+# - This is disabled by default, as most users will not need it. However, if you're using a remote
+#   storage type without a messaging service setup, you may wish to set this to something like 3.
+# - Set to -1 to disable the task completely.
+sync-minutes: -1
+
+# If the file watcher should be enabled.
+#
+# - When using a file-based storage type, LuckPerms can monitor the data files for changes, and
+#   automatically update when changes are detected.
+# - If you don't want this feature to be active, set this option to false.
+watch-files: true
+
+# Define which messaging service should be used by the plugin.
+#
+# - If enabled and configured, LuckPerms will use the messaging service to inform other connected
+#   servers of changes.
+# - Use the command "/lp networksync" to manually push changes.
+# - Data is NOT stored using this service. It is only used as a messaging platform.
+#
+# - If you decide to enable this feature, you should set "sync-minutes" to -1, as there is no need
+#   for LuckPerms to poll the database for changes.
+#
+# - Possible options:
+#   => sql       Uses the SQL database to form a queue system for communication. Will only work when
+#                'storage-method' is set to MySQL or MariaDB. This is chosen by default if the
+#                option is set to 'auto' and SQL storage is in use. Set to 'notsql' to disable this.
+#   => pluginmsg Uses the plugin messaging channels to communicate with the proxy.
+#                LuckPerms must be installed on your proxy & all connected servers backend servers.
+#                Won't work if you have more than one proxy.
+#   => lilypad   Uses LilyPad pub-sub to push changes. You need to have the LilyPad-Connect plugin
+#                installed.
+#   => redis     Uses Redis pub-sub to push changes. Your server connection info must be configured
+#                below.
+#   => rabbitmq  Uses RabbitMQ pub-sub to push changes. Your server connection info must be
+#                configured below.
+#   => custom    Uses a messaging service provided using the LuckPerms API.
+#   => auto      Attempts to automatically setup a messaging service using redis or sql.
+messaging-service: auto
+
+# If LuckPerms should automatically push updates after a change has been made with a command.
+auto-push-updates: true
+
+# If LuckPerms should push logging entries to connected servers via the messaging service.
+push-log-entries: true
+
+# If LuckPerms should broadcast received logging entries to players on this platform.
+#
+# - If you have LuckPerms installed on your backend servers as well as a BungeeCord proxy, you
+#   should set this option to false on either your backends or your proxies, to avoid players being
+#   messaged twice about log entries.
+broadcast-received-log-entries: true
+
+# Settings for Redis.
+# Port 6379 is used by default; set address to "host:port" if differs
+redis:
+  enabled: false
+  address: localhost
+  username: ''
+  password: ''
+
+# Settings for RabbitMQ.
+# Port 5672 is used by default; set address to "host:port" if differs
+rabbitmq:
+  enabled: false
+  address: localhost
+  vhost: '/'
+  username: 'guest'
+  password: 'guest'
+
+
+
+
+# +----------------------------------------------------------------------------------------------+ #
+# |                                                                                              | #
+# |                                    CUSTOMIZATION SETTINGS                                    | #
+# |                                                                                              | #
+# |              Settings that allow admins to customize the way LuckPerms operates.             | #
+# |                                                                                              | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# Controls how temporary permissions/parents/meta should be accumulated.
+#
+# - The default behaviour is "deny".
+# - This behaviour can also be specified when the command is executed. See the command usage
+#   documentation for more info.
+#
+# - Possible options:
+#   => accumulate   durations will be added to the existing expiry time
+#   => replace      durations will be replaced if the new duration is later than the current
+#                   expiration
+#   => deny         the command will just fail if you try to add another node with the same expiry
+temporary-add-behaviour: deny
+
+# Controls how LuckPerms will determine a users "primary" group.
+#
+# - The meaning and influence of "primary groups" are explained in detail on the wiki.
+# - The preferred approach is to let LuckPerms automatically determine a users primary group
+#   based on the relative weight of their parent groups.
+#
+# - Possible options:
+#   => stored                  use the value stored against the users record in the file/database
+#   => parents-by-weight       just use the users most highly weighted parent
+#   => all-parents-by-weight   same as above, but calculates based upon all parents inherited from
+#                              both directly and indirectly
+primary-group-calculation: parents-by-weight
+
+# If the plugin should check for "extra" permissions with users run LP commands.
+#
+# - These extra permissions allow finer control over what users can do with each command, and who
+#   they have access to edit.
+# - The nature of the checks are documented on the wiki under "Argument based command permissions".
+# - Argument based permissions are *not* static, unlike the 'base' permissions, and will depend upon
+#   the arguments given within the command.
+argument-based-command-permissions: false
+
+# If the plugin should check whether senders are a member of a given group before they're able to
+# edit the groups data or add/remove other users to/from it.
+# Note: these limitations do not apply to the web editor!
+require-sender-group-membership-to-modify: false
+
+# If the plugin should send log notifications to users whenever permissions are modified.
+#
+# - Notifications are only sent to those with the appropriate permission to receive them
+# - They can also be temporarily enabled/disabled on a per-user basis using
+#   '/lp log notify <on|off>'
+log-notify: true
+
+# Defines a list of log entries which should not be sent as notifications to users.
+#
+# - Each entry in the list is a RegEx expression which is matched against the log entry description.
+log-notify-filtered-descriptions:
+#  - "parent add example"
+
+# If LuckPerms should automatically install translation bundles and periodically update them.
+auto-install-translations: true
+
+# Defines the options for prefix and suffix stacking.
+#
+# - The feature allows you to display multiple prefixes or suffixes alongside a players username in
+#   chat.
+# - It is explained and documented in more detail on the wiki under "Prefix & Suffix Stacking".
+#
+# - The options are divided into separate sections for prefixes and suffixes.
+# - The 'duplicates' setting refers to how duplicate elements are handled. Can be 'retain-all',
+#   'first-only' or 'last-only'.
+# - The value of 'start-spacer' is included at the start of the resultant prefix/suffix.
+# - The value of 'end-spacer' is included at the end of the resultant prefix/suffix.
+# - The value of 'middle-spacer' is included between each element in the resultant prefix/suffix.
+#
+# - Possible format options:
+#   => highest                        Selects the value with the highest weight, from all values
+#                                     held by or inherited by the player.
+#
+#   => lowest                         Same as above, except takes the one with the lowest weight.
+#
+#   => highest_own                    Selects the value with the highest weight, but will not
+#                                     accept any inherited values.
+#
+#   => lowest_own                     Same as above, except takes the value with the lowest weight.
+#
+#   => highest_inherited              Selects the value with the highest weight, but will only
+#                                     accept inherited values.
+#
+#   => lowest_inherited               Same as above, except takes the value with the lowest weight.
+#
+#   => highest_on_track_<track>       Selects the value with the highest weight, but only if the
+#                                     value was inherited from a group on the given track.
+#
+#   => lowest_on_track_<track>        Same as above, except takes the value with the lowest weight.
+#
+#   => highest_not_on_track_<track>   Selects the value with the highest weight, but only if the
+#                                     value was inherited from a group not on the given track.
+#
+#   => lowest_not_on_track_<track>    Same as above, except takes the value with the lowest weight.
+#
+#   => highest_from_group_<group>     Selects the value with the highest weight, but only if the
+#                                     value was inherited from the given group.
+#
+#   => lowest_from_group_<group>      Same as above, except takes the value with the lowest weight.
+#
+#   => highest_not_from_group_<group> Selects the value with the highest weight, but only if the
+#                                     value was not inherited from the given group.
+#
+#   => lowest_not_from_group_<group>  Same as above, except takes the value with the lowest weight.
+meta-formatting:
+  prefix:
+    format:
+      - "highest"
+    duplicates: first-only
+    start-spacer: ""
+    middle-spacer: " "
+    end-spacer: ""
+  suffix:
+    format:
+      - "highest"
+    duplicates: first-only
+    start-spacer: ""
+    middle-spacer: " "
+    end-spacer: ""
+
+
+
+
+# +----------------------------------------------------------------------------------------------+ #
+# |                                                                                              | #
+# |                            PERMISSION CALCULATION AND INHERITANCE                            | #
+# |                                                                                              | #
+# |    Modify the way permission checks, meta lookups and inheritance resolutions are handled.   | #
+# |                                                                                              | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# The algorithm LuckPerms should use when traversing the "inheritance tree".
+#
+# - Possible options:
+#   => breadth-first            See: https://en.wikipedia.org/wiki/Breadth-first_search
+#   => depth-first-pre-order    See: https://en.wikipedia.org/wiki/Depth-first_search
+#   => depth-first-post-order   See: https://en.wikipedia.org/wiki/Depth-first_search
+inheritance-traversal-algorithm: depth-first-pre-order
+
+# If a final sort according to "inheritance rules" should be performed after the traversal algorithm
+# has resolved the inheritance tree.
+#
+# "Inheritance rules" refers to things such as group weightings, primary group status, and the
+# natural contextual ordering of the group nodes.
+#
+# Setting this to 'true' will allow for the inheritance rules to take priority over the structure of
+# the inheritance tree.
+#
+# Effectively when this setting is 'true': the tree is flattened, and rules applied afterwards,
+# and when this setting is 'false':, the rules are just applied during each step of the traversal.
+post-traversal-inheritance-sort: false
+
+# Defines the mode used to determine whether a set of contexts are satisfied.
+#
+# - Possible options:
+#   => at-least-one-value-per-key   Set A will be satisfied by another set B, if at least one of the
+#                                   key-value entries per key in A are also in B.
+#   => all-values-per-key           Set A will be satisfied by another set B, if all key-value
+#                                   entries in A are also in B.
+context-satisfy-mode: at-least-one-value-per-key
+
+# LuckPerms has a number of built-in contexts. These can be disabled by adding the context key to
+# the list below.
+disabled-contexts:
+#  - "world"
+
+# +----------------------------------------------------------------------------------------------+ #
+# | Permission resolution settings                                                               | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# If users on this server should have their global permissions applied.
+# When set to false, only server specific permissions will apply for users on this server
+include-global: true
+
+# If users on this server should have their global world permissions applied.
+# When set to false, only world specific permissions will apply for users on this server
+include-global-world: true
+
+# If users on this server should have global (non-server specific) groups applied
+apply-global-groups: true
+
+# If users on this server should have global (non-world specific) groups applied
+apply-global-world-groups: true
+
+# +----------------------------------------------------------------------------------------------+ #
+# | Meta lookup settings                                                                         | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# Defines how meta values should be selected.
+#
+# - Possible options:
+#   => inheritance      Selects the meta value that was inherited first
+#   => highest-number   Selects the highest numerical meta value
+#   => lowest-number    Selects the lowest numerical meta value
+meta-value-selection-default: inheritance
+
+# Defines how meta values should be selected per key.
+meta-value-selection:
+#  max-homes: highest-number
+
+# +----------------------------------------------------------------------------------------------+ #
+# | Inheritance settings                                                                         | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# If the plugin should apply wildcard permissions.
+#
+# - If set to true, LuckPerms will detect wildcard permissions, and resolve & apply all registered
+#   permissions matching the wildcard.
+apply-wildcards: true
+
+# If LuckPerms should resolve and apply permissions according to the Sponge style implicit wildcard
+# inheritance system.
+#
+# - That being: If a user has been granted "example", then the player should have also be
+#   automatically granted "example.function", "example.another", "example.deeper.nesting",
+#   and so on.
+apply-sponge-implicit-wildcards: false
+
+# If the plugin should apply negated Bukkit default permissions before it considers wildcard
+# assignments.
+#
+# - Plugin authors can define permissions which explicitly should not be given automatically to OPs.
+#   This is usually used for so called "anti-permissions" - permissions which, when granted, apply
+#   something negative.
+# - If this option is set to true, LuckPerms will consider any negated declarations made by
+#   plugins before it considers wildcards. (similar to the way the OP system works)
+# - If this option is set to false, LuckPerms will consider any wildcard assignments first.
+apply-default-negated-permissions-before-wildcards: false
+
+# If the plugin should parse regex permissions.
+#
+# - If set to true, LuckPerms will detect regex permissions, marked with "r=" at the start of the
+#   node, and resolve & apply all registered permissions matching the regex.
+apply-regex: true
+
+# If the plugin should complete and apply shorthand permissions.
+#
+# - If set to true, LuckPerms will detect and expand shorthand node patterns.
+apply-shorthand: true
+
+# If the plugin should apply Bukkit child permissions.
+#
+# - Plugin authors can define custom permissions structures for their plugin, which will be resolved
+#   and used by LuckPerms if this setting is enabled.
+apply-bukkit-child-permissions: true
+
+# If the plugin should apply Bukkit default permissions.
+#
+# - Plugin authors can define permissions which should be given to all users by default, or setup
+#   permissions which should/shouldn't be given to opped players.
+# - If this option is set to false, LuckPerms will ignore these defaults.
+apply-bukkit-default-permissions: true
+
+# If the plugin should apply attachment permissions.
+#
+# - Other plugins on the server are able to add their own "permission attachments" to players.
+# - This allows them to grant players additional permissions which last until the end of the
+#   session, or until they're removed.
+# - If this option is set to false, LuckPerms will not include these attachment permissions when
+#   considering if a player should have access to a certain permission.
+apply-bukkit-attachment-permissions: true
+
+# +----------------------------------------------------------------------------------------------+ #
+# | Extra settings                                                                               | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# A list of context calculators which will be skipped when calculating contexts.
+#
+# - You can disable context calculators by either:
+#   => specifying the Java class name used by the calculator (e.g. com.example.ExampleCalculator)
+#   => specifying a sub-section of the Java package used by the calculator (e.g. com.example)
+disabled-context-calculators: []
+
+# Allows you to set "aliases" for the worlds sent forward for context calculation.
+#
+# - These aliases are provided in addition to the real world name. Applied recursively.
+# - Remove the comment characters for the default aliases to apply.
+world-rewrite:
+#  world_nether: world
+#  world_the_end: world
+
+# Define special group weights for this server.
+#
+# - Group weights can also be applied directly to group data, using the setweight command.
+# - This section allows weights to be set on a per-server basis.
+group-weight:
+#  admin: 10
+
+
+
+
+# +----------------------------------------------------------------------------------------------+ #
+# |                                                                                              | #
+# |                                      FINE TUNING OPTIONS                                     | #
+# |                                                                                              | #
+# |     A number of more niche settings for tweaking and changing behaviour. The section also    | #
+# | contains toggles for some more specialised features. It is only necessary to make changes to | #
+# |                  these options if you want to fine-tune LuckPerms behaviour.                 | #
+# |                                                                                              | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# +----------------------------------------------------------------------------------------------+ #
+# | Server Operator (OP) settings                                                                | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# Controls whether server operators should exist at all.
+#
+# - When set to 'false', all players will be de-opped, and the /op and /deop commands will be
+#   disabled. Note that vanilla features like the spawn-protection require an operator on the
+#   server to work.
+enable-ops: true
+
+# Enables or disables a special permission based system in LuckPerms for controlling OP status.
+#
+# - If set to true, any user with the permission "luckperms.autoop" will automatically be granted
+#   server operator status. This permission can be inherited, or set on specific servers/worlds,
+#   temporarily, etc.
+# - Additionally, setting this to true will force the "enable-ops" option above to false. All users
+#   will be de-opped unless they have the permission node, and the op/deop commands will be
+#   disabled.
+# - It is recommended that you use this option instead of assigning a single '*' permission.
+auto-op: false
+
+# Defines if "opped" players should be able to use all LuckPerms commands by default.
+#
+# - Set to false to only allow users who have the permissions access to the commands
+commands-allow-op: true
+
+# +----------------------------------------------------------------------------------------------+ #
+# | Vault integration settings                                                                   | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# If Vault lookups for offline players on the main server thread should be enabled.
+#
+# LuckPerms has a "catch" for plugins attempting to perform unsafe offline player data lookups
+# from the main server thread. This catch raises an exception (causes an error to occur) when unsafe
+# lookups are made, instead of allowing the lookup to happen, which would likely cause the server
+# to lag.
+#
+# However, if you're willing to accept the consequences, the catch can be disabled by setting this
+# option to 'true.
+vault-unsafe-lookups: false
+
+# If LuckPerms should use the 'display name' of a group when returning groups in Vault API calls.
+#
+# - When this option is set to true, the display name of the group is returned.
+# - When this option is set to false, the standard name/id of the group is returned.
+vault-group-use-displaynames: true
+
+# Controls which group LuckPerms should use for NPC players when handling Vault requests.
+#
+# - As NPCs aren't actually real players, LuckPerms does not load any user data for them. This
+#   becomes an issue when plugins want to check for their permissions using Vault.
+# - As a solution, Vault checks for NPCs fallback to a group, which is defined below.
+vault-npc-group: default
+
+# Controls how LuckPerms should consider the OP status of NPC players when handing Vault requests.
+#
+# - If you want NPCs to have the same permissions as "normal" players, set this option to false.
+# - If you want NPCs to have OP status, set this option to true.
+vault-npc-op-status: false
+
+# If the vault-server option below should be used.
+#
+# - When this option is set to false, the server value defined above under "server" is used.
+use-vault-server: false
+
+# The name of the server used within Vault operations.
+#
+# - If you don't want Vault operations to be server specific, set this to "global".
+# - Will only take effect if use-vault-server is set to true above.
+vault-server: global
+
+# If global permissions should be considered when retrieving meta or player groups
+vault-include-global: true
+
+# If Vault operations should ignore any world arguments if supplied.
+vault-ignore-world: false
+
+# +----------------------------------------------------------------------------------------------+ #
+# | Miscellaneous (and rarely used) settings                                                     | #
+# +----------------------------------------------------------------------------------------------+ #
+
+# If LuckPerms should produce extra logging output when it handles logins.
+#
+# - Useful if you're having issues with UUID forwarding or data not being loaded.
+debug-logins: false
+
+# If LuckPerms should allow usernames with non alphanumeric characters.
+#
+# - Note that due to the design of the storage implementation, usernames must still be 16 characters
+#   or less.
+allow-invalid-usernames: false
+
+# If LuckPerms should not require users to confirm bulkupdate operations.
+#
+# - When set to true, operations will be executed immediately.
+# - This is not recommended, as bulkupdate has the potential to irreversibly delete large amounts of
+#   data, and is not designed to be executed automatically.
+# - If automation is needed, users should prefer using the LuckPerms API.
+skip-bulkupdate-confirmation: false
+
+# If LuckPerms should prevent bulkupdate operations.
+#
+# - When set to true, bulkupdate operations (the /lp bulkupdate command) will not work.
+# - When set to false, bulkupdate operations will be allowed via the console.
+disable-bulkupdate: false
+
+# If LuckPerms should allow a users primary group to be removed with the 'parent remove' command.
+#
+# - When this happens, the plugin will set their primary group back to default.
+prevent-primary-group-removal: false
+
+# If LuckPerms should update the list of commands sent to the client when permissions are changed.
+update-client-command-list: true
+
+# If LuckPerms should attempt to register "Brigadier" command list data for its commands.
+register-command-list-data: true
+
+# If LuckPerms should attempt to resolve Vanilla command target selectors for LP commands.
+# See here for more info: https://minecraft.gamepedia.com/Commands#Target_selectors
+resolve-command-selectors: false

examples/multi-project/servers/waterfall-config/config.yml

@@ -0,0 +1,52 @@
+server_connect_timeout: 5000
+enforce_secure_profile: false
+remote_ping_cache: -1
+forge_support: true
+player_limit: -1
+permissions:
+  default:
+    - bungeecord.command.server
+    - bungeecord.command.list
+  admin:
+    - bungeecord.command.alert
+    - bungeecord.command.end
+    - bungeecord.command.ip
+    - bungeecord.command.reload
+    - bungeecord.command.kick
+timeout: 30000
+log_commands: false
+network_compression_threshold: 256
+online_mode: true
+disabled_commands:
+  - disabledcommandhere
+servers:
+  mc:
+    motd: 'Lobby'
+    address: mc:25565
+    restricted: false
+listeners:
+  - query_port: 25577
+    motd: '&1Another Bungee server'
+    tab_list: GLOBAL_PING
+    query_enabled: false
+    proxy_protocol: false
+    forced_hosts:
+      pvp.md-5.net: pvp
+    ping_passthrough: false
+    priorities:
+      - mc
+    bind_local_address: true
+    host: 0.0.0.0:25577
+    max_players: 1
+    tab_size: 60
+    force_default_server: false
+ip_forward: false
+remote_ping_timeout: 5000
+prevent_proxy_connections: false
+groups:
+  md_5:
+    - admin
+connection_throttle: 4000
+stats: 39440d41-8d83-40cb-a6a7-d95c3197c4d2
+connection_throttle_limit: 3
+log_pings: true

examples/multi-project/servers/waterfall-config/waterfall.yml

@@ -0,0 +1,10 @@
+plugin_channel_name_limit: 128
+use_netty_dns_resolver: true
+disable_modern_tab_limiter: true
+log_initial_handler_connections: true
+throttling:
+  tab_complete: 1000
+game_version: ''
+disable_tab_list_rewrite: true
+registered_plugin_channels_limit: 128
+disable_entity_metadata_rewrite: false

examples/one-block-modded/docker-compose.yml

@@ -0,0 +1,19 @@
+version: "3.8"
+
+services:
+  mc:
+    image: itzg/minecraft-server
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: "true"
+      TYPE: AUTO_CURSEFORGE
+      CF_PAGE_URL: "https://www.curseforge.com/minecraft/modpacks/one-block-modded/files/4136487"
+      CF_SET_LEVEL_FROM: OVERRIDES
+      DEBUG: "false"
+      MEMORY: 4G
+    volumes:
+      - mc-data:/data
+
+volumes:
+  mc-data: {}

examples/pixelmon/docker-compose.yml

@@ -0,0 +1,18 @@
+version: "3.8"
+
+services:
+  mc:
+    image: itzg/minecraft-server:java8-multiarch
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: "true"
+      TYPE: AUTO_CURSEFORGE
+      CF_SLUG: the-pixelmon-modpack
+      CF_FILENAME_MATCHER: "9.1.2"
+      MEMORY: 4G
+    volumes:
+      - mc-data:/data
+
+volumes:
+  mc-data: {}

examples/valhelsia2/docker-compose.yml

@@ -0,0 +1,21 @@
+version: '3.8'
+
+services:
+  mc:
+    image: itzg/minecraft-server:java8-multiarch
+    volumes:
+      - data:/data
+      - ./modpacks:/modpacks:ro
+    environment:
+      EULA: "true"
+      TYPE: FORGE
+      VERSION: "1.15.2"
+      GENERIC_PACK: /modpacks/Valhelsia_2-2.3.4-SERVER.zip
+      MEMORY: "2G"
+    ports:
+      - "25565:25565"
+    healthcheck:
+      test: NONE
+
+volumes:
+  data: {}

examples/vault-hunters-1-18-2/docker-compose.yml

@@ -0,0 +1,18 @@
+version: "3.8"
+
+services:
+  mc:
+    image: itzg/minecraft-server
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: "true"
+      TYPE: AUTO_CURSEFORGE
+      CF_SLUG: vault-hunters-1-18-2
+      CF_FILENAME_MATCHER: "Update-6H"
+      MEMORY: 4G
+    volumes:
+      - mc-data:/data
+
+volumes:
+  mc-data: {}

files/auto/autopause-daemon.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-. /autopause/autopause-fcns.sh
+. /auto/autopause-fcns.sh
 
 # shellcheck source=../../scripts/start-utils
 . "${SCRIPTS:-/}start-utils"
@@ -10,9 +10,7 @@ fi
 
 autopause_error_loop() {
   logAutopause "Available interfaces within the docker container:"
-  INTERFACES=$(echo /sys/class/net/*)
-  INTERFACES=${INTERFACES//\/sys\/class\/net\//}
-  logAutopause "  $INTERFACES"
+  logAutopause "  $(mc-image-helper network-interfaces)"
   logAutopause "Please set the environment variable AUTOPAUSE_KNOCK_INTERFACE to the interface that handles incoming connections."
   logAutopause "If unsure which interface to choose, run the ifconfig command in the container."
   logAutopause "Autopause failed to initialize. This log entry will be printed every 30 minutes."
@@ -37,7 +35,7 @@ if [[ -z "$AUTOPAUSE_KNOCK_INTERFACE" ]] ; then
   logAutopause "AUTOPAUSE_KNOCK_INTERFACE variable must not be empty!"
   autopause_error_loop
 fi
-if ! [[ -d "/sys/class/net/$AUTOPAUSE_KNOCK_INTERFACE" ]] ; then
+if ! mc-image-helper network-interfaces --check="$AUTOPAUSE_KNOCK_INTERFACE" ; then
   logAutopause "Selected interface \"$AUTOPAUSE_KNOCK_INTERFACE\" does not exist!"
   autopause_error_loop
 fi
@@ -76,7 +74,7 @@ do
     else
       if [[ $(current_uptime) -ge $TIME_THRESH ]] ; then
         logAutopause "No client connected since startup / knocked - pausing"
-        /autopause/pause.sh
+        /auto/pause.sh
         STATE=S
       fi
     fi
@@ -97,7 +95,7 @@ do
     else
       if [[ $(current_uptime) -ge $TIME_THRESH ]] ; then
         logAutopause "No client reconnected - pausing"
-        /autopause/pause.sh
+        /auto/pause.sh
         STATE=S
       fi
     fi
@@ -105,7 +103,7 @@ do
   XS)
     # Stopped
     if rcon_client_exists ; then
-      /autopause/resume.sh
+      /auto/resume.sh
     fi
     if java_running ; then
       if java_clients_connected ; then
@@ -113,7 +111,11 @@ do
         STATE=E
       else
         TIME_THRESH=$(($(current_uptime)+$AUTOPAUSE_TIMEOUT_KN))
-        logAutopause "Server was knocked - waiting for clients or timeout"
+        from=unknown
+        if [ -e /var/log/knocked-source ]; then
+          from=$(cat /var/log/knocked-source)
+        fi
+        logAutopause "Server was knocked from $from - waiting for clients or timeout"
         STATE=K
       fi
     fi

files/auto/autopause-fcns.sh

@@ -23,7 +23,9 @@ mc_server_listening() {
 java_clients_connections() {
   local connections
   if java_running ; then
-    connections=$(mc-monitor status --host localhost --port "$SERVER_PORT" --show-player-count)
+    if ! connections=$(mc-monitor status --host localhost --port "$SERVER_PORT" --show-player-count); then
+      connections=0
+    fi
   else
     connections=0
   fi
@@ -32,4 +34,4 @@ java_clients_connections() {
 
 java_clients_connected() {
   (( $(java_clients_connections) > 0 ))
-}
+}

files/auto/autostop-daemon.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 # needed for the clients connected function residing in autopause
-. /autopause/autopause-fcns.sh
+. /auto/autopause-fcns.sh
 
 # shellcheck source=../../scripts/start-utils
 . "${SCRIPTS:-/}start-utils"
@@ -40,7 +40,7 @@ do
     else
       if [[ $(current_uptime) -ge $TIME_THRESH ]] ; then
         logAutostop "No client connected since startup - stopping server"
-        /autostop/stop.sh
+        /auto/stop.sh
         exit 0
       fi
     fi
@@ -61,7 +61,7 @@ do
     else
       if [[ $(current_uptime) -ge $TIME_THRESH ]] ; then
         logAutostop "No client reconnected - stopping"
-        /autostop/stop.sh
+        /auto/stop.sh
         exit 0
       fi
     fi

files/auto/knockd-config.cfg

@@ -3,13 +3,13 @@
 [unpauseMCServer-server]
  sequence = 25565
  seq_timeout = 1
- command = /autopause/resume.sh
+ command = /auto/resume.sh %IP%
  tcpflags = syn
 [unpauseMCServer-rcon]
  sequence = 25575
  seq_timeout = 1
- command = /autopause/resume.sh
+ command = /auto/resume.sh %IP%
  tcpflags = syn
 [unpauseMCServer-bedrock]
  sequence = 19132:udp
- command = /autopause/resume.sh
+ command = /auto/resume.sh %IP%

files/auto/pause.sh

@@ -21,4 +21,7 @@ if [[ $( ps -ax -o stat,comm | grep 'java' | awk '{ print $1 }') =~ ^S.*$ ]] ; t
   # finally pause the process
   logAutopauseAction "Pausing Java process"
   pkill -STOP java
+
+  # create .paused file in data directory
+  touch /data/.paused
 fi

files/auto/resume.sh

@@ -6,6 +6,10 @@ if isTrue "${DEBUG_AUTOPAUSE}"; then
 fi
 
 if [[ $( ps -ax -o stat,comm | grep 'java' | awk '{ print $1 }') =~ ^T.*$ ]] ; then
-  logAutopauseAction "Knocked, resuming Java process"
+  logAutopauseAction "Knocked from $1, resuming Java process"
+  echo "$1" > /var/log/knocked-source
   pkill -CONT java
+
+  # remove .paused file from data directory
+  rm -f /data/.paused
 fi

files/auto/stop.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+. /start-utils
+if isTrue "${DEBUG_AUTOSTOP}"; then
+  set -x
+fi
+
+logAutostopAction "Stopping Java process"
+if isTrue "${AUTOSTOP_PKILL_USE_SUDO:-false}"; then
+  sudo pkill -f --signal SIGTERM mc-server-runner
+else
+  pkill -f --signal SIGTERM mc-server-runner
+fi

files/autostop/stop.sh

@@ -1,9 +0,0 @@
-#!/bin/bash
-
-. /start-utils
-if isTrue "${DEBUG_AUTOSTOP}"; then
-  set -x
-fi
-
-logAutostopAction "Stopping Java process"
-kill -SIGTERM 1

files/cf-exclude-include.json

@@ -0,0 +1,28 @@
+{
+  "globalExcludes": [
+    "carry-on",
+    "defensive-measures",
+    "dynamiclights-reforged",
+    "entity-texture-features-fabric",
+    "entityculling",
+    "extreme-sound-muffler",
+    "ignitioncoil",
+    "legendary-tooltips",
+    "nekos-enchanted-books",
+    "not-enough-animations",
+    "oculus",
+    "rubidium",
+    "rubidium-extra",
+    "magnesium-extras",
+    "skin-layers-3d",
+    "textrues-rubidium-options",
+    "torohealth-damage-indicators"
+  ],
+  "modpacks": {
+    "all-of-fabric-6": {
+      "forceIncludes": [
+        "revelationary"
+      ]
+    }
+  }
+}

kustomize/README.md

@@ -0,0 +1,22 @@
+This directory provides a base to use with [kubectl kustomize](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/).
+
+## Example overlay content
+
+### kustomization.yml
+```yaml
+nameSuffix: "-forge"
+commonLabels:
+  server: forge
+bases:
+  - https://github.com/itzg/docker-minecraft-server.git/kustomize/base
+configMapGenerator:
+  - name: mc
+    envs:
+      - mc.env
+```
+
+### mc.env
+```
+EULA=true
+TYPE=FORGE
+```

kustomize/base/kustomization.yml

@@ -0,0 +1,3 @@
+resources:
+- statefulset.yml
+- service.yml

kustomize/base/service.yml

@@ -0,0 +1,17 @@
+apiVersion: v1
+kind: Service
+metadata:
+  labels:
+    service: mc
+  annotations: {}
+  # Such as
+  #   mc-router.itzg.me/externalServerName: $(EXTERNAL_SERVICE_NAME)
+  name: mc
+spec:
+  ports:
+    - name: minecraft
+      port: 25565
+      targetPort: 25565
+  type: NodePort
+  selector:
+    server: mc

kustomize/base/statefulset.yml

@@ -0,0 +1,51 @@
+apiVersion: apps/v1
+kind: StatefulSet
+metadata:
+  name: mc
+spec:
+  replicas: 1
+  serviceName: mc
+  selector:
+    matchLabels:
+      server: mc
+  template:
+    metadata:
+      labels:
+        server: mc
+    spec:
+      containers:
+        - name: mc
+          envFrom:
+            - configMapRef:
+                name: mc
+                optional: true
+          env: []
+          image: itzg/minecraft-server
+          stdin: true
+          tty: true
+          volumeMounts:
+            - mountPath: /data
+              name: data
+          resources:
+            requests:
+              cpu: 150m
+          livenessProbe:
+            exec:
+              command: ["mc-health"]
+            initialDelaySeconds: 120
+            periodSeconds: 60
+          readinessProbe:
+            exec:
+              command: ["mc-health"]
+            initialDelaySeconds: 20
+            periodSeconds: 10
+            failureThreshold: 12
+  volumeClaimTemplates:
+    - metadata:
+        name: data
+      spec:
+        accessModes:
+          - ReadWriteOnce
+        resources:
+          requests:
+            storage: 500Mi

scripts/start-autopause

@@ -24,7 +24,7 @@ log "Autopause functionality enabled"
 
 isDebugging && set -x
 
-cp /autopause/knockd-config.cfg /tmp/knockd-config.cfg
+cp /auto/knockd-config.cfg /tmp/knockd-config.cfg
 
 # update server port to listen to
 regseq="^\s*sequence\s*=\s*$SERVER_PORT\s*$"
@@ -84,4 +84,4 @@ elif [[ -z "$MAX_TICK_TIME" ]] ; then
   export MAX_TICK_TIME
 fi
 
-/autopause/autopause-daemon.sh &
+/auto/autopause-daemon.sh &

scripts/start-autostop

@@ -41,4 +41,4 @@ if ! [[ $AUTOSTOP_TIMEOUT_INIT =~ ^[0-9]+$ ]] ; then
   log "Warning: AUTOSTOP_TIMEOUT_INIT is not numeric, set to 1800 (seconds)"
 fi
 
-/autostop/autostop-daemon.sh &
+/auto/autostop-daemon.sh &

scripts/start-configuration

@@ -16,9 +16,15 @@ IFS=$'\n\t'
 : "${RCON_CMDS_LAST_DISCONNECT:=}"
 : "${RCON_CMDS_PERIOD:=10}"
 : "${RCON_PASSWORD_FILE:=}"
+: "${ENABLE_RCON:=true}"
 : "${RCON_PASSWORD:=minecraft}"
 : "${RCON_PORT:=25575}"
-export RCON_PASSWORD RCON_PORT
+export ENABLE_RCON RCON_PASSWORD RCON_PORT
+
+: "${MEMORY=1G}"
+: "${INIT_MEMORY=${MEMORY}}"
+: "${MAX_MEMORY=${MEMORY}}"
+export MEMORY INIT_MEMORY MAX_MEMORY
 
 shopt -s nullglob
 
@@ -130,11 +136,11 @@ cd /data || exit 1
 export ORIGINAL_TYPE=${TYPE^^}
 
 if isTrue "${ENABLE_AUTOPAUSE}"; then
-  ${SCRIPTS:-/}start-autopause
+  "${SCRIPTS:-/}start-autopause"
 fi
 
 if isTrue "${ENABLE_AUTOSTOP}"; then
-  ${SCRIPTS:-/}start-autostop
+  "${SCRIPTS:-/}start-autostop"
 fi
 
 if 
@@ -146,7 +152,7 @@ if
 then
   log "Starting RCON commands"
   # shellcheck source=start-rconcmds
-  ${SCRIPTS:-/}start-rconcmds
+  "${SCRIPTS:-/}start-rconcmds"
 fi
 
 if versionLessThan 1.7; then
@@ -190,6 +196,10 @@ case "${TYPE^^}" in
     exec "${SCRIPTS:-/}start-deployCF" "$@"
   ;;
 
+  AUTO_CURSEFORGE)
+    exec "${SCRIPTS:-/}start-deployAutoCF" "$@"
+    ;;
+
   VANILLA)
     exec "${SCRIPTS:-/}start-deployVanilla" "$@"
   ;;

scripts/start-deployAutoCF

@@ -0,0 +1,72 @@
+#!/bin/bash
+set -eu
+
+# shellcheck source=start-utils
+. "${SCRIPTS:-/}start-utils"
+
+: "${CF_PAGE_URL:=}"
+: "${CF_SLUG:=}"
+: "${CF_FILE_ID:=}"
+: "${CF_FILENAME_MATCHER:=}"
+: "${CF_PARALLEL_DOWNLOADS:=4}"
+: "${CF_FORCE_SYNCHRONIZE:=false}"
+: "${CF_EXCLUDE_INCLUDE_FILE:=https://raw.githubusercontent.com/itzg/docker-minecraft-server/master/files/cf-exclude-include.json}"
+: "${CF_EXCLUDE_MODS:=}"
+: "${CF_FORCE_INCLUDE_MODS:=}"
+: "${CF_SET_LEVEL_FROM:=}" # --set-level-from
+: "${CF_OVERRIDES_SKIP_EXISTING:=false}" # --overrides-skip-existing
+
+
+resultsFile=/data/.install-curseforge.env
+
+isDebugging && set -x
+
+args=(
+  --results-file="$resultsFile"
+)
+if [[ $CF_PAGE_URL ]]; then
+  args+=(--modpack-page-url="$CF_PAGE_URL")
+fi
+if [[ $CF_FILE_ID ]]; then
+  args+=(--file-id="$CF_FILE_ID")
+fi
+if [[ $CF_SLUG ]]; then
+  args+=(--slug="$CF_SLUG")
+fi
+if [[ $CF_FILENAME_MATCHER ]]; then
+  args+=(--filename-matcher="$CF_FILENAME_MATCHER")
+fi
+if [[ ${CF_SET_LEVEL_FROM} ]]; then
+  args+=(--set-level-from="$CF_SET_LEVEL_FROM")
+fi
+args+=(
+  --parallel-downloads="$CF_PARALLEL_DOWNLOADS"
+  --force-synchronize="$CF_FORCE_SYNCHRONIZE"
+  --overrides-skip-existing="$CF_OVERRIDES_SKIP_EXISTING"
+)
+
+if [[ $CF_EXCLUDE_MODS || $CF_FORCE_INCLUDE_MODS ]]; then
+  if [[ $CF_EXCLUDE_MODS ]]; then
+    args+=( --exclude-mods="$CF_EXCLUDE_MODS" )
+  fi
+  if [[ $CF_FORCE_INCLUDE_MODS ]]; then
+    args+=( --force-include-mods="$CF_FORCE_INCLUDE_MODS" )
+  fi
+else
+  if [[ $CF_EXCLUDE_INCLUDE_FILE ]]; then
+    args+=( --exclude-include-file="$CF_EXCLUDE_INCLUDE_FILE" )
+  fi
+fi
+
+if ! mc-image-helper install-curseforge "${args[@]}"; then
+    log "ERROR failed to auto-install CurseForge modpack"
+    exit 1
+fi
+
+# grab SERVER, FAMILY and export it
+set -a
+# shellcheck disable=SC1090
+source "${resultsFile}"
+set +a
+
+exec "${SCRIPTS:-/}start-setupWorld" "$@"

scripts/start-deployBukkitSpigot

@@ -72,7 +72,7 @@ function downloadSpigot {
   fi
 
   setServerVar
-  if [ -f $SERVER ]; then
+  if [ -f "$SERVER" ] && ! isTrue "$FORCE_REDOWNLOAD"; then
     # tell curl to only download when newer
     curlArgs="-z $SERVER"
   fi
@@ -80,7 +80,7 @@ function downloadSpigot {
     curlArgs="$curlArgs -v"
   fi
   log "Downloading $match from $downloadUrl ..."
-  curl -fsSL -o $SERVER $curlArgs "$downloadUrl"
+  curl -fsSL -o "$SERVER" $curlArgs "$downloadUrl"
   if [[ $? != 0 || $(grep -c "DOCTYPE html" $SERVER) != 0 ]]; then
     cat <<EOF
 
@@ -92,12 +92,12 @@ ERROR: failed to download from $downloadUrl
 
 EOF
 
-    if isDebugging && [[ $(grep -c "DOCTYPE html" $SERVER) != 0 ]]; then
-      cat $SERVER
+    if isDebugging && [[ $(grep -c "DOCTYPE html" "$SERVER") != 0 ]]; then
+      cat "$SERVER"
     fi
 
     # remove invalid download
-    rm $SERVER
+    rm "$SERVER"
     exit 3
   fi
 
@@ -118,7 +118,7 @@ function setServerVar {
 
 if isTrue "$BUILD_SPIGOT_FROM_SOURCE" || isTrue "$BUILD_FROM_SOURCE"; then
   setServerVar
-  if [ ! -f $SERVER ] || [ -n "$FORCE_REDOWNLOAD" ]; then
+  if [ ! -f "$SERVER" ] || isTrue "$FORCE_REDOWNLOAD"; then
     buildSpigotFromSource
   fi
 else

scripts/start-deployCF

@@ -144,11 +144,13 @@ findStartScript() {
     -o -name ServerStartLinux.sh
     -o -name LaunchServer.sh
     -o -name server-start.sh
+    -o -name SERVER-START.sh
     -o -name start-server.sh
     -o -name startserver.sh
     -o -name StartServer.sh
     -o -name run.sh
     -o -name start.sh
+    -o -name launch.sh
   )
 
   if [ -d "${FTB_BASE_DIR}" ]; then

scripts/start-deployFTBA

@@ -46,10 +46,9 @@ if ! [ -f "${ftbInstallMarker}" ] || [ "$(cat "${ftbInstallMarker}")" != "${FTB_
     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
+  log "This could take a while..."
+  ${ftbInstaller} "${FTB_MODPACK_ID}" "${FTB_MODPACK_VERSION_ID}" --noscript --auto > ftb-installer.log
   rm -f forge*installer.jar
 
   echo "${FTB_MODPACK_ID}=${FTB_MODPACK_VERSION_ID}" > ${ftbInstallMarker}
@@ -62,7 +61,6 @@ 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)
 fabricVersion=$(jq -r '.targets|unique[] | select(.name == "fabric") | .version' version.json)
 mcVersion=$(jq -r '.targets|unique[] | select(.name == "minecraft") | .version' version.json)

scripts/start-deployFabric

@@ -4,47 +4,49 @@ set -eu
 # shellcheck source=start-utils
 . "${SCRIPTS:-/}start-utils"
 
-requireVar VANILLA_VERSION
 export TYPE=FABRIC
 : "${FABRIC_LAUNCHER_VERSION:=${FABRIC_INSTALLER_VERSION:-LATEST}}"
 : "${FABRIC_LAUNCHER:=}"
 : "${FABRIC_LAUNCHER_URL:=}"
 : "${FABRIC_LOADER_VERSION:=LATEST}"
 
+resultsFile=/data/.install-fabric.env
+
 isDebugging && set -x
 
 # Custom fabric jar
 if [[ $FABRIC_LAUNCHER ]]; then
-  export SERVER=${FABRIC_LAUNCHER}
+  if ! mc-image-helper install-fabric-loader \
+    --results-file=${resultsFile} \
+    --from-local-file="$FABRIC_LAUNCHER"; then
+    log "ERROR failed to install Fabric launcher from $FABRIC_LAUNCHER"
+    exit 1
+  fi
 # Custom fabric jar url
 elif [[ $FABRIC_LAUNCHER_URL ]]; then
-  export SERVER=fabric-server-$(echo -n "$FABRIC_LAUNCHER_URL" | mc-image-helper hash)
+  if ! mc-image-helper install-fabric-loader \
+    --results-file=${resultsFile} \
+    --from-url="$FABRIC_LAUNCHER_URL"; then
+    log "ERROR failed to install Fabric launcher from $FABRIC_LAUNCHER_URL"
+    exit 1
+  fi
 # Official fabric launcher
 else
-  if [[ ${FABRIC_LAUNCHER_VERSION^^} = LATEST ]]; then
-    log "Checking Fabric Launcher version information."
-    FABRIC_LAUNCHER_VERSION=$(maven-metadata-release https://maven.fabricmc.net/net/fabricmc/fabric-installer/maven-metadata.xml)
-  fi
-  if [[ ${FABRIC_LOADER_VERSION^^} = LATEST ]]; then
-    log "Checking Fabric Loader version information."
-    FABRIC_LOADER_VERSION=$(maven-metadata-release https://maven.fabricmc.net/net/fabricmc/fabric-loader/maven-metadata.xml)
-  fi
-  export SERVER=fabric-server-mc.${VANILLA_VERSION}-loader.${FABRIC_LOADER_VERSION}-launcher.${FABRIC_LAUNCHER_VERSION}.jar
-  export FABRIC_LAUNCHER_URL="https://meta.fabricmc.net/v2/versions/loader/${VANILLA_VERSION}/${FABRIC_LOADER_VERSION}/${FABRIC_LAUNCHER_VERSION}/server/jar"
-fi
-
-if [[ ! -e ${SERVER} && ! -z ${FABRIC_LAUNCHER_URL} ]]; then
-  log "Downloading $FABRIC_LAUNCHER_URL ..."
-  if ! get -o "$SERVER" "$FABRIC_LAUNCHER_URL"; then
-    log "Failed to download from given location $FABRIC_LAUNCHER_URL"
-    exit 2
+  if ! mc-image-helper install-fabric-loader \
+    --results-file=${resultsFile} \
+    --minecraft-version="${VANILLA_VERSION}" \
+    --installer-version="${FABRIC_LAUNCHER_VERSION}" \
+    --loader-version="${FABRIC_LOADER_VERSION}"; then
+    log "ERROR failed to install Fabric launcher from $VANILLA_VERSION, $FABRIC_LAUNCHER_VERSION, $FABRIC_LOADER_VERSION"
+    exit 1
   fi
 fi
 
-if [[ ! -e ${SERVER} ]]; then
-  log "$SERVER does not exist, cannot launch server!"
-  exit 1
-fi
+# grab SERVER and export it
+set -a
+# shellcheck disable=SC1090
+source "${resultsFile}"
+set +a
 
 export FAMILY=FABRIC
 exec "${SCRIPTS:-/}start-setupWorld" "$@"

scripts/start-deployForge

@@ -1,160 +1,42 @@
 #!/bin/bash
 
-: "${FORGEVERSION:=RECOMMENDED}"
+: "${FORGE_VERSION:=${FORGEVERSION:-RECOMMENDED}}"
+: "${FORGE_FORCE_REINSTALL:=false}}"
 
 # shellcheck source=start-utils
 . "${SCRIPTS:-$(dirname "$0")}/start-utils"
 isDebugging && set -x
 
-get_installer() {
-  if [[ -z $FORGE_INSTALLER_URL ]]; then
-    log "Downloading Forge Installer $normForgeVersion"
-
-    forgeFileNames="
-    $shortForgeVersion/forge-$shortForgeVersion-installer.jar
-    $normForgeVersion/forge-$normForgeVersion-installer.jar
-  "
-
-    for fn in $forgeFileNames; do
-      downloadUrl=https://maven.minecraftforge.net/net/minecraftforge/forge/$fn
-      log "...trying $downloadUrl"
-      if get -o "$FORGE_INSTALLER" "$downloadUrl"; then
-        return
-      fi
-    done
-    log "Unable to locate usable URL for $normForgeVersion"
-    exit 2
- else
-    log "Downloading Forge Installer from $FORGE_INSTALLER_URL ..."
-    if ! get -o "$FORGE_INSTALLER" "$FORGE_INSTALLER_URL"; then
-      log "Failed to download from given location $FORGE_INSTALLER_URL"
-      exit 2
-    fi
-  fi
-}
-
-install() {
-  if [ ! -e "$FORGE_INSTALLER" ]; then
-    get_installer "$normForgeVersion" "$shortForgeVersion"
+if [[ ${FORGE_INSTALLER} ]]; then
+  if ! mc-image-helper install-forge \
+    --output-directory=/data \
+    --results-file=/data/.run-forge.env \
+    --minecraft-version="${VANILLA_VERSION}" \
+    --forge-installer="${FORGE_INSTALLER}" \
+    --force-reinstall="${FORGE_FORCE_REINSTALL}"; then
+      log "ERROR failed to install Forge given installer ${FORGE_INSTALLER}"
+      exit 1
   fi
 
-  # reference issue #1459
-  rm -f run.sh
-
-  log "Installing Forge $shortForgeVersion. This might take a minute or two..."
-  mkdir -p mods
-  tries=3
-  while true; do
-    if ! java -jar "$FORGE_INSTALLER" --installServer &> forge-installer.log; then
-      if ((--tries <= 0)); then
-        cat forge-installer.log
-        log "
-ERROR Forge failed to install after several tries.
-"
-        exit 1
-      fi
-      log "Install failed. Trying again..."
-    else
-      break # out of this loop
-    fi
-  done
-  # NOTE $shortForgeVersion will be empty if installer location was given to us
-  log "Finding installed server jar..."
-  unset -v latest
-  # 1.17+ ?
-  if [ -f /data/run.sh ]; then
-    latest=/data/run.sh
-  # else pre 1.17
-  else
-    for file in *forge*.jar; do
-      if ! [[ $file =~ installer ]]; then
-        if [[ -z $latest ]] || [[ $file -nt $latest ]]; then
-          latest=$file
-        fi
-      fi
-    done
-  fi
-  if [[ -z $latest ]]; then
-    log "Unable to derive server jar for Forge"
-    exit 2
-  fi
-
-  export SERVER=$latest
-  log "Using server $SERVER"
-  debug "Writing install marker at $installMarker"
-  echo "$SERVER" > "$installMarker"
-}
-
-resolve_versions() {
-  if [[ -z $FORGE_INSTALLER && -z $FORGE_INSTALLER_URL ]]; then
-    norm=$VANILLA_VERSION
-
-    case $VANILLA_VERSION in
-      *.*.*)
-        norm=$VANILLA_VERSION ;;
-      *.*)
-        norm=${VANILLA_VERSION}.0 ;;
-    esac
-
-    #################################################################################
-    promosUrl=http://files.minecraftforge.net/maven/net/minecraftforge/forge/promotions_slim.json
-
-    log "Checking Forge version information."
-    case $FORGEVERSION in
-      LATEST)
-        if ! FORGE_VERSION=$(get --json-path ".promos['$VANILLA_VERSION-latest']" --json-value-when-missing "" "$promosUrl"); then
-          log "ERROR: Version $VANILLA_VERSION is not supported by Forge"
-          log "       Refer to http://files.minecraftforge.net/ for supported versions"
-          exit 2
-        fi
-        ;;
-
-      RECOMMENDED)
-        if ! FORGE_VERSION=$(get --json-path ".promos['$VANILLA_VERSION-recommended']" --json-value-when-missing "" "$promosUrl"); then
-          if ! FORGE_VERSION=$(get --json-path ".promos['$VANILLA_VERSION-latest']" --json-value-when-missing "" "$promosUrl"); then
-            log "ERROR: Version $VANILLA_VERSION is not supported by Forge"
-            log "       Refer to http://files.minecraftforge.net/ for supported versions"
-            exit 2
-          fi
-        fi
-        ;;
-
-      *)
-        FORGE_VERSION=$FORGEVERSION
-        ;;
-    esac
-
-    normForgeVersion=$VANILLA_VERSION-$FORGE_VERSION-$norm
-    shortForgeVersion=$VANILLA_VERSION-$FORGE_VERSION
-
-    FORGE_INSTALLER="/tmp/forge-$shortForgeVersion-installer.jar"
-  elif [[ -z $FORGE_INSTALLER ]]; then
-    FORGE_INSTALLER="/tmp/forge-installer.jar"
-  elif [[ ! -e $FORGE_INSTALLER ]]; then
-    log "ERROR: the given Forge installer doesn't exist : $FORGE_INSTALLER"
-    exit 2
-  else
-    shortForgeVersion=$VANILLA_VERSION-${FORGE_INSTALLER_CUSTOM_VERSION:-custom}
-  fi
-}
-
-### main
-
-resolve_versions
-
-installMarker="/data/.forge-installed-$shortForgeVersion"
-
-if [ ! -e "$installMarker" ] || isTrue "${FORCE_REINSTALL:-false}"; then
-  install
 else
-  SERVER=$(cat "$installMarker")
-  export SERVER
-  if [ ! -e "$SERVER" ]; then
-    rm "$installMarker"
-    install
+  if ! mc-image-helper install-forge \
+    --output-directory=/data \
+    --results-file=/data/.run-forge.env \
+    --minecraft-version="${VANILLA_VERSION}" \
+    --forge-version="${FORGE_VERSION}" \
+    --force-reinstall="${FORGE_FORCE_REINSTALL}"; then
+      log "ERROR failed to install Forge"
+      exit 1
   fi
+
 fi
 
+
+# grab SERVER and export it
+set -a
+source /data/.run-forge.env
+set +a
+
 export FAMILY=FORGE
 
 exec "${SCRIPTS:-/}start-setupWorld" "$@"

scripts/start-deployVanilla

@@ -8,7 +8,6 @@ set -o pipefail
 export SERVER="minecraft_server.${VANILLA_VERSION// /_}.jar"
 
 if [ ! -e "$SERVER" ] || [ -n "$FORCE_REDOWNLOAD" ]; then
-  log "Locating download for $SERVER ..."
   debug "Finding version manifest for $VANILLA_VERSION"
   versionManifestUrl=$(get 'https://launchermeta.mojang.com/mc/game/version_manifest.json' | jq --arg VANILLA_VERSION "$VANILLA_VERSION" --raw-output '[.versions[]|select(.id == $VANILLA_VERSION)][0].url')
   result=$?
@@ -30,6 +29,7 @@ if [ ! -e "$SERVER" ] || [ -n "$FORCE_REDOWNLOAD" ]; then
     exit 1
   fi
 
+  log "Downloading $VANILLA_VERSION server..."
   debug "Downloading server from $serverDownloadUrl"
   get -o "$SERVER" "$serverDownloadUrl"
   result=$?

scripts/start-finalExec

@@ -1,5 +1,8 @@
 #!/bin/bash
 
+: "${DEBUG_EXEC:=false}"
+: "${SETUP_ONLY:=false}"
+
 # shellcheck source=start-utils
 . "${SCRIPTS:-/}start-utils"
 isDebugging && set -x
@@ -83,23 +86,13 @@ if isTrue ${ENABLE_ROLLING_LOGS:-false}; then
   LOGFILE="/data/log4j2.xml"
   if [ ! -e "$LOGFILE" ]; then
     log "Creating log4j2.xml in ${LOGFILE}"
-    cp /tmp/log4j2.xml "$LOGFILE"
+    cp /image/log4j2.xml "$LOGFILE"
   else
     log "log4j2.xml already created, skipping"
   fi
   JVM_OPTS="-Dlog4j.configurationFile=/data/log4j2.xml ${JVM_OPTS}"
 fi
 
-# Make sure files exist and are valid JSON (for pre-1.12 to 1.12 upgrades)
-log "Checking for JSON files."
-JSON_FILES=$(find /data -maxdepth 1 -name '*.json')
-for j in $JSON_FILES; do
-  if [[ $(cat "$j" | sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//') == "" ]]; then
-    log "Fixing JSON $j"
-    echo '[]' > $j
-  fi
-done
-
 # Optional disable console
 if versionLessThan 1.14 && [[ ${CONSOLE,,} = false ]]; then
   EXTRA_ARGS+=" --noconsole"
@@ -110,10 +103,6 @@ if [[ ${GUI,,} = false ]]; then
   EXTRA_ARGS+=" nogui"
 fi
 
-: "${MEMORY=1G}"
-: "${INIT_MEMORY=${MEMORY}}"
-: "${MAX_MEMORY=${MEMORY}}"
-
 expandedDOpts=
 if [ -n "$JVM_DD_OPTS" ]; then
       for dopt in $JVM_DD_OPTS
@@ -214,7 +203,7 @@ function copyFilesForCurseForge() {
   [ -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
+  if [ ! -e "${FTB_DIR}/server-icon.png" ] && [ -e /data/server-icon.png ]; then
     cp -f /data/server-icon.png "${FTB_DIR}/"
   fi
 
@@ -234,10 +223,10 @@ if [[ ${TYPE} == "CURSEFORGE" && "${SERVER}" ]]; then
 
   cd "${FTB_DIR}" || (log "ERROR: can't go into ${FTB_DIR}"; exit 1)
   log "Starting CurseForge server in ${FTB_DIR}..."
-  if isTrue ${DEBUG_EXEC}; then
+  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
+  exec mc-server-runner ${bootstrapArgs} "${mcServerRunnerArgs[@]}" java $JVM_XX_OPTS $JVM_OPTS $expandedDOpts -jar "$(basename "${SERVER}")" "$@" $EXTRA_ARGS
 elif [[ ${TYPE} == "CURSEFORGE" ]]; then
   mcServerRunnerArgs+=(--shell bash)
 
@@ -259,15 +248,15 @@ EOF
 
   finalArgs="${FTB_SERVER_START}"
 
-  if isTrue "${SETUP_ONLY:=false}"; then
+  if isTrue "${SETUP_ONLY}"; then
     echo "SETUP_ONLY: ${finalArgs}"
     exit
   fi
 
-  if isTrue ${DEBUG_EXEC}; then
+  if isTrue "${DEBUG_EXEC}"; then
     set -x
   fi
-  if isTrue ${EXEC_DIRECTLY:-false}; then
+  if isTrue "${EXEC_DIRECTLY:-false}"; then
     "${finalArgs[@]}"
   else
     exec mc-server-runner "${mcServerRunnerArgs[@]}" "${finalArgs[@]}"
@@ -275,7 +264,7 @@ EOF
 elif [[ $SERVER =~ run.sh ]]; then
   log "Using Forge supplied run.sh script..."
   echo $JVM_XX_OPTS $JVM_OPTS $expandedDOpts > user_jvm_args.txt
-  if isTrue ${SETUP_ONLY:=false}; then
+  if isTrue ${SETUP_ONLY}; then
     echo "SETUP_ONLY: bash ${SERVER}"
     exit
   fi
@@ -288,6 +277,7 @@ else
 
   log "Starting the Minecraft server..."
 
+  # shellcheck disable=SC2206
   finalArgs=(
     $JVM_XX_OPTS
     $JVM_OPTS
@@ -296,7 +286,7 @@ else
     "$@" $EXTRA_ARGS
   )
 
-  if isTrue ${SETUP_ONLY:=false}; then
+  if isTrue ${SETUP_ONLY}; then
     echo "SETUP_ONLY: java ${finalArgs[*]}"
     exit
   fi

scripts/start-rconcmds

@@ -33,4 +33,4 @@ if [ "$RCON_CMDS_PERIOD" -eq "0" ] ; then
   log "Warning: RCON_CMDS_PERIOD must not be 0, set to 10 (seconds)"
 fi
 
-/rconcmds/rcon-cmds-daemon.sh &
+/usr/local/bin/rcon-cmds-daemon.sh &

scripts/start-setupEnvVariables

@@ -17,7 +17,7 @@ set -e
 if isTrue "${REPLACE_ENV_IN_PLACE}"; then
   log "Replacing env variables in ${REPLACE_ENV_PATHS} that match the prefix $REPLACE_ENV_VARIABLE_PREFIX ..."
 
-  mc-image-helper --debug=${DEBUG} interpolate \
+  mc-image-helper interpolate \
     --replace-env-file-suffixes="${REPLACE_ENV_SUFFIXES}" \
     --replace-env-excludes="${REPLACE_ENV_VARIABLES_EXCLUDES}" \
     --replace-env-exclude-paths="${REPLACE_ENV_VARIABLES_EXCLUDE_PATHS}" \
@@ -27,7 +27,7 @@ fi
 
 if [[ ${PATCH_DEFINITIONS} ]]; then
   log "Applying patch definitions from ${PATCH_DEFINITIONS}"
-  mc-image-helper --debug=${DEBUG} patch \
+  mc-image-helper patch \
     --patch-env-prefix="${REPLACE_ENV_VARIABLE_PREFIX}" \
     "${PATCH_DEFINITIONS}"
 fi

scripts/start-setupModpack

@@ -22,39 +22,26 @@ if isTrue "${REMOVE_OLD_MODS}" && [ -z "${MODS_FILE}" ]; then
   rm -f "$sum_file"
 fi
 
-# If packwiz url passed, bootstrap packwiz and update mods before other modpack processing
-if [[ "${PACKWIZ_URL:-}" ]]; then
-  # Ensure we have the latest packwiz bootstrap installer
-  latestPackwiz=$(curl -fsSL https://api.github.com/repos/packwiz/packwiz-installer-bootstrap/releases/latest)
-  if [[ -z "${latestPackwiz}" ]]; then
-    log "WARNING: Could not retrieve Packwiz bootstrap installer release information"
-  else
-    isDebugging && log "Latest packwiz ${latestPackwiz}"
-    latestPackwizVer=$(echo "${latestPackwiz}" | jq --raw-output '.tag_name')
-    latestPackwizUrl=$(echo "${latestPackwiz}" | jq --raw-output '.assets[] | select(.name | match("packwiz-installer-bootstrap.jar")) | .url')
-   : "${PACKWIZ_BOOTSTRAP_JAR:=packwiz-installer-bootstrap_${latestPackwizVer}.jar}"
-   if [[ ! -e $PACKWIZ_BOOTSTRAP_JAR ]]; then
-      log "Downloading Packwiz ${latestPackwizVer}"
-      if ! curl -H "Accept:application/octet-stream" -o "$PACKWIZ_BOOTSTRAP_JAR" -fsSL ${latestPackwizUrl}; then
-        log "ERROR: failed to download Packwiz bootstrap installer"
-        exit 1
-      fi
+function handlePackwiz() {
+  # If packwiz url passed, bootstrap packwiz and update mods before other modpack processing
+  if [[ "${PACKWIZ_URL:-}" ]]; then
+    if ! packwizInstaller=$(mc-image-helper maven-download \
+                           --maven-repo=https://maven.packwiz.infra.link/repository/release/ \
+                           --group=link.infra.packwiz --artifact=packwiz-installer --classifier=dist \
+                           --skip-existing); then
+      log "ERROR: failed to get packwiz installer"
+      exit 1
+    fi
+
+    log "Running packwiz installer against URL: ${PACKWIZ_URL}"
+    if ! java -cp "${packwizInstaller}" link.infra.packwiz.installer.Main -s server "${PACKWIZ_URL}"; then
+      log "ERROR failed to run packwiz installer"
+      exit 1
     fi
   fi
-  log "Running packwiz installer against URL: ${PACKWIZ_URL}"
-  java -jar "${PACKWIZ_BOOTSTRAP_JAR}" -g -s server "${PACKWIZ_URL}"
-  #if bootstrap download fails, download installer manually - then run without updating
-  returnVal=$?
-  if [[ $returnVal ]]; then
-    latestPackwizInstaller=$(curl -fsSL https://api.github.com/repos/packwiz/packwiz-installer/releases/latest)
-    latestPackwizInstallerVer=$(echo "${latestPackwizInstaller}" | jq --raw-output '.tag_name')
-    latestPackwizInstallerUrl=$(echo "${latestPackwizInstaller}" | jq --raw-output '.assets[] | select(.name | match("packwiz-installer.jar")) | .url')
-    log "Packwiz couldn't update - Downloading Packwiz Installer ${latestPackwizInstallerVer}"
-    curl -H "Accept:application/octet-stream" -o "packwiz-installer.jar" -fsSL "${latestPackwizInstallerUrl}"
-    java -jar "${PACKWIZ_BOOTSTRAP_JAR}" -g -bootstrap-no-update -s server "${PACKWIZ_URL}"
-  fi
-fi
+}
 
+function handleModpackListOrFile() {
 # If supplied with a URL for a modpack (simple zip of jars), download it and unpack
 if [[ "$MODPACK" ]]; then
   if isURL "${MODPACK}"; then
@@ -149,13 +136,15 @@ elif [[ "$MODS_FILE" ]]; then
     exit 1
   fi
 fi
+}
 
+function handleCurseForgeManifest() {
 if [[ "$MANIFEST" ]]; then
     if [[ -e "$MANIFEST" ]]; then
         EFFECTIVE_MANIFEST_FILE=$MANIFEST
     elif isURL "$MANIFEST"; then
         EFFECTIVE_MANIFEST_FILE=/tmp/manifest.json
-        EFFECTIVE_MANIFEST_URL=$(curl -Ls -o /dev/null -w %{effective_url} $MANIFEST)
+        EFFECTIVE_MANIFEST_URL=$(curl -Ls -o /dev/null -w "%{effective_url}" "$MANIFEST")
         curl -Ls -o $EFFECTIVE_MANIFEST_FILE "$EFFECTIVE_MANIFEST_URL"
     else
         log "MANIFEST='$MANIFEST' is not a valid manifest url or location"
@@ -172,11 +161,11 @@ case "X$EFFECTIVE_MANIFEST_FILE" in
         mkdir -p "$MOD_DIR"
       fi
       log "Starting manifest download..."
-      cat "${EFFECTIVE_MANIFEST_FILE}" | jq -r '.files[] | (.projectID|tostring) + " " + (.fileID|tostring)'| while read -r p f
+      jq -r '.files[] | (.projectID|tostring) + " " + (.fileID|tostring)' "${EFFECTIVE_MANIFEST_FILE}" | while read -r p f
       do
         if [ ! -f $MOD_DIR/${p}_${f}.jar ]
         then
-          redirect_url="$(curl -Ls -o /dev/null -w %{effective_url} ${CURSE_URL_BASE}/${p})"
+          redirect_url="$(curl -Ls -o /dev/null -w "%{effective_url}" "${CURSE_URL_BASE}/${p}")"
           url="$redirect_url/download/${f}/file"
           log Downloading curseforge mod $url
           #  Manifest usually doesn't have mod names. Using id should be fine, tho
@@ -192,8 +181,9 @@ case "X$EFFECTIVE_MANIFEST_FILE" in
     ;;
 esac
 fi
+}
 
-function genericPacks() {
+function handleGenericPacks() {
   : "${GENERIC_PACKS:=${GENERIC_PACK}}"
   : "${GENERIC_PACKS_PREFIX:=}"
   : "${GENERIC_PACKS_SUFFIX:=}"
@@ -234,6 +224,9 @@ function genericPacks() {
         extract "${pack}" "${base_dir}"
       done
 
+      # Remove any eula file since container manages it
+      rm -f "${base_dir}/eula.txt"
+
       # recalculate the actual base directory of content
       if ! base_dir=$(mc-image-helper find \
           --max-depth=3 --type=directory --name=mods,plugins,config \
@@ -261,23 +254,32 @@ function genericPacks() {
       cp -R -f "${base_dir}"/* /data
       rm -rf $original_base_dir
 
-      log "Saving generic pack(s) checksum"
-      sha1sum "${packFiles[@]}" > "${sum_file}"
-      isDebugging && cat "$sum_file"
+      if isTrue "${SKIP_GENERIC_PACK_CHECKSUM:-false}"; then
+        log "Skipping generic pack(s) checksum"
+      else
+        log "Saving generic pack(s) checksum"
+        sha1sum "${packFiles[@]}" > "${sum_file}"
+        if isDebugging; then
+          cat "$sum_file"
+        fi
+      fi
     fi
   fi
 }
 
-function modrinthProjects() {
+function handleModrinthProjects() {
   : "${MODRINTH_PROJECTS:=}"
   : "${MODRINTH_DOWNLOAD_OPTIONAL_DEPENDENCIES:=true}"
   : "${MODRINTH_ALLOWED_VERSION_TYPE:=release}"
 
-  if [[ $MODRINTH_PROJECTS ]] && isFamily HYBRID FABRIC; then
-    if [[ ${FAMILY^^} = HYBRID ]]; then
+  if [[ $MODRINTH_PROJECTS ]] && isFamily HYBRID FORGE FABRIC SPIGOT; then
+    if isFamily HYBRID FORGE; then
       loader=forge
+    elif isFaily FABRIC; then
+      loader=fabric
     else
-      loader="${FAMILY,,}"
+      # we're left with Bukkit/Spigot down-lines where plugins seem to be
+      loader="${TYPE,,}"
     fi
     mc-image-helper modrinth \
       --output-directory=/data \
@@ -289,8 +291,14 @@ function modrinthProjects() {
   fi
 }
 
-genericPacks
+handlePackwiz
 
-modrinthProjects
+handleModpackListOrFile
+
+handleCurseForgeManifest
+
+handleGenericPacks
+
+handleModrinthProjects
 
 exec "${SCRIPTS:-/}start-setupModconfig" "$@"

scripts/start-setupMounts

@@ -14,57 +14,62 @@
 set -e
 isDebugging && set -x
 
-if isTrue ${SYNC_SKIP_NEWER_IN_DESTINATION}; then
+if isTrue "${SYNC_SKIP_NEWER_IN_DESTINATION}"; then
   updateArg="--skip-newer-in-destination"
 fi
 
-if isTrue ${REPLACE_ENV_DURING_SYNC}; then
+if isTrue "${REPLACE_ENV_DURING_SYNC}"; then
   subcommand=sync-and-interpolate
 else
   subcommand=sync
 fi
 
-if [ -d /plugins ]; then
+: "${COPY_PLUGINS_SRC:="/plugins"}"
+: "${COPY_PLUGINS_DEST:="/data/plugins"}"
+
+if [ -d "${COPY_PLUGINS_SRC}" ]; then
   case ${FAMILY} in
     SPIGOT|HYBRID)
-      mkdir -p /data/plugins
-      log "Copying plugins over..."
+      mkdir -p "${COPY_PLUGINS_DEST}"
+      log "Copying any plugins from ${COPY_PLUGINS_SRC} to ${COPY_PLUGINS_DEST}"
       mc-image-helper \
-        --debug=${DEBUG} ${subcommand} $updateArg \
+        ${subcommand} $updateArg \
         --replace-env-file-suffixes="${REPLACE_ENV_SUFFIXES}" \
         --replace-env-excludes="${REPLACE_ENV_VARIABLES_EXCLUDES}" \
         --replace-env-exclude-paths="${REPLACE_ENV_VARIABLES_EXCLUDE_PATHS}" \
-        --replace-env-prefix=${REPLACE_ENV_VARIABLE_PREFIX} \
-        /plugins /data/plugins
+        --replace-env-prefix="${REPLACE_ENV_VARIABLE_PREFIX}" \
+        "${COPY_PLUGINS_SRC}" "${COPY_PLUGINS_DEST}"
       ;;
   esac
 fi
 
 # If any modules have been provided, copy them over
+: "${COPY_MODS_SRC:="/mods"}"
 : "${COPY_MODS_DEST:="/data/mods"}"
 
-if [ -d /mods ]; then
-  log "Copying any mods over..."
+if [ -d "${COPY_MODS_SRC}" ]; then
+  log "Copying any mods from ${COPY_MODS_SRC} to ${COPY_MODS_DEST}"
   mc-image-helper \
-    --debug=${DEBUG} ${subcommand} $updateArg \
+    ${subcommand} $updateArg \
     --replace-env-file-suffixes="${REPLACE_ENV_SUFFIXES}" \
     --replace-env-excludes="${REPLACE_ENV_VARIABLES_EXCLUDES}" \
     --replace-env-exclude-paths="${REPLACE_ENV_VARIABLES_EXCLUDE_PATHS}" \
-    --replace-env-prefix=${REPLACE_ENV_VARIABLE_PREFIX} \
-    /mods "${COPY_MODS_DEST}"
+    --replace-env-prefix="${REPLACE_ENV_VARIABLE_PREFIX}" \
+    "${COPY_MODS_SRC}" "${COPY_MODS_DEST}"
 fi
 
+: "${COPY_CONFIG_SRC:="/config"}"
 : "${COPY_CONFIG_DEST:="/data/config"}"
 
-if [ -d /config ]; then
-  log "Copying any configs from /config to ${COPY_CONFIG_DEST}"
+if [ -d "${COPY_CONFIG_SRC}" ]; then
+  log "Copying any configs from ${COPY_CONFIG_SRC} to ${COPY_CONFIG_DEST}"
   mc-image-helper \
-    --debug=${DEBUG} ${subcommand} $updateArg \
+    ${subcommand} $updateArg \
     --replace-env-file-suffixes="${REPLACE_ENV_SUFFIXES}" \
     --replace-env-excludes="${REPLACE_ENV_VARIABLES_EXCLUDES}" \
     --replace-env-exclude-paths="${REPLACE_ENV_VARIABLES_EXCLUDE_PATHS}" \
-    --replace-env-prefix=${REPLACE_ENV_VARIABLE_PREFIX} \
-    /config "${COPY_CONFIG_DEST}"
+    --replace-env-prefix="${REPLACE_ENV_VARIABLE_PREFIX}" \
+    "${COPY_CONFIG_SRC}" "${COPY_CONFIG_DEST}"
 fi
 
 exec "${SCRIPTS:-/}start-setupServerProperties" "$@"

scripts/start-setupServerProperties

@@ -4,7 +4,9 @@
 . "${SCRIPTS:-/}start-utils"
 
 : "${SERVER_PROPERTIES:=/data/server.properties}"
-: "${ENABLE_RCON:=true}"
+: "${OVERRIDE_SERVER_PROPERTIES:=true}"
+: "${SKIP_SERVER_PROPERTIES:=false}"
+: "${ENABLE_WHITELIST:=}"
 
 # FUNCTIONS
 function setServerPropValue {
@@ -15,11 +17,16 @@ function setServerPropValue {
     TRUE|FALSE)
       value=${value,,} ;;
   esac
-  if grep "${prop}" "$SERVER_PROPERTIES" > /dev/null; then
-    log "Setting ${prop} to '${value}' in ${SERVER_PROPERTIES}"
+  if [[ $prop =~ password ]]; then
+    showValue="*****"
+  else
+    showValue="$value"
+  fi
+  if [ -f "$SERVER_PROPERTIES" ] && grep "${prop}" "$SERVER_PROPERTIES" > /dev/null; then
+    debug "Setting ${prop} to '${showValue}' in ${SERVER_PROPERTIES}"
     sed -i "/^${prop}\s*=/ c ${prop}=${value//\\/\\\\}" "$SERVER_PROPERTIES"
   else
-    log "Adding ${prop} with '${value}' in ${SERVER_PROPERTIES}"
+    debug "Adding ${prop} with '${showValue}' in ${SERVER_PROPERTIES}"
     echo "${prop}=${value}" >> "$SERVER_PROPERTIES"
   fi
 }
@@ -34,33 +41,16 @@ function setServerProp {
 }
 
 function customizeServerProps {
+  local firstSetup=$1
   # Whitelist processing
-  if [ -n "$WHITELIST" ] || [ -n "$WHITELIST_FILE" ] || isTrue "${ENABLE_WHITELIST:-false}"; then
+  if [ -n "$WHITELIST" ] || [ -n "$WHITELIST_FILE" ] || isTrue "${ENABLE_WHITELIST}"; then
     log "Enabling whitelist functionality"
     setServerPropValue "white-list" "true"
-  else
+    setServerPropValue "enforce-whitelist" "true"
+  elif isTrue "$firstSetup" || isFalse "${ENABLE_WHITELIST}"; then
     log "Disabling whitelist functionality"
     setServerPropValue "white-list" "false"
-  fi
-  setServerProp "enforce-whitelist" ENFORCE_WHITELIST
-  if [[ $(grep "enforce-whitelist" $SERVER_PROPERTIES) != *true ]]; then
-    log "WARNING: whitelist enabled but not enforced. Set ENFORCE_WHITELIST=TRUE or update 'enforce-whitelist' in server.properties to enforce the whitelist."
-  fi
-
-  # If not provided, generate a reasonable default message-of-the-day,
-  # which shows up in the server listing in the client
-  if ! [ -v MOTD ]; then
-    # snapshot is the odd case where we have to look at version to identify that label
-    if [[ ${ORIGINAL_TYPE} == "VANILLA" && ${VERSION} == "SNAPSHOT" ]]; then
-      label=SNAPSHOT
-    else
-      label=${ORIGINAL_TYPE}
-    fi
-
-    # Convert label to title-case
-    label=${label,,}
-    label=${label^}
-    MOTD="A ${label} Minecraft Server powered by Docker"
+    setServerProp "enforce-whitelist" ENFORCE_WHITELIST
   fi
 
   # normalize MOTD
@@ -118,7 +108,11 @@ function customizeServerProps {
   setServerProp "simulation-distance" SIMULATION_DISTANCE
   setServerProp "previews-chat" PREVIEWS_CHAT
   setServerProp "enforce-secure-profile" ENFORCE_SECURE_PROFILE
-  setServerPropValue "motd" "$(echo "$MOTD" | mc-image-helper asciify)"
+  setServerProp "initial-enabled-packs" INITIAL_ENABLED_PACKS
+  setServerProp "initial-disabled-packs" INITIAL_DISABLED_PACKS
+  if [[ $MOTD ]]; then
+    setServerPropValue "motd" "$(echo "$MOTD" | mc-image-helper asciify)"
+  fi
   [[ $LEVEL_TYPE ]] && setServerPropValue "level-type" "${LEVEL_TYPE^^}"
 
   if [ -n "$DIFFICULTY" ]; then
@@ -205,37 +199,48 @@ if [[ ${TYPE} == "CURSEFORGE" ]]; then
   log "detected FTB, changing properties path to ${SERVER_PROPERTIES}"
 fi
 
-if ! isTrue "${SKIP_SERVER_PROPERTIES:-false}"; then
+if ! isTrue "${SKIP_SERVER_PROPERTIES}"; then
   if [ ! -e "$SERVER_PROPERTIES" ]; then
-    log "Creating server.properties in ${SERVER_PROPERTIES}"
-    cp /tmp/server.properties "$SERVER_PROPERTIES"
-    customizeServerProps
-  elif [ -n "${OVERRIDE_SERVER_PROPERTIES}" ]; then
-      case ${OVERRIDE_SERVER_PROPERTIES^^} in
-        TRUE|1)
-          customizeServerProps
-          ;;
-        *)
-          log "server.properties already created, skipping"
-          ;;
-      esac
+    log "Creating server properties in ${SERVER_PROPERTIES}"
+
+    # If not provided, generate a reasonable default message-of-the-day,
+    # which shows up in the server listing in the client
+    if ! [ -v MOTD ]; then
+      # snapshot is the odd case where we have to look at version to identify that label
+      if [[ ${ORIGINAL_TYPE} == "VANILLA" && ${VERSION} == "SNAPSHOT" ]]; then
+        label=SNAPSHOT
+      else
+        label=${ORIGINAL_TYPE}
+      fi
+
+      # Convert label to title-case
+      label=${label,,}
+      label=${label^}
+      MOTD="A ${label} Minecraft Server powered by Docker"
+    fi
+
+    customizeServerProps true
+  elif isTrue "${OVERRIDE_SERVER_PROPERTIES}"; then
+    customizeServerProps false
   else
-    log "server.properties already created, skipping"
+    log "server.properties already created and managed manually"
   fi
 else
   log "Skipping setup of server.properties"
 fi
 
 if isTrue "${ENABLE_AUTOPAUSE}"; then
-  current_max_tick=$( grep 'max-tick-time' "$SERVER_PROPERTIES" | sed -r 's/( )+//g' | awk -F= '{print $2}' )
-  if (( current_max_tick > 0 && current_max_tick < 86400000 )); then
-    log "Warning: The server.properties for the server doesn't have the Server Watchdog (effectively) disabled."
-    log "Warning (cont): Autopause functionality resuming the process might trigger the Watchdog and restart the server completely."
-    log "Warning (cont): Set the max-tick-time property to a high value (or disable the Watchdog with value -1 for versions 1.8.1+)."
+  if [ -f "$SERVER_PROPERTIES" ]; then
+    current_max_tick=$( grep 'max-tick-time' "$SERVER_PROPERTIES" | sed -r 's/( )+//g' | awk -F= '{print $2}' )
+    if (( current_max_tick > 0 && current_max_tick < 86400000 )); then
+      log "Warning: The server.properties for the server doesn't have the Server Watchdog (effectively) disabled."
+      log "         Autopause functionality resuming the process might trigger the Watchdog and restart the server completely."
+      log "         Set the MAX_TICK_TIME env variable (or max-tick-time property) to a high value (or disable the Watchdog with value -1 for versions 1.8.1+)."
+    fi
   fi
 fi
 
-if isDebugging && [ -f "${SERVER_PROPERTIES}" ]; then
+if isTrue "${DUMP_SERVER_PROPERTIES:-false}"; then
   log "DEBUG Dumping server.properties"
   cat "${SERVER_PROPERTIES}"
 fi

scripts/start-spiget

@@ -58,11 +58,15 @@ getResourceFromSpiget() {
         exit 2
       fi
 
-      installedVersion=$(jq -r '.name' $versionfile)
+      if isTrue "${REMOVE_OLD_MODS:-false}"; then
+        installedVersion=0.0.0
+      else
+        installedVersion=$(jq -r '.name' $versionfile)
+      fi
       newVersion=$(jq -r '.name' $versionfileNew)
       
       if [ "$installedVersion" = "$newVersion" ]; then
-        log "resource '${resource}' not downloaded because installed version '${installedVersion}' already up to date ('${newVersion}')"
+        log "Resource '${resource}': installed version '${installedVersion}' already up to date"
         mv "${versionfileNew}" "${versionfile}"
       else
         if downloadResourceFromSpiget "${resource}"; then

scripts/start-utils

@@ -1,5 +1,23 @@
 #!/bin/bash
 
+function get_from_gh() {
+  if [[ "${GH_TOKEN:-}" ]]; then
+    # User has provided a Personal Access Token to mitigate rate-limiting issues
+    if [[ -z "${oAuthScopes}" ]]; then
+      oAuthScopes=$(curl -s -H "Authorization: token $GH_TOKEN" https://api.github.com/users/codertocat -I | grep x-oauth-scopes)
+    fi
+    if [[ ! "$oAuthScopes" =~ ^x-oauth-scopes:[[:space:]]*$ ]]; then
+      # Don't use what you don't have to...
+      log "ERROR: GH_TOKEN has permissions it doesn't need. Recreate or update this personal access token and disable ALL scopes."
+      exit 1
+    else
+      curl -fsSL -H "Authorization: token $GH_TOKEN" "${@:2}" "$1"
+    fi
+  else
+    curl -fsSL "${@:2}" "$1"
+  fi
+}
+
 function join_by() {
   local d=$1
   shift
@@ -32,7 +50,7 @@ function isValidFileURL() {
 
 function resolveEffectiveUrl() {
   url="${1:?Missing required url argument}"
-  if ! curl -Ls -o /dev/null -w %{url_effective} "$url"; then
+  if ! curl -Ls -o /dev/null -w "%{url_effective}" "$url"; then
     log "ERROR failed to resolve effective URL from $url"
     exit 2
   fi
@@ -45,47 +63,25 @@ function getFilenameFromUrl() {
 }
 
 function isTrue() {
-  local oldState
-  oldState=$(shopt -po xtrace)
-  shopt -u -o xtrace
-
-  local value=${1,,}
-
-  result=
-
-  case ${value} in
-  true | on)
-    result=0
+  case "${1,,}" in
+  true | on | 1)
+    return 0
     ;;
   *)
-    result=1
+    return 1
     ;;
   esac
-
-  eval "$oldState"
-  return ${result}
 }
 
 function isFalse() {
-  local oldState
-  oldState=$(shopt -po xtrace)
-  shopt -u -o xtrace
-
-  local value=${1,,}
-
-  result=
-
-  case ${value} in
-  false | off)
-    result=0
+  case "${1,,}" in
+  false | off | 0)
+    return 0
     ;;
   *)
-    result=1
+    return 1
     ;;
   esac
-
-  eval "$oldState"
-  return ${result}
 }
 
 function isDebugging() {
@@ -166,11 +162,16 @@ function normalizeMemSize() {
 }
 
 function versionLessThan() {
-  mc-image-helper compare-versions "${VANILLA_VERSION}" lt "${1?}"
+  # Use if-else since strict mode might be enabled
+  if mc-image-helper compare-versions "${VANILLA_VERSION}" lt "${1?}"; then
+    return 0
+  else
+    return 1
+  fi
 }
 
 requireVar() {
-  if [ ! -v $1 ]; then
+  if [ ! -v "$1" ]; then
     log "ERROR: $1 is required to be set"
     exit 1
   fi
@@ -184,8 +185,8 @@ requireEnum() {
   var=${1?}
   shift
 
-  for allowed in $*; do
-    if [[ ${!var} = $allowed ]]; then
+  for allowed in "$@"; do
+    if [[ ${!var} = "$allowed" ]]; then
       return 0
     fi
   done
@@ -283,7 +284,7 @@ function extract() {
 }
 
 function getDistro() {
-  cat /etc/os-release | grep -E "^ID=" | cut -d= -f2 | sed -e 's/"//g'
+  grep -E "^ID=" /etc/os-release | cut -d= -f2 | sed -e 's/"//g'
 }
 
 function checkSum() {
@@ -291,7 +292,7 @@ function checkSum() {
 
   # Get distro
   distro=$(getDistro)
-  
+
   if [ "${distro}" == "debian" ] && sha1sum -c "${sum_file}" --status 2> /dev/null; then
     return 0
   elif [ "${distro}" == "ubuntu" ] && sha1sum -c "${sum_file}" --status 2> /dev/null; then

tests/setuponlytests/auto_curseforge/docker-compose.yml

@@ -0,0 +1,16 @@
+version: "3"
+
+services:
+  mc:
+    image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
+    environment:
+      EULA: "true"
+      SETUP_ONLY: "TRUE"
+      TYPE: AUTO_CURSEFORGE
+      CF_SLUG: the-pixelmon-modpack
+      CF_FILENAME_MATCHER: "9.1.2"
+      # Use the image bundled one to ensure latest is being tested
+      CF_EXCLUDE_INCLUDE_FILE: /image/cf-exclude-include.json
+    volumes:
+      - ./data:/data
+

tests/setuponlytests/auto_curseforge/verify.sh

@@ -0,0 +1,2 @@
+mc-image-helper assert fileExists "/data/mods/ExplorersCompass-1.16.5-1.1.2-forge.jar"
+mc-image-helper assert fileExists "/data/forge-1.16.5-36.2.34.jar"

tests/setuponlytests/conflicting_world_for_spigot_server/verify.sh

@@ -1,5 +1,7 @@
-mc-image-helper assert fileExists world/level.dat && \
-mc-image-helper assert fileExists world_nether/DIM-1/some_spigot_nether_file && \
-mc-image-helper assert fileExists world_the_end/DIM1/some_spigot_end_file && \
-! mc-image-helper assert fileExists world_nether/DIM-1/some_vanilla_nether_file && \
-! mc-image-helper assert fileExists world_the_end/DIM1/some_vanilla_end_file
+mc-image-helper assert fileExists \
+  world/level.dat \
+  world_nether/DIM-1/some_spigot_nether_file \
+  world_the_end/DIM1/some_spigot_end_file
+mc-image-helper assert fileNotExists \
+  world_nether/DIM-1/some_vanilla_nether_file \
+  world_the_end/DIM1/some_vanilla_end_file

tests/setuponlytests/mounts-custom/custom/config/test.json

@@ -0,0 +1 @@
+{}

tests/setuponlytests/mounts-custom/docker-compose.yml

@@ -0,0 +1,21 @@
+version: "3"
+
+services:
+  mc:
+    image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
+    environment:
+      EULA: "true"
+      SETUP_ONLY: "true"
+      TYPE: CUSTOM
+      CUSTOM_SERVER: /servers/fake.jar
+      VERSION: 1.18.1
+      COPY_PLUGINS_SRC: /custom/plugins
+      COPY_PLUGINS_DEST: /data/custom-plugins
+      COPY_MODS_SRC: /custom/mods
+      COPY_MODS_DEST: /data/custom-mods
+      COPY_CONFIG_SRC: /custom/config
+      COPY_CONFIG_DEST: /data/custom-config
+    volumes:
+      - ./data:/data
+      - ./custom:/custom
+      - ./fake.jar:/servers/fake.jar

tests/setuponlytests/mounts-custom/verify.sh

@@ -0,0 +1,3 @@
+mc-image-helper assert fileExists custom-plugins/plugin.jar
+mc-image-helper assert fileExists custom-mods/mod.jar
+mc-image-helper assert fileExists custom-config/test.json

tests/setuponlytests/packwiz/docker-compose.yml

@@ -11,11 +11,11 @@ services:
     image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
     environment:
       EULA: "true"
-      SETUP_ONLY: "true"
       PACKWIZ_URL: http://web/pack.toml
       TYPE: CUSTOM
       CUSTOM_SERVER: /servers/fake.jar
       VERSION: 1.19
+      DEBUG_HELPER: "true"
     volumes:
       - ./data:/data
       - ./fake.jar:/servers/fake.jar

tests/setuponlytests/test.sh

@@ -39,8 +39,10 @@ setupOnlyMinecraftTest(){
     fi
   fi
 
+  # false positive since it's used in delta calculations below
+  # shellcheck disable=SC2034
   start=$(date +%s)
-  if ! logs=$(docker compose run mc 2>&1); then
+  if ! logs=$(docker compose run --rm -e SETUP_ONLY=true -e DEBUG="${DEBUG:-false}" mc 2>&1); then
     outputContainerLog "$logs"
     result=1
   elif [ -f verify.sh ]; then