Merge branch 'master' of github.com:itzg/docker-minecraft-server

#891 #1041

.github/FUNDING.yml

@@ -0,0 +1,5 @@
+
+#github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+custom:
+  - https://www.buymeacoffee.com/itzg
+  - https://paypal.me/itzg

.github/workflows/build-multiarch.yml

@@ -5,7 +5,6 @@ on:
       - master
       - "*-multiarch"
       - "multiarch*"
-      - java7
       - java8-openj9
       - java11*
       - java16*
@@ -64,10 +63,10 @@ jobs:
 
       - name: Build and push
         id: docker_build
-        uses: docker/build-push-action@v2.6.1
+        uses: docker/build-push-action@v2.7.0
         with:
           context: .
-          platforms: linux/amd64,linux/arm/v7
+          platforms: linux/amd64,linux/arm/v7,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}
           # ensure latest base image is used

.github/workflows/generate-toc.yml

@@ -16,6 +16,6 @@ jobs:
           curl https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc -o gh-md-toc
           chmod a+x gh-md-toc
           ./gh-md-toc --insert --no-backup README.md
-      - uses: stefanzweifel/git-auto-commit-action@v4.11.0
+      - uses: stefanzweifel/git-auto-commit-action@v4.12.0
         with:
           commit_message: "docs: Auto update markdown TOC"

.github/workflows/main.yml

@@ -70,7 +70,7 @@ jobs:
 
     - name: Build and push
       id: docker_build
-      uses: docker/build-push-action@v2.6.1
+      uses: docker/build-push-action@v2.7.0
       with:
         context: .
         file: ./Dockerfile

Dockerfile

@@ -1,4 +1,4 @@
-FROM openjdk:7-jre
+FROM adoptopenjdk:16-jre
 
 LABEL org.opencontainers.image.authors="Geoff Bourne <itzgeoff@gmail.com>"
 
@@ -6,8 +6,10 @@ RUN apt-get update \
   && DEBIAN_FRONTEND=noninteractive \
   apt-get install -y \
     imagemagick \
+    gosu \
     sudo \
     net-tools \
+    iputils-ping \
     curl wget \
     git \
     jq \
@@ -21,42 +23,6 @@ RUN apt-get update \
     ttf-dejavu \
     && apt-get clean
 
-# Procedure from https://github.com/tianon/gosu/blob/master/INSTALL.md#from-debian
-ENV GOSU_VERSION 1.14
-RUN set -eux; \
-# save list of currently installed packages for later so we can clean up
-	savedAptMark="$(apt-mark showmanual)"; \
-	apt-get update; \
-	apt-get install -y --no-install-recommends ca-certificates wget; \
-	if ! command -v gpg; then \
-		apt-get install -y --no-install-recommends gnupg2 dirmngr; \
-	elif gpg --version | grep -q '^gpg (GnuPG) 1\.'; then \
-# "This package provides support for HKPS keyservers." (GnuPG 1.x only)
-		apt-get install -y --no-install-recommends gnupg-curl; \
-	fi; \
-	rm -rf /var/lib/apt/lists/*; \
-	\
-	dpkgArch="$(dpkg --print-architecture | awk -F- '{ print $NF }')"; \
-	wget -O /usr/local/bin/gosu "https://github.com/tianon/gosu/releases/download/$GOSU_VERSION/gosu-$dpkgArch"; \
-	wget -O /usr/local/bin/gosu.asc "https://github.com/tianon/gosu/releases/download/$GOSU_VERSION/gosu-$dpkgArch.asc"; \
-	\
-# verify the signature
-	export GNUPGHOME="$(mktemp -d)"; \
-	gpg --batch --keyserver hkps://keys.openpgp.org --recv-keys B42F6819007F00F88E364FD4036A9C25BF357DD4; \
-	gpg --batch --verify /usr/local/bin/gosu.asc /usr/local/bin/gosu; \
-	command -v gpgconf && gpgconf --kill all || :; \
-	rm -rf "$GNUPGHOME" /usr/local/bin/gosu.asc; \
-	\
-# clean up fetch dependencies
-	apt-mark auto '.*' > /dev/null; \
-	[ -z "$savedAptMark" ] || apt-mark manual $savedAptMark; \
-	apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false; \
-	\
-	chmod +x /usr/local/bin/gosu; \
-# verify that the binary works
-	gosu --version; \
-	gosu nobody true
-
 RUN addgroup --gid 1000 minecraft \
   && adduser --system --shell /bin/false --uid 1000 --ingroup minecraft --home /data minecraft
 
@@ -87,13 +53,17 @@ 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=mc-server-runner --file {{.app}} \
+ --var version=1.7.0 --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 ASCIIFY_VERSION=1.0.1
+ADD https://jitpack.io/com/github/itzg/asciify/${ASCIIFY_VERSION}/asciify-${ASCIIFY_VERSION}.jar /usr/share/asciify/asciify.jar
+RUN chmod -R a+r /usr/share/asciify
+
 COPY mcstatus /usr/local/bin
 
 VOLUME ["/data"]

README.md

@@ -38,6 +38,7 @@ By default, the container will download the latest version of the "vanilla" [Min
       * [Examples](#examples)
       * [Amazon Web Services (AWS) Deployment](#amazon-web-services-aws-deployment)
       * [Using Docker Compose](#using-docker-compose)
+   * [Troubleshooting](#troubleshooting)
    * [Server types](#server-types)
       * [Running a Forge Server](#running-a-forge-server)
       * [Running a Bukkit/Spigot server](#running-a-bukkitspigot-server)
@@ -116,19 +117,20 @@ By default, the container will download the latest version of the "vanilla" [Min
       * [Server Shutdown Options](#server-shutdown-options)
       * [OpenJ9 Specific Options](#openj9-specific-options)
       * [Enabling rolling logs](#enabling-rolling-logs)
-   * [Timezone Configuration](#timezone-configuration)
+      * [Timezone Configuration](#timezone-configuration)
       * [Enable Remote JMX for Profiling](#enable-remote-jmx-for-profiling)
       * [Enable Aikar's Flags](#enable-aikars-flags)
       * [HTTP Proxy](#http-proxy)
       * [Using "noconsole" option](#using-noconsole-option)
       * [Explicitly disable GUI](#explicitly-disable-gui)
       * [Stop Duration](#stop-duration)
+      * [Setup only](#setup-only)
    * [Autopause](#autopause)
       * [Description](#description)
       * [Enabling Autopause](#enabling-autopause)
    * [Running on RaspberryPi](#running-on-raspberrypi)
 
-<!-- Added by: runner, at: Sun Aug 15 17:44:45 UTC 2021 -->
+<!-- Added by: runner, at: Thu Sep 16 01:45:44 UTC 2021 -->
 
 <!--te-->
 
@@ -270,9 +272,9 @@ To use a different version of Java, please use a docker tag to run your Minecraf
 | java16-openj9  | 16           | Debian | OpenJ9   | amd64             |
 | multiarch-latest | 15+        | Debian | Hotspot  | amd64,arm64,armv7 |
 
-For example, to use Java version 15 on any supported architecture:
+For example, to use Java version 16 on any supported architecture:
 
-    docker run --name mc itzg/minecraft-server:java15
+    docker run --name mc itzg/minecraft-server:java16
 
 > Keep in mind that some versions of Minecraft server can't work on the newest versions of Java. Also, FORGE doesn't support openj9 JVM implementation.
 
@@ -350,6 +352,14 @@ and in the same directory as that file run
 Now, go play...or adjust the `environment` section to configure
 this server instance.
 
+## Troubleshooting
+
+To troubleshoot the container initialization, such as when server files are pre-downloaded, set the environment variable `DEBUG` to `true`. The container logs will include **much more** output, and it is highly recommended including that output when reporting any [issues](https://github.com/itzg/docker-minecraft-server/issues).
+
+To troubleshoot just the command-line used to start the Minecraft server, set the environment variable `DEBUG_EXEC` to `true`.
+
+To troubleshoot any issues with memory allocation reported by the JVM, set the environment variable `DEBUG_MEMORY` to `true`.
+
 ## Server types
 
 ### Running a Forge Server
@@ -736,6 +746,10 @@ read-only volume attachment to ensure the clone source remains pristine.
 docker run ... -v $HOME/worlds:/worlds:ro -e WORLD=/worlds/basic
 ```
 
+The following diagram shows how this option can be used in a compose deployment with a relative directory:
+
+![](docs/world-copy-compose-project.drawio.png)
+
 ### Overwrite world on start
 The world will only be downloaded or copied if it doesn't exist already. Set `FORCE_WORLD_COPY=TRUE` to force overwrite the world on every server start.
 
@@ -814,7 +828,7 @@ The server icon which has been set doesn't get overridden by default. It can be
 
 ### Rcon
 
-To use rcon use the `ENABLE_RCON` and `RCON_PASSORD` variables.
+To use rcon use the `ENABLE_RCON` and `RCON_PASSWORD` variables.
 By default rcon port will be `25575` but can easily be changed with the `RCON_PORT` variable.
 
     docker run -d -e ENABLE_RCON=true -e RCON_PASSWORD=testing
@@ -959,7 +973,7 @@ For example:
 
 ### Message of the Day
 
-The message of the day, shown below each server entry in the UI, can be changed with the `MOTD` environment variable, such as
+The message of the day, shown below each server entry in the client UI, can be changed with the `MOTD` environment variable, such as
 
     -e MOTD="My Server"
 
@@ -969,6 +983,14 @@ 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,
+
+     -e MOTD="A §l§cMinecraft§r §nserver"
+
+renders
+
+![](docs/motd-example.png)
+
 ### PVP Mode
 
 By default, servers are created with player-vs-player (PVP) mode enabled. You can disable this with the `PVP`
@@ -1000,6 +1022,10 @@ For example (just the `-e` bits):
 
     -e LEVEL_TYPE=flat -e 'GENERATOR_SETTINGS=3;minecraft:bedrock,3*minecraft:stone,52*minecraft:sandstone;2;'
 
+In Minecraft 1.13+ you need to pass json ([generator site](https://misode.github.io/world/)) like this (details see [here](https://github.com/itzg/docker-minecraft-server/issues/999#issuecomment-907849644)):
+
+    -e LEVEL_TYPE=flat -e 'GENERATOR_SETTINGS={"biome":"minecraft:the_void","layers":[{"block":"minecraft:bedrock","height":1},{"block":"minecraft:stone","height":10},{"block":"minecraft:dirt","height":1}],"structures":{"structures":{}}}'
+
 ### Custom Server Resource Pack
 
 You can set a link to a custom resource pack and set it's checksum using the `RESOURCE_PACK` and `RESOURCE_PACK_SHA1` options respectively, the default is blank:
@@ -1251,7 +1277,7 @@ By default the vanilla log file will grow without limit. The logger can be recon
 
 > **NOTE** this will interfere with interactive/color consoles [as described in the section above](#interactive-and-color-console)
 
-## Timezone Configuration
+### Timezone Configuration
 
 You can configure the timezone to match yours by setting the `TZ` environment variable:
 
@@ -1310,6 +1336,10 @@ disable that by passing `-e GUI=FALSE`.
 
 When the container is signalled to stop, the Minecraft process wrapper will attempt to send a "stop" command via RCON or console and waits for the process to gracefully finish. By default it waits 60 seconds, but that duration can be configured by setting the environment variable `STOP_DURATION` to the number of seconds.
 
+### Setup only
+
+If you are using a host-attached data directory, then you can have the image setup the Minecraft server files and stop prior to launching the server process by setting `SETUP_ONLY` to `true`. 
+
 ## Autopause
 
 ### Description

examples/docker-compose-rlcraft.yml

@@ -0,0 +1,27 @@
+version: '3.8'
+
+services:
+  rlcraft:
+    image: itzg/minecraft-server:java8
+    container_name: rlcraft
+    volumes:
+    - rlcraft-modpack:/modpacks:ro
+    - rlcraft-data:/data
+    environment:
+      EULA: "true"
+      TYPE: "FORGE"
+      VERSION: "1.12.2"
+      FORGEVERSION: "14.23.5.2855"
+      DIFFICULTY: "hard"
+      MAX_TICK_TIME: "-1"
+      VIEW_DISTANCE: "6"
+      ALLOW_FLIGHT: "true"
+      MEMORY: "4G"
+      GENERIC_PACK: "/modpacks/RLCraft_Server_Pack_1.12.2_Beta_v2.8.2.zip"
+    ports:
+      - 25565:25565
+    restart: unless-stopped
+
+volumes:
+  rlcraft-data:
+  rlcraft-modpack:

start-deployLimbo

@@ -9,6 +9,10 @@ isDebugging && set -x
 : ${FORCE_REDOWNLOAD:=false}
 : ${LIMBO_SCHEMA_FILENAME:=default.schem}
 : ${LEVEL:=Default;${LIMBO_SCHEMA_FILENAME}}
+# defaults to localhost, if this is not set
+: ${SERVER_IP:=0.0.0.0}
+
+export LEVEL SERVER_IP
 
 if [[ ${LIMBO_BUILD^^} == LATEST ]]; then
   LIMBO_BUILD=lastStableBuild
@@ -22,11 +26,14 @@ if [ $? != 0 ]; then
   exit 1
 fi
 
-PURPUR_BUILD=$(jq -r '.number' <<<${buildJson})
+if [[ ${LIMBO_BUILD} = lastStableBuild ]]; then
+  LIMBO_BUILD=$(jq -r '.number' <<<${buildJson})
+  log "Resolved latest Limbo build to ${LIMBO_BUILD}"
+fi
 artifactPath=$(jq -r '.artifacts[] | select(.fileName|test("^Limbo-")) | .relativePath' <<<${buildJson})
 defaultSchemaPath=$(jq -r '.artifacts[] | select(.fileName|test(".*\\.schem")) | .relativePath' <<<${buildJson})
 
-export SERVER="purpur-${PURPUR_BUILD}.jar"
+export SERVER="limbo-${LIMBO_BUILD}.jar"
 
 if [ ! -f "$SERVER" ] || isTrue "$FORCE_REDOWNLOAD"; then
     downloadUrl="${baseUrl}/artifact/${artifactPath}"
@@ -46,7 +53,7 @@ if [ ! -f "${LIMBO_SCHEMA_FILENAME}" ]; then
   fi
 fi
 
-if [[ ${LEVEL} != "*;*" ]]; then
+if [[ ${LEVEL} != *\;* ]]; then
   LEVEL="${LEVEL};${LIMBO_SCHEMA_FILENAME}"
 fi
 export LEVEL

start-finalSetupModpack

@@ -154,7 +154,10 @@ fi
 if [[ "${GENERIC_PACK}" ]]; then
   if isURL "${GENERIC_PACK}"; then
     log "Downloading generic pack ..."
-    curl -fsSL -o /tmp/generic_pack.zip "${GENERIC_PACK}"
+    if ! curl -fsSL -o /tmp/generic_pack.zip "${GENERIC_PACK}"; then
+      log "ERROR: failed to download ${GENERIC_PACK}"
+      exit 2
+    fi
     GENERIC_PACK=/tmp/generic_pack.zip
   fi
 

start-finalSetupServerProperties

@@ -56,7 +56,7 @@ function customizeServerProps {
   setServerProp "server-name" "$SERVER_NAME"
   setServerProp "server-ip" "$SERVER_IP"
   setServerProp "server-port" "$SERVER_PORT"
-  setServerProp "motd" "$MOTD"
+  setServerProp "motd" "$(echo $MOTD | java -jar /usr/share/asciify/asciify.jar)"
   setServerProp "allow-nether" "$ALLOW_NETHER"
   setServerProp "announce-player-achievements" "$ANNOUNCE_PLAYER_ACHIEVEMENTS"
   setServerProp "enable-command-block" "$ENABLE_COMMAND_BLOCK"