Build native mc-image-helper

Bumps the patches group in /docs with 2 updates: [mkdocs-material](https://github.com/squidfunk/mkdocs-material) and [mkdocs-static-i18n](https://github.com/ultrabug/mkdocs-static-i18n).


Updates `mkdocs-material` from 9.4.4 to 9.4.6
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.4.4...9.4.6)

Updates `mkdocs-static-i18n` from 1.1.0 to 1.1.1
- [Changelog](https://github.com/ultrabug/mkdocs-static-i18n/blob/main/docs/changelog.md)
- [Commits](https://github.com/ultrabug/mkdocs-static-i18n/compare/1.1.0...1.1.1)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: patches
- dependency-name: mkdocs-static-i18n
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: patches
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.github/dependabot.yml

@@ -1,7 +1,23 @@
 version: 2
 updates:
-  # Maintain dependencies for GitHub Actions
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "weekly"
+    groups:
+      updates:
+        patterns:
+          - "*"
+        update-types:
+          - patch
+          - minor
+  - package-ecosystem: pip
+    directory: "/docs"
+    schedule:
+      interval: weekly
+    groups:
+      patches:
+        patterns:
+          - "*"
+        update-types:
+          - patch

.github/workflows/build-multiarch.yml

@@ -1,4 +1,4 @@
-name: Test and Build multi-architecture
+name: Build and Publish
 on:
   push:
     branches:
@@ -18,10 +18,11 @@ jobs:
       matrix:
         # NOTE: the "latest" variant is identified in the Docker meta step's 'latest' config
         variant:
+          - java21-graalvm
           - java20
           - java20-alpine
           - java17
-          - java17-graalvm-ce
+          - java17-graalvm
           - java17-jdk
           - java17-openj9
           - java17-alpine
@@ -34,6 +35,11 @@ jobs:
           - java11-openj9
           - java11-jdk
         include:
+        # JAVA 21:
+          - variant: java21-graalvm
+            baseImage: container-registry.oracle.com/graalvm/jdk:21-ol8
+            platforms: linux/amd64,linux/arm64
+            mcVersion: 1.20.2
         # JAVA 20:
           - variant: java20
             baseImage: eclipse-temurin:20-jre
@@ -49,8 +55,8 @@ jobs:
             baseImage: eclipse-temurin:17-jre-focal
             platforms: linux/amd64,linux/arm/v7,linux/arm64
             mcVersion: 1.18.2
-          - variant: java17-graalvm-ce
-            baseImage: ghcr.io/graalvm/graalvm-ce:ol8-java17
+          - variant: java17-graalvm
+            baseImage: container-registry.oracle.com/graalvm/jdk:17-ol8
             platforms: linux/amd64,linux/arm64
             mcVersion: 1.18.2
           - variant: java17-jdk
@@ -106,14 +112,14 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4.1.0
         with:
           # for build-files step
           fetch-depth: 0
 
       - name: Docker meta
         id: meta
-        uses: docker/metadata-action@v4
+        uses: docker/metadata-action@v5.0.0
         with:
           # NOTE for forks: if your Docker Hub organization doesn't match your Github repo's,
           # then the use of ${{ github.repository_owner }} will need to be replaced.
@@ -139,13 +145,13 @@ jobs:
             org.opencontainers.image.authors=Geoff Bourne <itzgeoff@gmail.com>
 
       - name: Setup Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3.0.0
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2.2.0
+        uses: docker/setup-qemu-action@v3.0.0
 
       - name: Build for test
-        uses: docker/build-push-action@v4.1.1
+        uses: docker/build-push-action@v5.0.0
         with:
           platforms: linux/amd64
           tags: ${{ env.IMAGE_TO_TEST }}
@@ -168,14 +174,14 @@ jobs:
           tests/test.sh
 
       - name: Login to DockerHub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3.0.0
         if: env.HAS_IMAGE_REPO_ACCESS
         with:
           username: ${{ secrets.DOCKER_USER }}
           password: ${{ secrets.DOCKER_PASSWORD }}
 
       - name: Login to GHCR
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3.0.0
         if: env.HAS_IMAGE_REPO_ACCESS
         with:
           registry: ghcr.io
@@ -183,7 +189,7 @@ jobs:
           password: ${{ github.token }}
 
       - name: Build and push
-        uses: docker/build-push-action@v4.1.1
+        uses: docker/build-push-action@v5.0.0
         if: github.actor == github.repository_owner
         with:
           platforms: ${{ matrix.platforms }}

.github/workflows/verify-pr.yml

@@ -45,16 +45,16 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4.1.0
         with:
           # for build-files step
           fetch-depth: 0
 
       - name: Setup Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3.0.0
 
       - name: Confirm multi-arch build
-        uses: docker/build-push-action@v4.1.1
+        uses: docker/build-push-action@v5.0.0
         with:
           platforms: ${{ matrix.platforms }}
           # ensure latest base image is used
@@ -64,7 +64,7 @@ jobs:
           cache-from: type=gha,scope=${{ matrix.variant }}
 
       - name: Build for test
-        uses: docker/build-push-action@v4.1.1
+        uses: docker/build-push-action@v5.0.0
         with:
           # Only build single platform since loading multi-arch image into daemon fails with
           # "docker exporter does not currently support exporting manifest lists"

Dockerfile

@@ -1,6 +1,19 @@
-# syntax = docker/dockerfile:1.3
-
+# syntax = docker/dockerfile:1.5-labs
 ARG BASE_IMAGE=eclipse-temurin:17-jre-focal
+
+###############################################################################
+FROM container-registry.oracle.com/graalvm/native-image:21-ol8 AS helper-native-builder
+
+# findutils provides xargs, needed by gradle wrapper
+RUN microdnf install findutils
+
+ADD https://github.com/itzg/mc-image-helper.git#feat/graalvm /helper
+
+WORKDIR /helper
+
+RUN ./gradlew nativeCompile
+
+###############################################################################
 FROM ${BASE_IMAGE}
 
 # hook into docker BuildKit --platform support
@@ -35,20 +48,14 @@ 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=0.12.2 --var app=mc-monitor --file {{.app}} \
+  --var version=0.12.3 --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.9.0 --var app=mc-server-runner --file {{.app}} \
   --from https://github.com/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
-ARG MC_HELPER_VERSION=1.34.5
-ARG MC_HELPER_BASE_URL=https://github.com/itzg/mc-image-helper/releases/download/${MC_HELPER_VERSION}
-# used for cache busting local copy of mc-image-helper
-ARG MC_HELPER_REV=1
-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
+COPY --from=helper-native-builder /helper/build/native/nativeCompile/mc-image-helper /usr/bin/
 
 VOLUME ["/data"]
 WORKDIR /data
@@ -61,9 +68,7 @@ ENV TYPE=VANILLA VERSION=LATEST EULA="" UID=1000 GID=1000
 COPY --chmod=755 scripts/start* /
 COPY --chmod=755 bin/ /usr/local/bin/
 COPY --chmod=755 bin/mc-health /health.sh
-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=644 files/* /image/
 COPY --chmod=755 files/auto /auto
 
 RUN curl -fsSL -o /image/Log4jPatcher.jar https://github.com/CreeperHost/Log4jPatcher/releases/download/v1.0.1/Log4jPatcher-1.0.1.jar

README.md

@@ -2,7 +2,7 @@
 [![Docker Stars](https://img.shields.io/docker/stars/itzg/minecraft-server.svg?maxAge=2592000)](https://hub.docker.com/r/itzg/minecraft-server/)
 [![GitHub Issues](https://img.shields.io/github/issues-raw/itzg/docker-minecraft-server.svg)](https://github.com/itzg/docker-minecraft-server/issues)
 [![Discord](https://img.shields.io/discord/660567679458869252?label=Discord&logo=discord)](https://discord.gg/DXfKpjB)
-[![Build and Publish](https://github.com/itzg/docker-minecraft-server/workflows/Build%20and%20Publish/badge.svg)](https://github.com/itzg/docker-minecraft-server/actions)
+[![Build and Publish](https://github.com/itzg/docker-minecraft-server/actions/workflows/build-multiarch.yml/badge.svg)](https://github.com/itzg/docker-minecraft-server/actions/workflows/build-multiarch.yml)
 [![](https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-orange.svg)](https://www.buymeacoffee.com/itzg)
 [![Documentation Status](https://readthedocs.org/projects/docker-minecraft-server/badge/?version=latest)](https://docker-minecraft-server.readthedocs.io/en/latest/?badge=latest)
 
@@ -585,7 +585,7 @@ Configuration options with defaults:
 
 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. 
+> NOTE: instead of using format codes in the MOTD, Limbo requires [JSON chat content](https://minecraft.wiki/w/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. 
 
 ### Running a Crucible server
 
@@ -1090,7 +1090,7 @@ If you leave it off, a default is computed from the server type and version, suc
 
 That way you can easily differentiate between several servers you may have started.
 
-The section symbol (§) and other unicode characters are automatically converted to allow [formatting codes](https://minecraft.fandom.com/wiki/Formatting_codes) to be used consistently with all server versions. For example,
+The section symbol (§) and other unicode characters are automatically converted to allow [formatting codes](https://minecraft.wiki/w/Formatting_codes) to be used consistently with all server versions. For example,
 
      -e MOTD="A §l§cMinecraft§r §nserver"
 
@@ -1122,7 +1122,7 @@ 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 ...`
 
-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.
+When either is set, [whitelisting of connecting users](https://minecraft.wiki/w/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.
 
@@ -1132,7 +1132,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.
 
-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".
+To [enforce the whitelist changes immediately](https://minecraft.wiki/w/Server.properties#enforce-whitelist) when whitelist commands are used , set `ENFORCE_WHITELIST` to "true".
 
 ### Op/Administrator Players
 
@@ -1303,7 +1303,7 @@ If using a negative value for the seed, make sure to quote the value such as:
 
 By default, Minecraft servers are configured to run in Survival mode. You can
 change the mode using `MODE` where you can either provide the [standard
-numerical values](http://minecraft.gamepedia.com/Game_mode#Game_modes) or the
+numerical values](http://minecraft.wiki/Game_mode#Game_modes) or the
 shortcut values:
 
 - creative
@@ -1325,9 +1325,9 @@ environment variable set to `false`, such as
 ### Level Type and Generator Settings
 
 By default, a standard world is generated with hills, valleys, water, etc. A different level type can
-be configured by setting `LEVEL_TYPE` to [an expected type listed here](https://minecraft.fandom.com/wiki/Server.properties#level-type).
+be configured by setting `LEVEL_TYPE` to [an expected type listed here](https://minecraft.wiki/w/Server.properties#level-type).
 
-For some of the level types, `GENERATOR_SETTINGS` can be used to further customize the world generation [as described here](https://minecraft.fandom.com/wiki/Server.properties#generator-settings).
+For some of the level types, `GENERATOR_SETTINGS` can be used to further customize the world generation [as described here](https://minecraft.wiki/w/Server.properties#generator-settings).
 
 ### Custom Server Resource Pack
 

build/ol/install-gosu.sh

@@ -1,10 +1,10 @@
 #!/bin/bash
 
 if [[ $(uname -m) == "aarch64" ]]; then 
-    curl -sL -o /bin/gosu https://github.com/tianon/gosu/releases/download/1.14/gosu-arm64
+    curl -sL -o /bin/gosu https://github.com/tianon/gosu/releases/download/1.16/gosu-arm64
     chmod +x /bin/gosu
 elif [[ $(uname -m) == "x86_64" ]]; then 
-    curl -sL -o /bin/gosu https://github.com/tianon/gosu/releases/download/1.14/gosu-amd64
+    curl -sL -o /bin/gosu https://github.com/tianon/gosu/releases/download/1.16/gosu-amd64
     chmod +x /bin/gosu
 else
     echo "Not supported!"

build/ol/install-packages.sh

@@ -36,7 +36,9 @@ dnf install -y ImageMagick \
   zstd \
   lbzip2 \
   libpcap \
-  libwebp
+  libwebp \
+  findutils \
+  which
 
 bash /build/ol/install-gosu.sh
 

docs/configuration/server-properties.md

@@ -16,7 +16,7 @@ If you leave it off, a default is computed from the server type and version, suc
 
 That way you can easily differentiate between several servers you may have started.
 
-The section symbol (§) and other unicode characters are automatically converted to allow [formatting codes](https://minecraft.fandom.com/wiki/Formatting_codes) to be used consistently with all server versions. For example,
+The section symbol (§) and other unicode characters are automatically converted to allow [formatting codes](https://minecraft.wiki/w/Formatting_codes) to be used consistently with all server versions. For example,
 
      -e MOTD="A §l§cMinecraft§r §nserver"
 
@@ -24,9 +24,9 @@ renders
 
 ![](../img/motd-example.png)
 
-To produce a multi-line MOTD, you will need to double escape the newline such as
+To produce a multi-line MOTD, embed a newline character as `\n` in the string, such as
 
-    -e MOTD="Line one\\nLine two"
+    -e MOTD="Line one\nLine two"
 
 ### Difficulty
 
@@ -62,24 +62,34 @@ To whitelist players for your Minecraft server, you can:
             user3
     ```
 
-When either is set, [whitelisting of connecting users](https://minecraft.fandom.com/wiki/Server.properties#white-list) is enabled.
+When either is set, [whitelisting of connecting users](https://minecraft.wiki/w/Server.properties#white-list) is enabled.
 
-Use of `WHITELIST_FILE` will **overwrite** an existing `whitelist.json` file; however, the option can be combined with `WHITELIST` to refine the list.
+To change the behavior when the whitelist file already exists, set the variable `EXISTING_WHITELIST_FILE` to one of the following options:
 
-By default, `WHITELIST` will keep the `whitelist.json` fully synchronized with the given list. All whitelist entries can be removed by setting `WHITELIST` to an empty string. To only append new users, set `APPEND_WHITELIST` to "true".
+`SKIP` (default)
+: Skip processing of the whitelist file when one is already present. This is the same as setting the legacy variable `OVERRIDE_WHITELIST` to "false".
+
+`SYNCHRONIZE`
+: Synchronize the list of users in the file with the `WHITELIST` or `WHITELIST_FILE` provided. When using both, `WHITELIST` will take precedence. This is the same as setting the legacy variable `OVERRIDE_WHITELIST` to "true".
+
+`MERGE`
+: Merge the list of users from `WHITELIST` into the existing file. `WHITELIST_FILE` cannot be used with this option.
+
+`SYNC_FILE_MERGE_LIST`
+: When `WHITELIST_FILE` is provided it will overwrite an existing whitelist file. Also, if `WHITELIST` is provided, then those users will be merged into the newly copied file.
 
 !!! note 
 
     For versions prior to 1.7.3, `white-list.txt` will be maintained instead. Only usernames are supported for those versions.
 
-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". If managing the whitelist file manually, `ENABLE_WHITELIST` can be set to "true" to set the `white-list` property.
+To [enforce the whitelist changes immediately](https://minecraft.wiki/w/Server.properties#enforce-whitelist) when whitelist commands are used , set `ENFORCE_WHITELIST` to "true". If managing the whitelist file manually, `ENABLE_WHITELIST` can be set to "true" to set the `white-list` property.
 
 ### Op/Administrator Players
 
-Similar to the whitelist, to add users as operators (aka administrators) to your Minecraft server, you can:  
+Similar to the whitelist, users can be provisioned as operators (aka administrators) to your Minecraft server by
 
-- Provide a list of usernames and/or UUIDs separated by commas or newlines via the `OPS` environment variable
-- Provide the URL or container path to an ops file via `OPS_FILE` that will be retrieved/copied into the standard location
+- Providing a list of usernames and/or UUIDs separated by commas or newlines via the `OPS` environment variable
+- Providing the URL or container path to an ops file via `OPS_FILE` that will be retrieved/copied into the standard location
 
 !!! example
 
@@ -92,9 +102,19 @@ Similar to the whitelist, to add users as operators (aka administrators) to your
             user3
     ```
 
-Use of `OPS_FILE` will **overwrite** an existing `ops.json` file; however, the option can be combined with `OPS` to refine the list.
+To change the behavior when the ops file already exists, set the variable `EXISTING_OPS_FILE` to one of the following options:
 
-By default, `OPS` will keep the `ops.json` fully synchronized with the given list. All ops entries can be removed by setting `OPS` to an empty string. To only append new users, set `APPEND_OPS` to "true". New entries will be assigned [level 4](https://glimpse.me/blog/how-to-op-yourself-in-minecraft/) and not bypass player limit. Manual changes to those fields will be retained.
+`SKIP` (default)
+: Skip processing of the ops file when one is already present. This is the same as setting the legacy variable `OVERRIDE_OPS` to "false".
+
+`SYNCHRONIZE`
+: Synchronize the list of users in the file with the `OPS` or `OPS_FILE` provided. When using both, `OPS` will take precedence. The `level` and `bypassesPlayerLimit` will be retained from previous entries. This is the same as setting the legacy variable `OVERRIDE_OPS` to "true".
+
+`MERGE`
+: Merge the list of users from `OPS` into the existing file. `OPS_FILE` cannot be used with this option.
+
+`SYNC_FILE_MERGE_LIST`
+: When `OPS_FILE` is provided it will overwrite an existing ops file. Also, if `OPS` is provided, then those users will be merged into the newly copied file.
 
 !!! note
 
@@ -259,7 +279,7 @@ If using a negative value for the seed, make sure to quote the value such as:
 
 By default, Minecraft servers are configured to run in Survival mode. You can
 change the mode using `MODE` where you can either provide the [standard
-numerical values](http://minecraft.gamepedia.com/Game_mode#Game_modes) or the
+numerical values](http://minecraft.wiki/Game_mode#Game_modes) or the
 shortcut values:
 
 - creative
@@ -281,9 +301,9 @@ environment variable set to `false`, such as
 ### Level Type and Generator Settings
 
 By default, a standard world is generated with hills, valleys, water, etc. A different level type can
-be configured by setting `LEVEL_TYPE` to [an expected type listed here](https://minecraft.fandom.com/wiki/Server.properties#level-type).
+be configured by setting `LEVEL_TYPE` to [an expected type listed here](https://minecraft.wiki/w/Server.properties#level-type).
 
-For some of the level types, `GENERATOR_SETTINGS` can be used to further customize the world generation [as described here](https://minecraft.fandom.com/wiki/Server.properties#generator-settings).
+For some of the level types, `GENERATOR_SETTINGS` can be used to further customize the world generation [as described here](https://minecraft.wiki/w/Server.properties#generator-settings).
 
 ### Custom Server Resource Pack
 
@@ -333,10 +353,28 @@ If you must, the server port can be set like:
 
 **however**, be sure to change your port mapping accordingly and be prepared for some features to break.
 
+### Custom server properties
+
+Some mods/plugins utilize custom `server.properties` entries which can be declared via the `CUSTOM_SERVER_PROPERTIES` environment variable. The contents must be newline delimited `name=value` pairs.
+
+Within a compose file, newline delimited entries can be declared as shown here:
+
+```yaml
+      CUSTOM_SERVER_PROPERTIES: |
+        custom1=value1
+        defaultworldgenerator-port=f8c04631-f744-11ec-b260-f02f74b094e0
+```
+
+When using `docker run` from a bash shell, the entries must be quoted with the `$'` syntax, such as
+
+```
+-e CUSTOM_SERVER_PROPERTIES=$'k1=v1\nk2=v2'
+```
+
 ### Other server property mappings
 
 | Environment Variable              | Server Property                   |
-| --------------------------------- | --------------------------------- |
+|-----------------------------------|-----------------------------------|
 | BROADCAST_CONSOLE_TO_OPS          | broadcast-console-to-ops          |
 | BROADCAST_RCON_TO_OPS             | broadcast-rcon-to-ops             |
 | ENABLE_STATUS                     | enable-status                     |

docs/misc/contributing/development.md

@@ -83,6 +83,8 @@ cd build/distributions
 jwebserver -b 0.0.0.0 -p 8008
 ```
 
+If `jwebserver` is not available, try `java -m jdk.httpserver`
+
 ```shell
 --build-arg MC_HELPER_VERSION=1.8.1-SNAPSHOT \
 --build-arg MC_HELPER_BASE_URL=http://host.docker.internal:8008

docs/misc/examples.md

@@ -0,0 +1,28 @@
+# Examples
+
+Various examples are [maintained in the repository](https://github.com/itzg/docker-minecraft-server/tree/master/examples). The sections below highlight a few particular ones.
+
+## Bedrock compatible server
+
+Using the [GeyserMC plugin](https://geysermc.org/) with a Paper server (or similar) "enables clients from Minecraft Bedrock Edition to join your Minecraft Java server". The example also includes [Floodgate](https://wiki.geysermc.org/floodgate/) which "allows Xbox Live authenticated Bedrock users to join without a Java Edition account". 
+
+```yaml
+version: "3.8"
+
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: "true"
+      TYPE: "PAPER"
+      PLUGINS: |
+        https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/spigot
+        https://download.geysermc.org/v2/projects/floodgate/versions/latest/builds/latest/downloads/spigot
+    ports:
+      - "25565:25565"
+      - "19132:19132/udp"
+    volumes:
+      - ./data:/data
+```
+
+[Source](https://github.com/itzg/docker-minecraft-server/blob/master/examples/geyser/docker-compose.yml)

docs/misc/healthcheck.md

@@ -25,3 +25,8 @@ healthcheck:
 ```
 
 Some orchestration systems, such as Portainer, don't allow for disabling the default `HEALTHCHECK` declared by this image. In those cases you can approximate the disabling of healthchecks by setting the environment variable `DISABLE_HEALTHCHECK` to `true`.
+
+### Healthchecks for older versions
+
+This container disables Healthchecks for Versions before b1.8 as those versions do not support any kind of server pinging.
+For more information see [Server List Ping](https://wiki.vg/Server_List_Ping#Beta_1.8_to_1.3)

docs/mods-and-plugins/index.md

@@ -47,16 +47,14 @@ These paths work well if you want to have a common set of modules in a separate
 
 ## Zip file modpack
 
-Like the `WORLD` option above, you can specify the URL or path of a "mod pack"
-to download and install into `mods` for Forge/Fabric or `plugins` for Bukkit/Spigot.
-To use this option pass the environment variable `MODPACK`, such as
+Like the `WORLD` option above, you can specify the URL or container path of a "mod pack" to download and install into `mods` for Forge/Fabric or `plugins` for Bukkit/Spigot. To use this option pass the environment variable `MODPACK`, such as
 
 ```shell
 docker run -d -e MODPACK=http://www.example.com/mods/modpack.zip ...
 ```
 
 !!! note
-    The referenced URL must be a zip file with one or more jar files at the
+    The referenced URL/file must be a zip file with one or more jar files at the
     top level of the zip archive. Make sure the jars are compatible with the
     particular `TYPE` of server you are running.
 

docs/mods-and-plugins/modrinth.md

@@ -22,8 +22,8 @@
 
 ## Extra options
 
-`MODRINTH_DOWNLOAD_OPTIONAL_DEPENDENCIES`
-: Required dependencies of the project will _always_ be downloaded and optional dependencies can also be downloaded by setting this to `true`. The default is "true"
+`MODRINTH_DOWNLOAD_DEPENDENCIES`
+: Can be set to `none` (the default), `required`, or `optional` to download required and/or optional dependencies.
 
 `MODRINTH_ALLOWED_VERSION_TYPE`
 : The version type is used to determine the newest version to use from each project. The allowed values are `release` (default), `beta`, `alpha`.

docs/requirements.txt

@@ -1,9 +1,9 @@
-mkdocs
-mkdocs-material-extensions
-mkdocs-material
-mkdocs-autorefs
-mkdocstrings
-mkdocs-literate-nav
-mdx-gh-links
-mkdocs-click
-mkdocs-static-i18n
+mkdocs == 1.5.3
+mkdocs-material-extensions == 1.2
+mkdocs-material == 9.4.6
+mkdocs-autorefs == 0.5.0
+mkdocstrings == 0.23.0
+mkdocs-literate-nav == 0.6.1
+mdx-gh-links == 0.3.1
+mkdocs-click == 0.8.1
+mkdocs-static-i18n == 1.1.1

docs/types-and-platforms/server-types/bukkit-spigot.md

@@ -1,12 +1,20 @@
 # Bukkit/Spigot
 
-Enable Bukkit/Spigot server mode by adding a `-e TYPE=BUKKIT` or `-e TYPE=SPIGOT` to your command-line.
+Run a Bukkit/Spigot server type by setting the environment variable `TYPE` to "BUKKIT" or "SPIGOT".
 
-```
-docker run -d -v /path/on/host:/data \
-    -e TYPE=SPIGOT \
-    -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
-```
+!!! example
+
+    Command-line
+    ```
+    docker run ... -e TYPE=SPIGOT ...
+    ```
+    
+    Compose
+    ```yaml
+        environment:
+          ...
+          TYPE: SPIGOT
+    ```
 
 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".
 
@@ -15,16 +23,14 @@ If you are hosting your own copy of Bukkit/Spigot you can override the download
 - -e BUKKIT_DOWNLOAD_URL=<url>
 - -e SPIGOT_DOWNLOAD_URL=<url>
 
-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.md) or you can also [attach a `/plugins` volume](../../mods-and-plugins/index.md#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`.](../../mods-and-plugins/spiget.md)
-
 !!! 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.
 
+## Build from source
+
+You can build spigot from source by setting the environment variable `BUILD_FROM_SOURCE` to "true".
+
 ## Alternatives
 
 ### Canyon

docs/types-and-platforms/server-types/forge.md

@@ -35,3 +35,23 @@ In both of the cases above, there is no need for the `VERSION` or `FORGE_VERSION
 !!! note
 
     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.
+
+## Alternatives
+
+### NeoForge
+
+Support for [NeoForge](https://neoforged.net/) is also provided. A NeoForge server can be automatically managed by setting `TYPE` to "NEOFORGE". `VERSION` specifies the Minecraft version and `NEOFORGE_VERSION` can be set to select a specific sub-version. By default, the latest NeoForge version available for the requested Minecraft version will be used.
+
+!!! example
+
+    ```
+    docker run -e TYPE=NEOFORGE -e VERSION=1.20.1 -e NEOFORGE_VERSION=47.1.79 ...
+    ```
+    
+    or in a compose file
+    ```yaml
+        environment:
+          TYPE: NEOFORGE
+          VERSION: "1.20.1"
+          NEOFORGE_VERSION: "47.1.79"
+    ```

docs/types-and-platforms/server-types/others.md

@@ -37,7 +37,7 @@ Configuration options with defaults:
 
 !!! 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. 
+    Instead of using format codes in the MOTD, Limbo requires [JSON chat content](https://minecraft.wiki/w/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. 
 
 ## Crucible
 

docs/variables/index.md

@@ -48,7 +48,7 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
 
 /etc/timezone:/etc/timezone:ro</code>
             </td>
-            <td><code>1G</code></td>
+            <td><code>UTC</code></td>
             <td>⬜️</td>
         </tr>
         <tr>
@@ -260,7 +260,7 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
         </tr>
         <tr>
             <td><code>MODE</code></td>
-            <td>Minecraft servers are configured to run in Survival mode by default. You can change the mode using MODE where you can either provide the <a href="http://minecraft.gamepedia.com/Game_mode#Game_modes">standard numerical values</a> or the shortcut values:<br />
+            <td>Minecraft servers are configured to run in Survival mode by default. You can change the mode using MODE where you can either provide the <a href="http://minecraft.wiki/Game_mode#Game_modes">standard numerical values</a> or the shortcut values:<br />
             <ul>
                 <li>creative</li>
                 <li>survival</li>
@@ -278,14 +278,14 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
         </tr>
         <tr>
             <td><code>LEVEL_TYPE</code></td>
-            <td>By default, a standard world is generated with hills, valleys, water, etc. A different level type can be configured by setting LEVEL_TYPE to <a href="https://minecraft.fandom.com/wiki/Server.properties#level-type">an expected type listed here</a>.
+            <td>By default, a standard world is generated with hills, valleys, water, etc. A different level type can be configured by setting LEVEL_TYPE to <a href="https://minecraft.wiki/w/Server.properties#level-type">an expected type listed here</a>.
             </td>
             <td><code>minecraft:default</code></td>
             <td>⬜️</td>
         </tr>
         <tr>
             <td><code>GENERATOR_SETTINGS</code></td>
-            <td>For some of the level types, <code>GENERATOR_SETTINGS</code> can be used to further customize the world generation <a href="https://minecraft.fandom.com/wiki/Server.properties#generator-settings">as described here</a>.</td>
+            <td>For some of the level types, <code>GENERATOR_SETTINGS</code> can be used to further customize the world generation <a href="https://minecraft.wiki/w/Server.properties#generator-settings">as described here</a>.</td>
             <td><code></code></td>
             <td>⬜️</td>
         </tr>

docs/versions/java.md

@@ -13,25 +13,26 @@
 
 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. The `stable` tag is similar to `latest`; however, it tracks [the most recent repository release/tag](https://github.com/itzg/docker-minecraft-server/releases/latest).
 
-| Tag name          | Java version | Linux  | JVM Type    | Architecture      |
-|-------------------|--------------|--------|-------------|-------------------|
-| latest            | 17           | Ubuntu | Hotspot     | amd64,arm64,armv7 |
-| stable            | 17           | Ubuntu | Hotspot     | amd64,arm64,armv7 |
-| java8             | 8            | Alpine | Hotspot     | amd64             |
-| java8-jdk         | 8            | Ubuntu | Hotspot+JDK | amd64             |
-| java8-multiarch   | 8            | Ubuntu | Hotspot     | amd64,arm64,armv7 |
-| java8-openj9      | 8            | Debian | OpenJ9      | amd64             |
-| java8-graalvm-ce  | 8            | Oracle | GraalVM CE  | amd64             |
-| java11            | 11           | Ubuntu | Hotspot     | amd64,arm64,armv7 |
-| java11-jdk        | 11           | Ubuntu | Hotspot+JDK | amd64,arm64,armv7 |
-| java11-openj9     | 11           | Debian | OpenJ9      | amd64             |
-| java17            | 17           | Ubuntu | Hotspot     | amd64,arm64,armv7 |
-| java17-jdk        | 17           | Ubuntu | Hotspot+JDK | amd64,arm64,armv7 |
-| java17-openj9     | 17           | Debian | OpenJ9      | amd64             |
-| java17-graalvm-ce | 17           | Oracle | GraalVM CE  | amd64,arm64       |
-| java17-alpine     | 17           | Alpine | Hotspot     | amd64             |
-| java20-alpine     | 20           | Alpine | Hotspot     | amd64             |
-| java20            | 20           | Ubuntu | Hotspot     | amd64,arm64       |
+| Tag name         | Java version | Linux  | JVM Type       | Architecture      |
+|------------------|--------------|--------|----------------|-------------------|
+| latest           | 17           | Ubuntu | Hotspot        | amd64,arm64,armv7 |
+| stable           | 17           | Ubuntu | Hotspot        | amd64,arm64,armv7 |
+| java8            | 8            | Alpine | Hotspot        | amd64             |
+| java8-jdk        | 8            | Ubuntu | Hotspot+JDK    | amd64             |
+| java8-multiarch  | 8            | Ubuntu | Hotspot        | amd64,arm64,armv7 |
+| java8-openj9     | 8            | Debian | OpenJ9         | amd64             |
+| java8-graalvm-ce | 8            | Oracle | GraalVM CE     | amd64             |
+| java11           | 11           | Ubuntu | Hotspot        | amd64,arm64,armv7 |
+| java11-jdk       | 11           | Ubuntu | Hotspot+JDK    | amd64,arm64,armv7 |
+| java11-openj9    | 11           | Debian | OpenJ9         | amd64             |
+| java17           | 17           | Ubuntu | Hotspot        | amd64,arm64,armv7 |
+| java17-jdk       | 17           | Ubuntu | Hotspot+JDK    | amd64,arm64,armv7 |
+| java17-openj9    | 17           | Debian | OpenJ9         | amd64             |
+| java17-graalvm   | 17           | Oracle | Oracle GraalVM | amd64,arm64       |   
+| java17-alpine    | 17           | Alpine | Hotspot        | amd64             |
+| java20-alpine    | 20           | Alpine | Hotspot        | amd64             |
+| java20           | 20           | Ubuntu | Hotspot        | amd64,arm64       |
+| java21-graalvm   | 21           | Oracle | Oracle GraalVM | amd64,arm64       |   
 
 For example, to use Java version 8 on any supported architecture:
 
@@ -53,3 +54,5 @@ The following image tags have been deprecated and are no longer receiving update
 - openj9-nightly
 - multiarch-latest
 - java16/java16-openj9
+- java17-graalvm-ce
+- java20-graalvm

docs/versions/minecraft.md

@@ -2,7 +2,8 @@ To use a different Minecraft version, pass the `VERSION` environment variable (c
 
 - LATEST (the default)
 - SNAPSHOT
-- or a specific version, such as "1.7.9"
+- a specific version, such as "1.7.9"
+- or an alpha and beta version, such as "b1.7.3" (server download might not exist)
 
 For example, to use the latest snapshot:
 

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

@@ -706,5 +706,5 @@ update-client-command-list: true
 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
+# See here for more info: https://minecraft.wiki/Commands#Target_selectors
 resolve-command-selectors: false

files/property-definitions.json

@@ -0,0 +1,58 @@
+{
+  "motd": {"env": "MOTD"},
+  "gamemode": {"env": "MODE"},
+  "difficulty": {"env": "DIFFICULTY"},
+  "white-list": {"env": "WHITELIST_PROP"},
+  "enforce-whitelist": {"env": "ENFORCE_WHITELIST"},
+  "level-type": {"env": "LEVEL_TYPE"},
+  "server-name": {"env": "SERVER_NAME"},
+  "server-ip": {"env": "SERVER_IP"},
+  "server-port": {"env": "SERVER_PORT"},
+  "allow-nether": {"env": "ALLOW_NETHER"},
+  "announce-player-achievements": {"env": "ANNOUNCE_PLAYER_ACHIEVEMENTS"},
+  "enable-command-block": {"env": "ENABLE_COMMAND_BLOCK"},
+  "spawn-animals": {"env": "SPAWN_ANIMALS"},
+  "spawn-monsters": {"env": "SPAWN_MONSTERS"},
+  "spawn-npcs": {"env": "SPAWN_NPCS"},
+  "spawn-protection": {"env": "SPAWN_PROTECTION"},
+  "generate-structures": {"env": "GENERATE_STRUCTURES"},
+  "view-distance": {"env": "VIEW_DISTANCE"},
+  "hardcore": {"env": "HARDCORE"},
+  "snooper-enabled": {"env": "SNOOPER_ENABLED"},
+  "max-build-height": {"env": "MAX_BUILD_HEIGHT"},
+  "force-gamemode": {"env": "FORCE_GAMEMODE"},
+  "max-tick-time": {"env": "MAX_TICK_TIME"},
+  "enable-query": {"env": "ENABLE_QUERY"},
+  "query.port": {"env": "QUERY_PORT"},
+  "enable-rcon": {"env": "ENABLE_RCON"},
+  "rcon.password": {"env": "RCON_PASSWORD"},
+  "rcon.port": {"env": "RCON_PORT"},
+  "max-players": {"env": "MAX_PLAYERS"},
+  "max-world-size": {"env": "MAX_WORLD_SIZE"},
+  "level-name": {"env": "LEVEL"},
+  "level-seed": {"env": "SEED"},
+  "pvp": {"env": "PVP"},
+  "generator-settings": {"env": "GENERATOR_SETTINGS"},
+  "online-mode": {"env": "ONLINE_MODE"},
+  "allow-flight": {"env": "ALLOW_FLIGHT"},
+  "resource-pack": {"env": "RESOURCE_PACK"},
+  "resource-pack-sha1": {"env": "RESOURCE_PACK_SHA1"},
+  "require-resource-pack": {"env": "RESOURCE_PACK_ENFORCE"},
+  "player-idle-timeout": {"env": "PLAYER_IDLE_TIMEOUT"},
+  "broadcast-console-to-ops": {"env": "BROADCAST_CONSOLE_TO_OPS"},
+  "broadcast-rcon-to-ops": {"env": "BROADCAST_RCON_TO_OPS"},
+  "enable-jmx-monitoring": {"env": "ENABLE_JMX"},
+  "sync-chunk-writes": {"env": "SYNC_CHUNK_WRITES"},
+  "enable-status": {"env": "ENABLE_STATUS"},
+  "entity-broadcast-range-percentage": {"env": "ENTITY_BROADCAST_RANGE_PERCENTAGE"},
+  "function-permission-level": {"env": "FUNCTION_PERMISSION_LEVEL"},
+  "network-compression-threshold": {"env": "NETWORK_COMPRESSION_THRESHOLD"},
+  "op-permission-level": {"env": "OP_PERMISSION_LEVEL"},
+  "prevent-proxy-connections": {"env": "PREVENT_PROXY_CONNECTIONS"},
+  "use-native-transport": {"env": "USE_NATIVE_TRANSPORT"},
+  "simulation-distance": {"env": "SIMULATION_DISTANCE"},
+  "previews-chat": {"env": "PREVIEWS_CHAT"},
+  "enforce-secure-profile": {"env": "ENFORCE_SECURE_PROFILE"},
+  "initial-enabled-packs": {"env": "INITIAL_ENABLED_PACKS"},
+  "initial-disabled-packs": {"env": "INITIAL_DISABLED_PACKS"}
+}

mkdocs.yml

@@ -1,13 +1,12 @@
 ---
 site_name: Minecraft Server on Docker (Java Edition)
-site_url: https://docker-minecraft-server.readthedocs.io/
+site_url: https://docker-minecraft-server.readthedocs.io/en/latest/
 site_description: Documentation for Minecraft Server on Docker
 repo_url: https://github.com/itzg/docker-minecraft-server
 edit_uri: blob/master/docs/
 theme:
   name: material
   features:
-    - navigation.instant
     - navigation.tracking
     - navigation.tabs
     - navigation.tabs.sticky
@@ -54,9 +53,6 @@ copyright: Copyright © itzg 2023.
 plugins:
   - search
   - autorefs
-  - literate-nav:
-      nav_file: README.md
-      implicit_index: true
   - mkdocstrings:
       handlers:
         python:
@@ -68,8 +64,11 @@ plugins:
             show_signature_annotations: true
   # https://github.com/ultrabug/mkdocs-static-i18n
   - i18n:
-      default_language: en
       languages:
-        en:
+        - locale: en
           name: English
           build: true
+          default: true
+  - literate-nav:
+      nav_file: README.md
+      implicit_index: true

scripts/start

@@ -8,7 +8,6 @@
 : "${GID:=1000}"
 
 umask 0002
-chmod g+w /data
 
 if isTrue "${ENABLE_RCON:-true}" && ! [ -v RCON_PASSWORD ] && ! [ -v RCON_PASSWORD_FILE ]; then
   RCON_PASSWORD=$(openssl rand -hex 12)

scripts/start-configuration

@@ -185,6 +185,10 @@ case "${TYPE^^}" in
     exec "${SCRIPTS:-/}start-deployForge" "$@"
   ;;
 
+  NEOFORGE|NEOFORGED)
+    exec "${SCRIPTS:-/}start-deployNeoForge" "$@"
+  ;;
+
   FABRIC)
     exec "${SCRIPTS:-/}start-deployFabric" "$@"
   ;;

scripts/start-deployNeoForge

@@ -0,0 +1,30 @@
+#!/bin/bash
+
+: "${NEOFORGE_VERSION:=latest}"
+: "${NEOFORGE_FORCE_REINSTALL:=false}}"
+
+# shellcheck source=start-utils
+. "${SCRIPTS:-$(dirname "$0")}/start-utils"
+isDebugging && set -x
+
+resultsFile=/data/.run-neoforge.env
+
+if ! mc-image-helper install-neoforge \
+  --output-directory=/data \
+  --results-file=${resultsFile} \
+  --minecraft-version="${VERSION}" \
+  --neoforge-version="${NEOFORGE_VERSION}" \
+  --force-reinstall="${NEOFORGE_FORCE_REINSTALL}"; then
+    log "ERROR failed to install Forge"
+    exit 1
+fi
+
+# grab SERVER and export it
+set -a
+# shellcheck disable=SC1090
+source ${resultsFile}
+set +a
+
+export FAMILY=FORGE
+
+exec "${SCRIPTS:-/}start-setupWorld" "$@"

scripts/start-finalExec

@@ -221,7 +221,11 @@ function copyFilesForCurseForge() {
   cp -f /data/eula.txt "${FTB_DIR}/"
 }
 
-if versionLessThan 1.7; then
+if versionLessThan 'b1.8'; then
+  echo "
+DISABLE_HEALTHCHECK=true
+  " > /data/.mc-health.env
+elif versionLessThan 1.7; then
   echo "
 MC_HEALTH_EXTRA_ARGS=(
   --use-server-list-ping

scripts/start-setupModpack

@@ -229,16 +229,17 @@ function handleGenericPacks() {
 
 function handleModrinthProjects() {
   : "${MODRINTH_PROJECTS:=}"
-  : "${MODRINTH_DOWNLOAD_OPTIONAL_DEPENDENCIES:=true}"
   : "${MODRINTH_ALLOWED_VERSION_TYPE:=release}"
+  : "${MODRINTH_DOWNLOAD_DEPENDENCIES:=none}"
+  if [[ -v MODRINTH_DOWNLOAD_OPTIONAL_DEPENDENCIES ]]; then
+    log "WARNING The variable MODRINTH_DOWNLOAD_OPTIONAL_DEPENDENCIES is removed."
+    log "        Use MODRINTH_DOWNLOAD_DEPENDENCIES=optional instead"
+  fi
 
   if [[ $MODRINTH_PROJECTS ]] && isFamily HYBRID FORGE FABRIC SPIGOT; then
     if isFamily HYBRID FORGE; then
       loader=forge
-    elif isFamily FABRIC; then
-      loader=fabric
     else
-      # we're left with Bukkit/Spigot down-lines where plugins seem to be
       loader="${TYPE,,}"
     fi
     mc-image-helper modrinth \
@@ -246,7 +247,7 @@ function handleModrinthProjects() {
       --projects="${MODRINTH_PROJECTS}" \
       --game-version="${VERSION}" \
       --loader="$loader" \
-      --download-optional-dependencies="$MODRINTH_DOWNLOAD_OPTIONAL_DEPENDENCIES" \
+      --download-dependencies="$MODRINTH_DOWNLOAD_DEPENDENCIES" \
       --allowed-version-type="$MODRINTH_ALLOWED_VERSION_TYPE"
   fi
 }

scripts/start-setupRbac

@@ -2,20 +2,40 @@
 set -euo pipefail
 IFS=$'\n\t'
 
+: "${EXISTING_OPS_FILE:=SKIP}"
+: "${EXISTING_WHITELIST_FILE:=SKIP}"
+
 # shellcheck source=start-utils
 . "${SCRIPTS:-/}start-utils"
 isDebugging && set -x
 
+if [[ -v APPEND_OPS ]] && isTrue "${APPEND_OPS}"; then
+  EXISTING_OPS_FILE=MERGE
+elif [[ -v OVERRIDE_OPS ]] && isTrue "${OVERRIDE_OPS}"; then
+  EXISTING_OPS_FILE=SYNCHRONIZE
+fi
+
+if [[ -v APPEND_WHITELIST ]] && isTrue "${APPEND_WHITELIST}"; then
+  EXISTING_WHITELIST_FILE=MERGE
+elif [[ -v OVERRIDE_WHITELIST ]] && isTrue "${OVERRIDE_WHITELIST}"; then
+  EXISTING_WHITELIST_FILE=SYNCHRONIZE
+fi
+
 sharedArgs=(--version="$VERSION")
 if isFalse "${ONLINE_MODE:-true}"; then
   sharedArgs+=( --offline )
 fi
 
 if [[ -v OPS_FILE ]]; then
+  existing="$EXISTING_OPS_FILE"
+  if [[ "$EXISTING_OPS_FILE" = SYNC_FILE_MERGE_LIST ]]; then
+    existing=SYNCHRONIZE
+  fi
   mc-image-helper manage-users \
     "${sharedArgs[@]}" \
     --type=JAVA_OPS \
     --input-is-file \
+    --existing="${existing}" \
     "$OPS_FILE"
 fi
 if [[ -v OPS ]]; then
@@ -23,29 +43,44 @@ if [[ -v OPS ]]; then
   if isTrue "${APPEND_OPS:-false}" || isFalse "${OVERRIDE_OPS:-true}"; then
     args+=(--append-only)
   fi
+  existing="$EXISTING_OPS_FILE"
+  if [[ "$EXISTING_OPS_FILE" = SYNC_FILE_MERGE_LIST ]]; then
+    existing=MERGE
+  fi
   # shellcheck disable=SC2086
   mc-image-helper manage-users \
     "${sharedArgs[@]}" "${args[@]}" \
     --type=JAVA_OPS \
+    --existing="${existing}" \
     $OPS
 fi
 
 if [[ -v WHITELIST_FILE ]]; then
+  existing="$EXISTING_WHITELIST_FILE"
+  if [[ "$EXISTING_WHITELIST_FILE" = SYNC_FILE_MERGE_LIST ]]; then
+    existing=SYNCHRONIZE
+  fi
   mc-image-helper manage-users \
     "${sharedArgs[@]}" \
     --type=JAVA_WHITELIST \
     --input-is-file \
-    "$WHITELIST_FILE"
+    --existing="${existing}" \
+   "$WHITELIST_FILE"
 fi
 if [[ -v WHITELIST ]]; then
   args=()
   if isTrue "${APPEND_WHITELIST:-false}" || isFalse "${OVERRIDE_WHITELIST:-true}"; then
     args+=(--append-only)
   fi
+  existing="$EXISTING_WHITELIST_FILE"
+  if [[ "$EXISTING_WHITELIST_FILE" = SYNC_FILE_MERGE_LIST ]]; then
+    existing=MERGE
+  fi
   # shellcheck disable=SC2086
   mc-image-helper manage-users \
     "${sharedArgs[@]}" "${args[@]}" \
     --type=JAVA_WHITELIST \
+    --existing="${existing}" \
     $WHITELIST
 fi
 

scripts/start-setupServerProperties

@@ -8,49 +8,18 @@
 : "${SKIP_SERVER_PROPERTIES:=false}"
 : "${ENABLE_WHITELIST:=}"
 
-# FUNCTIONS
-function setServerPropValue {
-  local prop=$1
-  local value=$2
-  # normalize booleans
-  case ${value^^} in
-    TRUE|FALSE)
-      value=${value,,} ;;
-  esac
-  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
-    debug "Adding ${prop} with '${showValue}' in ${SERVER_PROPERTIES}"
-    echo "${prop}=${value}" >> "$SERVER_PROPERTIES"
-  fi
-}
-
-function setServerProp {
-  local prop=$1
-  local varName=$2
-
-  if [ -v $varName ]; then
-    setServerPropValue "$prop" "${!varName}"
-  fi
-}
-
 function customizeServerProps {
   local firstSetup=$1
   # Whitelist processing
   if [ -n "$WHITELIST" ] || [ -n "$WHITELIST_FILE" ] || isTrue "${ENABLE_WHITELIST}"; then
     log "Enabling whitelist functionality"
-    setServerPropValue "white-list" "true"
-    setServerPropValue "enforce-whitelist" "true"
+    WHITELIST_PROP=true
+    ENFORCE_WHITELIST=true
+    export WHITELIST_PROP ENFORCE_WHITELIST
   elif isTrue "$firstSetup" || isFalse "${ENABLE_WHITELIST}"; then
     log "Disabling whitelist functionality"
-    setServerPropValue "white-list" "false"
-    setServerProp "enforce-whitelist" ENFORCE_WHITELIST
+    WHITELIST_PROP=false
+    export WHITELIST_PROP
   fi
 
   # normalize MOTD
@@ -60,100 +29,7 @@ function customizeServerProps {
     fi
   fi
 
-  setServerProp "server-name" SERVER_NAME
-  setServerProp "server-ip" SERVER_IP
-  setServerProp "server-port" SERVER_PORT
-  setServerProp "allow-nether" ALLOW_NETHER
-  setServerProp "announce-player-achievements" ANNOUNCE_PLAYER_ACHIEVEMENTS
-  setServerProp "enable-command-block" ENABLE_COMMAND_BLOCK
-  setServerProp "spawn-animals" SPAWN_ANIMALS
-  setServerProp "spawn-monsters" SPAWN_MONSTERS
-  setServerProp "spawn-npcs" SPAWN_NPCS
-  setServerProp "spawn-protection" SPAWN_PROTECTION
-  setServerProp "generate-structures" GENERATE_STRUCTURES
-  setServerProp "view-distance" VIEW_DISTANCE
-  setServerProp "hardcore" HARDCORE
-  setServerProp "snooper-enabled" SNOOPER_ENABLED
-  setServerProp "max-build-height" MAX_BUILD_HEIGHT
-  setServerProp "force-gamemode" FORCE_GAMEMODE
-  setServerProp "max-tick-time" MAX_TICK_TIME
-  setServerProp "enable-query" ENABLE_QUERY
-  setServerProp "query.port" QUERY_PORT
-  setServerProp "enable-rcon" ENABLE_RCON
-  setServerProp "rcon.password" RCON_PASSWORD
-  setServerProp "rcon.port" RCON_PORT
-  setServerProp "max-players" MAX_PLAYERS
-  setServerProp "max-world-size" MAX_WORLD_SIZE
-  setServerProp "level-name" LEVEL
-  setServerProp "level-seed" SEED
-  setServerProp "pvp" PVP
-  setServerProp "generator-settings" GENERATOR_SETTINGS
-  setServerProp "online-mode" ONLINE_MODE
-  setServerProp "allow-flight" ALLOW_FLIGHT
-  setServerProp "resource-pack" RESOURCE_PACK
-  setServerProp "resource-pack-sha1" RESOURCE_PACK_SHA1
-  setServerProp "require-resource-pack" RESOURCE_PACK_ENFORCE
-  setServerProp "player-idle-timeout" PLAYER_IDLE_TIMEOUT
-  setServerProp "broadcast-console-to-ops" BROADCAST_CONSOLE_TO_OPS
-  setServerProp "broadcast-rcon-to-ops" BROADCAST_RCON_TO_OPS
-  setServerProp "enable-jmx-monitoring" ENABLE_JMX
-  setServerProp "sync-chunk-writes" SYNC_CHUNK_WRITES
-  setServerProp "enable-status" ENABLE_STATUS
-  setServerProp "entity-broadcast-range-percentage" ENTITY_BROADCAST_RANGE_PERCENTAGE
-  setServerProp "function-permission-level" FUNCTION_PERMISSION_LEVEL
-  setServerProp "network-compression-threshold" NETWORK_COMPRESSION_THRESHOLD
-  setServerProp "op-permission-level" OP_PERMISSION_LEVEL
-  setServerProp "prevent-proxy-connections" PREVENT_PROXY_CONNECTIONS
-  setServerProp "use-native-transport" USE_NATIVE_TRANSPORT
-  setServerProp "simulation-distance" SIMULATION_DISTANCE
-  setServerProp "previews-chat" PREVIEWS_CHAT
-  setServerProp "enforce-secure-profile" ENFORCE_SECURE_PROFILE
-  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
-    case ${DIFFICULTY,,} in
-      peaceful|0)
-        if versionLessThan 1.13; then
-          DIFFICULTY=0
-        else
-          DIFFICULTY=peaceful
-        fi
-        ;;
-      easy|1)
-        if versionLessThan 1.13; then
-          DIFFICULTY=1
-        else
-          DIFFICULTY=easy
-        fi
-        ;;
-      normal|2)
-        if versionLessThan 1.13; then
-          DIFFICULTY=2
-        else
-          DIFFICULTY=normal
-        fi
-        ;;
-      hard|3)
-        if versionLessThan 1.13; then
-          DIFFICULTY=3
-        else
-          DIFFICULTY=hard
-        fi
-        ;;
-      *)
-        log "DIFFICULTY must be peaceful, easy, normal, or hard."
-        exit 1
-        ;;
-    esac
-    setServerPropValue "difficulty" "$DIFFICULTY"
-  fi
-
-  if [ -n "$MODE" ]; then
+  if [[ -v MODE ]]; then
     log "Setting mode"
     case ${MODE,,} in
       su*|0)
@@ -189,8 +65,58 @@ function customizeServerProps {
         exit 1
         ;;
     esac
-    setServerPropValue "gamemode" "$MODE"
   fi
+
+  if [[ -v DIFFICULTY ]]; then
+    case ${DIFFICULTY,,} in
+      peaceful|0)
+        if versionLessThan 1.13; then
+          DIFFICULTY=0
+        else
+          DIFFICULTY=peaceful
+        fi
+        ;;
+      easy|1)
+        if versionLessThan 1.13; then
+          DIFFICULTY=1
+        else
+          DIFFICULTY=easy
+        fi
+        ;;
+      normal|2)
+        if versionLessThan 1.13; then
+          DIFFICULTY=2
+        else
+          DIFFICULTY=normal
+        fi
+        ;;
+      hard|3)
+        if versionLessThan 1.13; then
+          DIFFICULTY=3
+        else
+          DIFFICULTY=hard
+        fi
+        ;;
+      *)
+        log "DIFFICULTY must be peaceful, easy, normal, or hard."
+        exit 1
+        ;;
+    esac
+  fi
+
+  if [[ -v LEVEL_TYPE ]]; then
+    LEVEL_TYPE="${LEVEL_TYPE^^}"
+  fi
+
+  setPropertiesArgs=(
+    --definitions "/image/property-definitions.json"
+  )
+  if [[ -v CUSTOM_SERVER_PROPERTIES ]]; then
+    setPropertiesArgs+=(--custom-properties "$CUSTOM_SERVER_PROPERTIES")
+  fi
+
+  mc-image-helper set-properties "${setPropertiesArgs[@]}" "$SERVER_PROPERTIES"
+
 }
 
 # Deploy server.properties file

tests/setuponlytests/spiget/require.sh

@@ -0,0 +1 @@
+[[ $EXTENDED_TESTS ]] || exit 1