Auto-merging docker-versions-create.sh

CONFLICT (content): Merge conflict in docker-versions-create.sh
Auto-merging README.md
CONFLICT (content): Merge conflict in README.md
Automatic merge failed; fix conflicts and then commit the result.

.github/workflows/build-multiarch.yml

@@ -0,0 +1,80 @@
+name: Build and publish multiarch
+on:
+  push:
+    branches:
+      - multiarch
+      - java8-multiarch
+      - multiarch-latest
+      - java15
+      - test/multiarch/*
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+-multiarch"
+      - "[0-9]+.[0-9]+.[0-9]+-multiarch-latest"
+      - "[0-9]+.[0-9]+.[0-9]+-java15"
+
+jobs:
+  docker-buildx:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2.2.0
+
+      - name: Prepare
+        id: prep
+        run: |
+          DOCKER_IMAGE=itzg/minecraft-server
+          VERSION=edge
+          if [[ $GITHUB_REF == refs/tags/* ]]; then
+            VERSION=${GITHUB_REF#refs/tags/}
+          fi
+          if [[ $GITHUB_REF == refs/heads/* ]]; then
+            VERSION=${GITHUB_REF#refs/heads/}
+            if [[ $VERSION == master ]]; then
+              VERSION=latest
+            fi
+          fi
+          TAGS="${DOCKER_IMAGE}:${VERSION//\//-}"
+          echo ::set-output name=tags::${TAGS}
+          echo ::set-output name=cache_from::${TAGS}
+          echo ::set-output name=version::${VERSION//\//-}
+          echo ::set-output name=cache_version::${VERSION//\//-}
+
+      - name: Setup Docker Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Cache Docker layers
+        uses: actions/cache@v2
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ steps.prep.outputs.cache_version }}-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-${{ steps.prep.outputs.cache_version }}-
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_USER }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Build and push
+        id: docker_build
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: ./Dockerfile
+          platforms: linux/amd64,linux/arm/v7,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.prep.outputs.tags }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+          labels: |
+            org.opencontainers.image.documentation=https://github.com/itzg/docker-minecraft-server
+            org.opencontainers.image.source=https://github.com/itzg/docker-minecraft-server
+            org.opencontainers.image.version=${{ steps.prep.outputs.version }}
+            org.opencontainers.image.revision=${{ github.sha }}
+
+      - name: Image digest
+        run: echo ${{ steps.docker_build.outputs.digest }}

.github/workflows/main.yml

@@ -4,24 +4,22 @@ on:
   push:
     branches:
       - master
+      - java8
       - openj9
-      - openj9-nightly
+      - openj9-11
       - adopt11
-      - adopt13
-      - adopt14
-      - adopt15
+      - test/*
     tags:
       - "[0-9]+.[0-9]+.[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+-java8"
       - "[0-9]+.[0-9]+.[0-9]+-openj9"
+      - "[0-9]+.[0-9]+.[0-9]+-openj9-11"
       - "[0-9]+.[0-9]+.[0-9]+-openj9-nightly"
       - "[0-9]+.[0-9]+.[0-9]+-adopt11"
-      - "[0-9]+.[0-9]+.[0-9]+-adopt13"
-      - "[0-9]+.[0-9]+.[0-9]+-adopt14"
-      - "[0-9]+.[0-9]+.[0-9]+-adopt15"
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
 
     steps:
       - uses: actions/checkout@v2
@@ -32,20 +30,68 @@ jobs:
   build:
     needs:
       - test
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
 
     steps:
     - uses: actions/checkout@v2
 
-    - name: Build and push Docker images
-      uses: docker/build-push-action@v1.1.0
+    - name: Prepare
+      id: prep
+      run: |
+        DOCKER_IMAGE=itzg/minecraft-server
+        VERSION=edge
+        if [[ $GITHUB_REF == refs/tags/* ]]; then
+          VERSION=${GITHUB_REF#refs/tags/}
+        fi
+        if [[ $GITHUB_REF == refs/heads/* ]]; then
+          VERSION=${GITHUB_REF#refs/heads/}
+          if [[ $VERSION == master ]]; then
+            VERSION=latest
+          fi
+        fi
+        TAGS="${DOCKER_IMAGE}:${VERSION//\//-}"
+        echo ::set-output name=tags::${TAGS}
+        echo ::set-output name=cache_from::${TAGS}
+        echo ::set-output name=version::${VERSION//\//-}
+        echo ::set-output name=cache_version::${VERSION//\//-}
+
+    - name: Setup Docker Buildx
+      uses: docker/setup-buildx-action@v1
+
+    - name: Cache Docker layers
+      uses: actions/cache@v2
+      with:
+        path: /tmp/.buildx-cache
+        key: ${{ runner.os }}-buildx-${{ steps.prep.outputs.cache_version }}-${{ github.sha }}
+        restore-keys: |
+          ${{ runner.os }}-buildx-${{ steps.prep.outputs.cache_version }}-
+          ${{ runner.os }}-buildx-
+
+    - name: Login to DockerHub
+      uses: docker/login-action@v1
       with:
-        repository: itzg/minecraft-server
         username: ${{ secrets.DOCKER_USER }}
         password: ${{ secrets.DOCKER_PASSWORD }}
-        tag_with_ref: true
-        tag_with_sha: false
-        cache_froms: itzg/minecraft-server:latest
-        add_git_labels: true
-        labels: org.opencontainers.image.url=https://github.com/itzg/docker-minecraft-server,org.opencontainers.image.documentation=https://github.com/itzg/docker-minecraft-server
+
+    - name: Build and push
+      id: docker_build
+      uses: docker/build-push-action@v2
+      with:
+        context: .
+        file: ./Dockerfile
+        # ensure latest base image is used
+        pull: true
+        # publish
         push: true
+        # tags determined by prep step
+        tags: ${{ steps.prep.outputs.tags }}
+        cache-from: type=local,src=/tmp/.buildx-cache
+        cache-to: type=local,dest=/tmp/.buildx-cache
+        labels: |
+          org.opencontainers.image.documentation=https://github.com/itzg/docker-minecraft-server
+          org.opencontainers.image.version=${{ steps.prep.outputs.version }}
+          org.opencontainers.image.source=https://github.com/itzg/docker-minecraft-server
+          org.opencontainers.image.revision=${{ github.sha }}
+
+    - name: Image digest
+      run: echo ${{ steps.docker_build.outputs.digest }}

Dockerfile

@@ -1,4 +1,4 @@
-FROM openjdk:8u212-jre-alpine
+FROM adoptopenjdk/openjdk11:alpine-jre
 
 LABEL org.opencontainers.image.authors="Geoff Bourne <itzgeoff@gmail.com>"
 

README.md

@@ -116,8 +116,24 @@ to map a directory on your host machine to the container's `/data` directory, su
 
     docker run -d -v /path/on/host:/data ...
 
-When attached in this way you can stop the server, edit the configuration under your attached `/path/on/host`
-and start the server again with `docker start CONTAINERID` to pick up the new configuration.
+When attached in this way you can stop the server, edit the configuration under your attached `/path/on/host` and start the server again with `docker start CONTAINER_ID` to pick up the new configuration.
+
+As example, using Docker compose, create the following `docker-compose.yml` in its own directory and the container will automatically create/attach the relative directory `data` to the container:
+
+```yaml
+version: "3"
+
+services:
+  mc:
+    image: itzg/minecraft-server
+    ports:
+      - 25565:25565
+    environment:
+      EULA: "TRUE"
+    volumes:
+      # attach the relative directory 'data' to the container's /data path
+      ./data:/data
+```
 
 ## Versions
 
@@ -144,23 +160,31 @@ the server jar remain in the `/data` directory. It is safe to remove those._
 
 To use a different version of Java, please use a docker tag to run your Minecraft server.
 
-| Tag name       | Description                                 | Linux        |
-| -------------- | ------------------------------------------- | ------------ |
-| latest         | **Default**. Uses Java version 8            | Alpine Linux |
-| adopt15        | Uses Java version 15 from AdoptOpenJDK      | Alpine Linux |
-| adopt14        | Uses Java version 14 from AdoptOpenJDK      | Alpine Linux |
-| adopt13        | Uses Java version 13 from AdoptOpenJDK      | Alpine Linux |
-| adopt11        | Uses Java version 11 from AdoptOpenJDK      | Alpine Linux |
-| openj9         | Uses Eclipse OpenJ9 JVM                     | Alpine Linux |
-| openj9-nightly | Uses Eclipse OpenJ9 JVM testing builds      | Alpine Linux |
-| multiarch      | Uses Java version 8 latest update           | Debian Linux |
-| multiarch-latest | Uses Java version 15 latest update        | Debian Linux |
+| Tag name       | Java version | Linux  | JVM Type | Architecture      |
+| -------------- | -------------|--------|----------|-------------------|
+| latest         | 11           | Alpine | Hotspot  | amd64             |
+| java8          | 8            | Alpine | Hotspot  | amd64             |
+| java8-multiarch | 8           | Debian | Hotspot  | amd64,arm64,armv7 |
+| java15         | 15           | Debian | Hotspot  | amd64,arm64,armv7 |
+| adopt11        | 11           | Alpine | Hotspot  | amd64             |
+| openj9         | 8            | Alpine | OpenJ9   | amd64             |
+| openj9-11      | 11           | Alpine | OpenJ9   | amd64             |
+| multiarch      | 11           | Debian | Hotspot  | amd64,arm64,armv7 |
+| multiarch-latest | 15+        | Debian | Hotspot  | amd64,arm64,armv7 |
 
-For example, to use a Java version 13:
+For example, to use Java version 15 on any supported architecture:
 
-    docker run --name mc itzg/minecraft-server:adopt13
+    docker run --name mc itzg/minecraft-server:java15
 
-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.
+> 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.
+
+### Deprecated Image Tags
+
+The following image tags have been deprecated and are no longer receiving updates:
+- adopt13
+- adopt14
+- adopt15
+- openj9-nightly
 
 ## Healthcheck
 
@@ -491,7 +515,7 @@ A [Catserver](http://catserver.moe/) type server can be used with
 
 ## Running a server with a Feed the Beast modpack
 
-> **NOTE** requires `itzg/minecraft-server:multiarch` image
+> **NOTE** requires one of the Debian based 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.
 
@@ -752,12 +776,18 @@ To whitelist players for your Minecraft server, pass the Minecraft usernames sep
 
 If the `WHITELIST` environment variable is not used, any user can join your Minecraft server if it's publicly accessible.
 
+> NOTE: When `WHITELIST` is used the server property `white-list` will automatically get set to `true`.
+
+> By default, the players in `WHITELIST` are **added** to the final `whitelist.json` file by the Minecraft server. If you set `OVERRIDE_WHITELIST` to "true" then the `whitelist.json` file will be recreated on each server startup.
+
 ### Op/Administrator Players
 
 To add more "op" (aka adminstrator) users to your Minecraft server, pass the Minecraft usernames separated by commas via the `OPS` environment variable, such as
 
     docker run -d -e OPS=user1,user2 ...
 
+> By default, the players in `OPS` are **added** to the final `ops.json` file by the Minecraft server. If you set `OVERRIDE_OPS` to "true" then the `ops.json` file will be recreated on each server startup.
+
 ### Server icon
 
 A server icon can be configured using the `ICON` variable. The image will be automatically
@@ -765,6 +795,10 @@ downloaded, scaled, and converted from any other image format:
 
     docker run -d -e ICON=http://..../some/image.png ...
 
+The server icon which has been set doesn't get overridden by default. It can be changed and overridden by setting `OVERRIDE_ICON` to `TRUE`.
+
+    docker run -d -e ICON=http://..../some/other/image.png -e OVERRIDE_ICON=TRUE...
+
 ### Rcon
 
 To use rcon use the `ENABLE_RCON` and `RCON_PASSORD` variables.
@@ -931,7 +965,7 @@ 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, such as
+be configured by setting `LEVEL_TYPE` to an expected type, for example
 
 - DEFAULT
 - FLAT
@@ -939,6 +973,8 @@ be configured by setting `LEVEL_TYPE` to an expected type, such as
 - AMPLIFIED
 - CUSTOMIZED
 - BUFFET
+- BIOMESOP (Biomes O' Plenty for 1.12 and older)
+- BIOMESOPLENTY (Biomes O' Plenty for 1.15 and above)
 
 Descriptions are available at the [gamepedia](http://minecraft.gamepedia.com/Server.properties).
 
@@ -1069,19 +1105,18 @@ is passed to `docker run`.
 
 ### Memory Limit
 
-By default, the image declares a Java initial and maximum memory limit of 1 GB. There are several
-ways to adjust the memory settings:
+By default, the image declares an initial and maximum Java memory-heap limit of 1 GB. There are several ways to adjust the memory settings:
 
-- `MEMORY`, "1G" by default, can be used to adjust both initial (`Xms`) and max (`Xmx`)
-  memory settings of the JVM
-- `INIT_MEMORY`, independently sets the initial heap size
-- `MAX_MEMORY`, independently sets the max heap size
+- `MEMORY`: "1G" by default, can be used to adjust both initial (`Xms`) and max (`Xmx`) memory heap settings of the JVM
+- `INIT_MEMORY`: independently sets the initial heap size
+- `MAX_MEMORY`: independently sets the max heap size
 
-The values of all three are passed directly to the JVM and support format/units as
-`<size>[g|G|m|M|k|K]`. For example:
+The values of all three are passed directly to the JVM and support format/units as `<size>[g|G|m|M|k|K]`. For example:
 
     -e MEMORY=2G
 
+> NOTE: the settings above only set the Java **heap** limits. Memory resource requests and limits on the overall container should also account for non-heap memory usage. An extra 25% is [a general best practice](https://dzone.com/articles/best-practices-java-memory-arguments-for-container).
+
 ### JVM Options
 
 General JVM options can be passed to the Minecraft Server invocation by passing a `JVM_OPTS`

docker-versions-create.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 #set -x
 # Use this variable to indicate a list of branches that docker hub is watching
-branches_list=('openj9' 'openj9-nightly' 'adopt11' 'adopt13' 'adopt14' 'adopt15' 'multiarch' 'multiarch-latest')
+branches_list=('java8' 'java8-multiarch' 'openj9' 'openj9-11' 'adopt11' 'java15' 'multiarch' 'multiarch-latest')
 
 function TrapExit {
   echo "Checking out back in master"

examples/docker-compose-simple.yml

@@ -0,0 +1,12 @@
+version: "3"
+
+services:
+  mc:
+    image: itzg/minecraft-server
+    ports:
+      - 25565:25565
+    environment:
+      EULA: "TRUE"
+    volumes:
+      # attach the relative directory 'data' to the container's /data path
+      ./data:/data

start-configuration

@@ -95,6 +95,10 @@ case "${TYPE^^}" in
   ;;
 
   FORGE)
+    log "**********************************************************************"
+    log "WARNING: The image tag itzg/minecraft-server:java8 is recommended"
+    log "         since some mods require Java 8"
+    log "**********************************************************************"
     exec ${SCRIPTS:-/}start-deployForge "$@"
   ;;
 

start-finalSetupModpack

@@ -81,16 +81,23 @@ if [[ "$MODS" ]]; then
   do
     if isURL $i; then
       log "Downloading mod/plugin $i ..."
-      effective_url=$(resolveEffectiveUrl "$i")
-      if isValidFileURL jar "${effective_url}"; then
-        out_file=$(getFilenameFromUrl "${effective_url}")
-        if ! curl -fsSL -o "${out_dir}/$out_file" "${effective_url}"; then
+      if isValidFileURL jar "$i"; then
+        if ! curl -fsSL -o "${out_dir}/$(getFilenameFromUrl "${i}")" "${i}"; then
           log "ERROR: failed to download from $i into $out_dir"
           exit 2
         fi
       else
-        log "ERROR: $effective_url resolved from $i is not a valid jar URL"
-        exit 2
+        effective_url=$(resolveEffectiveUrl "$i")
+        if isValidFileURL jar "${effective_url}"; then
+          out_file=$(getFilenameFromUrl "${effective_url}")
+          if ! curl -fsSL -o "${out_dir}/$out_file" "${effective_url}"; then
+            log "ERROR: failed to download from $i into $out_dir"
+            exit 2
+          fi
+        else
+          log "ERROR: $effective_url resolved from $i is not a valid jar URL"
+          exit 2
+        fi
       fi
     else
       log "ERROR Invalid URL given in MODS: $i"

start-minecraftFinalSetup

@@ -3,28 +3,40 @@
 . ${SCRIPTS:-/}start-utils
 
 if [ -n "$OPS" ]; then
-  log "Setting/adding ops"
-  rm -rf /data/ops.txt.converted
+  log "Updating ops"
+  rm -f /data/ops.txt.converted
   echo $OPS | awk -v RS=, '{print}' > /data/ops.txt
+
+  if isTrue "${OVERRIDE_OPS}"; then
+    log "Recreating ops.json file at server startup"
+    rm -f /data/ops.json
+  fi
 fi
 
 if [ -n "$WHITELIST" ]; then
-  log "Setting whitelist"
-  rm -rf /data/white-list.txt.converted
+  log "Updating whitelist"
+  rm -f /data/white-list.txt.converted
   echo $WHITELIST | awk -v RS=, '{print}' > /data/white-list.txt
+
+  if isTrue "${OVERRIDE_WHITELIST}"; then
+    log "Recreating whitelist.json file at server startup"
+    rm -f /data/whitelist.json
+  fi
 fi
 
-if [ -n "$ICON" -a ! -e server-icon.png ]; then
-  log "Using server icon from $ICON..."
-  # Not sure what it is yet...call it "img"
-  curl -sSL -o /tmp/icon.img $ICON
-  specs=$(identify /tmp/icon.img | awk '{print $2,$3}')
-  if [ "$specs" = "PNG 64x64" ]; then
-    mv /tmp/icon.img /data/server-icon.png
-  else
-    log "Converting image to 64x64 PNG..."
-    convert /tmp/icon.img -resize 64x64! /data/server-icon.png
-  fi
+if [ -n "$ICON" ]; then
+    if [ ! -e server-icon.png ] || [ "${OVERRIDE_ICON}" == "TRUE" ]; then
+      log "Using server icon from $ICON..."
+      # Not sure what it is yet...call it "img"
+      curl -sSL -o /tmp/icon.img $ICON
+      specs=$(identify /tmp/icon.img | awk '{print $2,$3}')
+      if [ "$specs" = "PNG 64x64" ]; then
+        mv /tmp/icon.img /data/server-icon.png
+      else
+        log "Converting image to 64x64 PNG..."
+        convert /tmp/icon.img -resize 64x64! /data/server-icon.png
+      fi
+    fi
 fi
 
 if ! isTrue ${SKIP_LOG4J_CONFIG}; then

start-utils

@@ -145,7 +145,8 @@ requireVar() {
 }
 
 function writeEula() {
-  if ! echo "# Generated via Docker on $(date)
+  if ! echo "# Generated via Docker
+# $(date)
 eula=${EULA,,}
 " >/data/eula.txt; then
     log "ERROR: unable to write eula to /data. Please make sure attached directory is writable by uid=${UID}"