Updated docs for finding FTB modpack ID (#1766)

Also
* Added github actions debug support
* added use of fileNotExists

.dockerignore

@@ -0,0 +1,6 @@
+data
+testdata
+examples
+k8s-examples
+.idea
+.git

.editorconfig

@@ -0,0 +1,4 @@
+[start-*]
+indent_size = 2
+indent_style = space
+end_of_line = lf

.gitattributes

@@ -1,17 +1,2 @@
-# Auto detect text files and perform LF normalization
-* text=auto
-
-# Custom for Visual Studio
-*.cs     diff=csharp
-
-# Standard to msysgit
-*.doc	 diff=astextplain
-*.DOC	 diff=astextplain
-*.docx diff=astextplain
-*.DOCX diff=astextplain
-*.dot  diff=astextplain
-*.DOT  diff=astextplain
-*.pdf  diff=astextplain
-*.PDF	 diff=astextplain
-*.rtf	 diff=astextplain
-*.RTF	 diff=astextplain
+# Auto detect text files and perform LF normalization
+* text=lf

.github/FUNDING.yml

@@ -0,0 +1,4 @@
+github: itzg
+custom:
+  - https://www.buymeacoffee.com/itzg
+  - https://paypal.me/itzg

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,40 @@
+name: Bug Report
+description: File a bug report
+labels:
+  - bug
+  - status/needs triage
+body:
+  - type: markdown
+    attributes:
+      value: |
+        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.
+  - type: textarea
+    id: problem
+    attributes:
+      label: Describe the problem
+    validations:
+      required: true
+  - type: textarea
+    id: container
+    attributes:
+      label: Container definition
+      description: Please provide the compose file or run command used to create the container
+      value: |
+        ```
+        Paste run command or compose file here
+        ```
+  - type: textarea
+    id: logs
+    attributes:
+      label: Container logs
+      description: |
+        Please provide container logs from the start of the container, which will be the ones prefixed with `[init]`. It is even better if you can set the variable `DEBUG` to "true" and provide those debug container logs.
+      value: |
+        ```
+        Paste logs here
+        ```

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,7 @@
+contact_links:
+  - name: Ask a question in discussions
+    url: https://github.com/itzg/docker-minecraft-server/discussions
+    about: Please ask questions here
+  - name: Ask a question on Discord
+    url: https://discord.gg/DXfKpjB
+    about: Please ask questions here

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -0,0 +1,29 @@
+name: Enhancement Request
+description: Request an enhancement
+labels:
+  - enhancement
+  - status/needs triage
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to request an enhancement.
+        
+        Even if you plan on submitting a pull request with a contributed enhancement it is best to describe the enhancement here first. Somebody might already be working on a similar thing and could use your help.
+  - type: dropdown
+    id: type
+    attributes:
+      label: Enhancement Type
+      options:
+        - Improve an existing feature
+        - A completely new feature
+        - New server type
+        - Not sure
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the enhancement
+    validations:
+      required: true

.github/dependabot.yml

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

.github/release.yml

@@ -0,0 +1,4 @@
+changelog:
+  exclude:
+    authors:
+      - dependabot

.github/workflows/build-multiarch.yml

@@ -0,0 +1,176 @@
+name: Test and Build multi-architecture
+on:
+  push:
+    branches:
+      - master
+      - test/**
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+    paths-ignore:
+      - "*.md"
+      - "docs/**"
+      - "examples/**"
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        variant:
+          - java17
+          - java17-graalvm-ce
+          - java17-jdk
+          - java17-openj9
+          - java17-alpine
+          - java8
+          - java8-graalvm-ce
+          - java8-multiarch
+          - java8-openj9
+          - java8-jdk
+          - java11
+          - java11-openj9
+          - java11-jdk
+        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
+            mcVersion: 1.18.2
+          - variant: java17-graalvm-ce
+            baseImage: ghcr.io/graalvm/graalvm-ce:ol8-java17
+            platforms: linux/amd64,linux/arm64
+            mcVersion: 1.18.2
+          - variant: java17-jdk
+            baseImage: eclipse-temurin:17-focal
+            platforms: linux/amd64,linux/arm/v7,linux/arm64
+            mcVersion: 1.18.2
+          - variant: java17-openj9
+            baseImage: ibm-semeru-runtimes:open-17-jre
+            platforms: linux/amd64,linux/arm64
+            mcVersion: 1.18.2
+          - variant: java17-alpine
+            baseImage: eclipse-temurin:17-jre-alpine
+            platforms: linux/amd64
+            mcVersion: 1.18.2
+        # JAVA 11:
+          - variant: java11
+            baseImage: adoptopenjdk:11-jre-hotspot
+            platforms: linux/amd64,linux/arm/v7,linux/arm64
+            mcVersion: 1.16.5
+          - variant: java11-jdk
+            baseImage: adoptopenjdk:11-jdk-hotspot
+            platforms: linux/amd64,linux/arm/v7,linux/arm64
+            mcVersion: 1.16.5
+          - variant: java11-openj9
+            baseImage: ibm-semeru-runtimes:open-11-jre
+            platforms: linux/amd64,linux/arm64
+            mcVersion: 1.16.5
+        # JAVA 8: NOTE: Unable to go past 8u312 because of Forge dependencies
+          - variant: java8
+            baseImage: openjdk:8-jre-alpine3.9
+            platforms: linux/amd64
+            mcVersion: 1.12.2
+          - variant: java8-graalvm-ce
+            baseImage: ghcr.io/graalvm/graalvm-ce:java8
+            platforms: linux/amd64
+            mcVersion: 1.12.2
+          - variant: java8-multiarch
+            baseImage: eclipse-temurin:8u312-b07-jre-focal
+            platforms: linux/amd64,linux/arm/v7,linux/arm64
+            mcVersion: 1.12.2
+          - variant: java8-jdk
+            baseImage: eclipse-temurin:8u312-b07-jdk-focal
+            platforms: linux/amd64,linux/arm64
+            mcVersion: 1.12.2
+          - variant: java8-openj9
+            baseImage: ibm-semeru-runtimes:open-8u312-b07-jre
+            platforms: linux/amd64,linux/arm64
+            mcVersion: 1.12.2
+    env:
+      IMAGE_TO_TEST: ${{ github.repository_owner }}/minecraft-server:test-${{ matrix.variant }}-${{ github.run_id }}
+      HAS_IMAGE_REPO_ACCESS: ${{ secrets.DOCKER_USER != '' && secrets.DOCKER_PASSWORD != '' }}
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          # for build-files step
+          fetch-depth: 0
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v4
+        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.
+          images: |
+            ${{ github.repository_owner }}/minecraft-server
+          tags: |
+            type=ref,event=tag,enable=${{ matrix.variant == 'java17' }}
+            type=ref,event=tag,suffix=-${{ matrix.variant }}
+            type=raw,value=${{ matrix.variant }}
+          flavor: |
+            latest=${{ matrix.variant == 'java17' }}
+          labels: |
+            org.opencontainers.image.authors=Geoff Bourne <itzgeoff@gmail.com>
+
+      - name: Setup Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2.0.0
+
+      - name: Build for test
+        uses: docker/build-push-action@v3.1.1
+        with:
+          platforms: linux/amd64
+          tags: ${{ env.IMAGE_TO_TEST }}
+          # ensure latest base image is used
+          pull: true
+          # load into daemon for test usage in next step
+          load: true
+          push: false
+          build-args: |
+            BASE_IMAGE=${{ matrix.baseImage }}
+          cache-from: type=gha,scope=${{ matrix.variant }}
+          # no cache-to to avoid cross-cache update from next build step
+
+      - name: Run tests
+        env:
+          MINECRAFT_VERSION: ${{ matrix.mcVersion }}
+          VARIANT: ${{ matrix.variant }}
+          MODS_FORGEAPI_KEY: ${{ secrets.MODS_FORGEAPI_KEY }}
+        run: |
+          tests/test.sh
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v2
+        if: env.HAS_IMAGE_REPO_ACCESS
+        with:
+          username: ${{ secrets.DOCKER_USER }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v3.1.1
+        if: github.actor == github.repository_owner
+        with:
+          platforms: ${{ matrix.platforms }}
+          push: >
+            ${{ 
+            github.ref_type == 'tag' 
+            || github.ref_name == 'master' 
+            || ( github.event_name == 'pull_request' 
+                 && env.HAS_IMAGE_REPO_ACCESS 
+                 && contains(github.event.pull_request.labels.*.name, 'ci/push-image') 
+               )
+            }}
+          tags: ${{ steps.meta.outputs.tags }}
+          # ensure latest base image is used
+          pull: true
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            BASE_IMAGE=${{ matrix.baseImage }}
+            BUILD_FILES_REV=${{ steps.build-files-rev.outputs.REV }}
+          cache-from: type=gha,scope=${{ matrix.variant }}
+          cache-to: type=gha,mode=max,scope=${{ matrix.variant }}

.github/workflows/discord.yml

@@ -0,0 +1,26 @@
+name: Discord notifications
+
+on:
+  workflow_run:
+    workflows: ["ContinuousIntegration", "Build and Publish", "Build and publish multiarch" ]
+    types:
+      - completed
+
+env:
+  DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
+
+jobs:
+  discord:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: on-success
+        if: ${{ github.event.workflow_run.conclusion == 'success' }}
+        uses: Ilshidur/action-discord@master
+        with:
+          args: "Github repo: ${{ github.repository }}\n- Branch: ${{ github.event.workflow_run.head_branch }}\n- [Link: to Actions](<${{ github.event.workflow_run.html_url }}>)\n- Status: 🎉  ${{ github.event.workflow_run.conclusion }}  🍏"
+      - name: on-failure
+        if: ${{ github.event.workflow_run.conclusion == 'failure' }}
+        uses: Ilshidur/action-discord@master
+        with:
+          args: "Github repo: ${{ github.repository }}\n- Branch: ${{ github.event.workflow_run.head_branch }}\n- [Link: to Actions](<${{ github.event.workflow_run.html_url }}>)\n- Status: 🤔  ${{ github.event.workflow_run.conclusion }}  💣💥"

.github/workflows/issue-label.yml

@@ -0,0 +1,33 @@
+name: Issue labels
+
+on:
+  issues:
+    types: [labeled, reopened, closed, deleted]
+
+env:
+  DISCORD_WEBHOOK: ${{ secrets.DISCORD_ISSUES_WEBHOOK }}
+
+jobs:
+  labelNotify:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: notify on label
+        if: > 
+          github.event.label.name == 'enhancement' 
+          || github.event.label.name == 'bug' 
+          || github.event.label.name == 'help wanted'
+          || github.event.label.name == 'priority/high'
+          || github.event.label.name == 'question'
+          || github.event.label.name == 'status/waiting on upstream'
+        uses: Ilshidur/action-discord@master
+        with:
+          args: "[${{ github.event.issue.title }} (#${{ github.event.issue.number }})](<${{ github.event.issue.html_url }}>) added `${{ github.event.label.name }}` label"
+      - name: notify on action change
+        if: > 
+          github.event.action == 'closed'
+          || github.event.action == 'reopened'
+          || github.event.action == 'deleted'
+        uses: Ilshidur/action-discord@master
+        with:
+          args: "[${{ github.event.issue.title }} (#${{ github.event.issue.number }})](<${{ github.event.issue.html_url }}>) has been `${{ github.event.action }}` by `${{ github.event.sender.login }}`"

.github/workflows/stale-check.yml

@@ -0,0 +1,25 @@
+name: Stale Check
+
+on:
+  schedule:
+    - cron: 0 2 * * *
+
+jobs:
+  check:
+    runs-on: ubuntu-20.04
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - name: Process Stale Issues
+        uses: actions/stale@v6
+        with:
+          stale-issue-label: status/stale
+          stale-pr-label: status/stale
+          stale-issue-message: >
+            This issue is stale because it has been open 30 days with no activity. 
+            Please add a comment describing the reason to keep this issue open.
+          days-before-stale: 30
+          days-before-close: 5
+          exempt-issue-labels: 'enhancement,keep,status/needs triage,priority/high'
+

.github/workflows/verify-pr.yml

@@ -0,0 +1,69 @@
+name: Verify PR
+on:
+  pull_request:
+    branches: [ master ]
+    types: [assigned, opened, synchronize, labeled]
+    paths-ignore:
+      - "*.md"
+      - "docs/**"
+      - "examples/**"
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        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
+            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
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          # for build-files step
+          fetch-depth: 0
+
+      - name: Setup Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Build for test
+        uses: docker/build-push-action@v3.1.1
+        with:
+          platforms: linux/amd64
+          tags: ${{ env.IMAGE_TO_TEST }}
+          # ensure latest base image is used
+          pull: true
+          # load into daemon for test usage in next step
+          load: true
+          push: false
+          build-args: |
+            BASE_IMAGE=${{ matrix.baseImage }}
+          cache-from: type=gha,scope=${{ matrix.variant }}
+
+      - name: Run tests
+        env:
+          MINECRAFT_VERSION: ${{ matrix.mcVersion }}
+          VARIANT: ${{ matrix.variant }}
+          MODS_FORGEAPI_KEY: ${{ secrets.MODS_FORGEAPI_KEY }}
+          DEBUG: ${{ runner.debug }}
+        run: |
+          tests/test.sh

.gitignore

@@ -1,2 +1,6 @@
+.vscode
+/data/
+/.idea/
 *.iml
-.idea
+/gh-md-toc
+personal-build-and-develop.*

BUILDING.md

@@ -0,0 +1,11 @@
+Ensure buildx/BuildKit support is enabled and run:
+
+```shell script
+docker buildx build --platform=linux/arm64 --platform=linux/arm/v7 --platform=linux/amd64 --tag itzg/minecraft-server:multiarch --push .
+```
+
+To build for local testing, use:
+
+```shell script
+docker buildx build --platform=linux/amd64 --tag mc-multiarch --load .
+```

DEVELOPMENT.md

@@ -0,0 +1,99 @@
+## Adding a server type
+
+Adding a new server `TYPE` can vary due to the complexity of obtaining and configuring each type; however, the addition of any server type includes at least the following steps:
+
+1. Copy an existing "start-deploy*" script, such as [start-deployMohist](scripts/start-deployMohist) and rename it accordingly making sure to retain the "start-deploy" prefix
+2. Modify the type-specific behavior between the "start-utils" preamble and the hand-off to `start-setupWorld` at the end of the script 
+3. Develop and test the changes using the [iterative process described below](#iterative-script-development)
+4. Add a case-entry to the `case "${TYPE^^}"` in [start-configuration](scripts/start-configuration)
+5. Add a section to the [README](README.md). It is recommended to copy-modify an existing section to retain a similar wording and level of detail
+6. [Submit a pull request](https://github.com/itzg/docker-minecraft-server/pulls)
+
+## Iterative script development
+
+Individual scripts can be iteratively developed, debugged, and tested using the following procedure.
+
+First, build a baseline of the image to include the packages needed by existing or new scripts:
+
+PowerShell: (Example of building and testing ForgeAPI)
+```powershell
+$env:MODS_FORGEAPI_KEY='$2a$...'
+$env:FOLDER_TO_TEST="forgeapimods_projectids"
+$env:IMAGE_TO_TEST="mc-dev"
+docker build -t $env:IMAGE_TO_TEST .
+pushd "tests/setuponlytests/$env:FOLDER_TO_TEST/"
+docker-compose run mc
+docker-compose down -v --remove-orphans
+popd
+```
+
+PowerShell: Building different images of Java for testing
+```powershell
+$env:BASE_IMAGE='eclipse-temurin:8u312-b07-jre'
+$env:IMAGE_TO_TEST="mc-dev"
+docker build --build-arg BASE_IMAGE=$env:BASE_IMAGE -t $env:IMAGE_TO_TEST .
+```
+
+Bash: (Example of building and testing ForgeAPI)
+```bash
+export MODS_FORGEAPI_KEY='$2a$...'
+export FOLDER_TO_TEST="forgeapimods_file"
+export IMAGE_TO_TEST="mc-dev"
+docker build -t $IMAGE_TO_TEST .
+pushd tests/setuponlytests/$FOLDER_TO_TEST/
+docker-compose run mc
+docker-compose down -v --remove-orphans
+popd
+```
+
+Using the baseline image, an interactive container can be started to iteratively run the scripts to be developed. By attaching the current workspace directory, you can use the local editor of your choice to iteratively modify scripts while using the container to run them.
+
+```shell script
+docker run -it --rm -v ${PWD}:/scripts -e SCRIPTS=/scripts/ --entrypoint bash mc-dev
+```
+
+From within the container you can run individual scripts via the attached `/scripts/` path; however, be sure to set any environment variables expected by the scripts by either `export`ing them manually:
+
+```shell script
+export VANILLA_VERSION=1.12.2
+/scripts/start-magma
+```
+
+...or pre-pending script execution:
+
+```shell script
+VANILLA_VERSION=1.12.2 /scripts/start-magma
+```
+
+> NOTE: You may want to temporarily add an `exit` statement near the end of your script to isolate execution to just the script you're developing.
+
+## Using development copy of mc-image-helper
+
+In the cloned copy of [`mc-image-helper`](https://github.com/itzg/mc-image-helper), create an up-to-date snapshot build of the tgz distribution using:
+
+```shell
+./gradlew distTar
+```
+
+Assuming [http-server](https://www.npmjs.com/package/http-server) is installed globally, start a static web server using:
+
+```shell
+http-server ./build/distributions -p 8080
+```
+
+Note the port that was selected by http-server and pass the build arguments, such as:
+
+```shell
+--build-arg MC_HELPER_VERSION=1.8.1-SNAPSHOT \
+--build-arg MC_HELPER_BASE_URL=http://host.docker.internal:8080
+```
+
+Now the image can be built like normal, and it will install mc-image-helper from the locally built copy.
+
+## Generating release notes
+
+The following git command can be used to provide the bulk of release notes content:
+
+```shell script
+git log --invert-grep --grep "^ci:" --grep "^misc:" --grep "^docs:" --pretty="* %s" 1.1.0..1.2.0
+```

Dockerfile

@@ -0,0 +1,73 @@
+# syntax = docker/dockerfile:1.3
+
+ARG BASE_IMAGE=eclipse-temurin:17-jre-focal
+FROM ${BASE_IMAGE}
+
+# CI system should set this to a hash or git revision of the build directory and it's contents to
+# ensure consistent cache updates.
+ARG BUILD_FILES_REV=1
+RUN --mount=target=/build,source=build \
+    REV=${BUILD_FILES_REV} /build/run.sh install-packages
+
+RUN --mount=target=/build,source=build \
+    REV=${BUILD_FILES_REV} /build/run.sh setup-user
+
+COPY --chmod=644 files/sudoers* /etc/sudoers.d
+
+EXPOSE 25565 25575
+
+# hook into docker BuildKit --platform support
+# see https://docs.docker.com/engine/reference/builder/#automatic-platform-args-in-the-global-scope
+ARG TARGETOS
+ARG TARGETARCH
+ARG TARGETVARIANT
+
+ARG EASY_ADD_VER=0.7.1
+ADD https://github.com/itzg/easy-add/releases/download/${EASY_ADD_VER}/easy-add_${TARGETOS}_${TARGETARCH}${TARGETVARIANT} /usr/bin/easy-add
+RUN chmod +x /usr/bin/easy-add
+
+RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
+  --var version=1.2.0 --var app=restify --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.6.0 --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.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}} \
+  --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.22.7
+ARG MC_HELPER_RELEASE=v${MC_HELPER_VERSION}
+ARG MC_HELPER_BASE_URL=https://github.com/itzg/mc-image-helper/releases/download/${MC_HELPER_RELEASE}
+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
+
+VOLUME ["/data"]
+WORKDIR /data
+
+STOPSIGNAL SIGTERM
+
+# End user MUST set EULA and change RCON_PASSWORD
+ENV TYPE=VANILLA VERSION=LATEST EULA="" UID=1000 GID=1000 RCON_PASSWORD=minecraft
+
+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
+COPY --chmod=755 files/auto /auto
+
+RUN dos2unix /start* /auto/*
+
+ENTRYPOINT [ "/start" ]
+HEALTHCHECK --start-period=1m --interval=5s --retries=24 CMD mc-health

bin/mc-health

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+# shellcheck source=../scripts/start-utils
+. "${SCRIPTS:-/}start-utils"
+if [ -f /data/.mc-health.env ]; then
+  . /data/.mc-health.env
+fi
+
+if isTrue "${DISABLE_HEALTHCHECK}"; then
+  echo "Healthcheck disabled"
+  exit 0
+elif isTrue "${ENABLE_AUTOPAUSE}" && [[ "$( ps -ax -o stat,comm | grep 'java' | awk '{ print $1 }')" =~ ^T.*$ ]]; then
+  echo "Java process suspended by Autopause function"
+  exit 0
+else
+  mc-monitor status "${MC_HEALTH_EXTRA_ARGS[@]}" --host localhost --port "${SERVER_PORT:-25565}"
+  exit $?
+fi

bin/mc-send-to-console

@@ -0,0 +1,23 @@
+#!/bin/bash
+. "/start-utils"
+: "${CONSOLE_IN_NAMED_PIPE:=/tmp/minecraft-console-in}"
+
+if [ $# = 0 ]; then
+  echo "ERROR: pass console commands as arguments"
+  exit 1
+fi
+
+if [ ! -p "${CONSOLE_IN_NAMED_PIPE}" ]; then
+  echo "ERROR: named pipe ${CONSOLE_IN_NAMED_PIPE} is missing"
+  exit 1
+fi
+
+if [ "$(id -u)" = 0 ]; then
+  if [[ $(getDistro) == alpine ]]; then
+    exec su-exec minecraft bash -c "echo $* > '${CONSOLE_IN_NAMED_PIPE:-/tmp/minecraft-console-in}'"
+  else
+    exec gosu minecraft bash -c "echo $* > '${CONSOLE_IN_NAMED_PIPE:-/tmp/minecraft-console-in}'"
+  fi
+else
+  echo "$@" >"${CONSOLE_IN_NAMED_PIPE:-/tmp/minecraft-console-in}"
+fi

bin/mcstatus

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+echo "WARNING: mcstatus is deprecated; calling mc-monitor instead"
+
+##### mcstatus shim for mc-monitor
+# handles translating calls to
+#   mcstatus (host:port) (command)
+# where the actual command is ignore, but is typically ping or status
+
+addr="$1"
+
+IFS=':'
+read -a parts <<< "${addr}"
+if [[ ${#parts[*]} -gt 1 ]]; then
+  exec mc-monitor status --host ${parts[0]} --port ${parts[1]}
+else
+  exec mc-monitor status --host ${parts[0]}
+fi

bin/rcon-cmds-daemon.sh

@@ -0,0 +1,101 @@
+#!/bin/bash
+
+: "${RCON_CMDS_STARTUP:=}"
+: "${RCON_CMDS_ON_CONNECT:=}"
+: "${RCON_CMDS_ON_DISCONNECT:=}"
+: "${RCON_CMDS_FIRST_CONNECT:=}"
+: "${RCON_CMDS_LAST_DISCONNECT:=}"
+: "${RCON_CMDS_PERIOD:=10}"
+
+# needed for the clients connected function residing in autopause
+# shellcheck source=../auto/autopause-fcns.sh
+. /auto/autopause-fcns.sh
+
+# shellcheck source=start-utils
+. ${SCRIPTS:-/}start-utils
+
+run_command(){
+  rcon_cmd="$1"
+  logRcon "running - $rcon_cmd"
+  output=$(rcon-cli "$rcon_cmd")
+  logRcon "$output"
+}
+
+
+# wait for java process to be started
+while :
+do
+  if java_process_exists ; then
+    break
+  fi
+  sleep 0.1
+done
+
+CLIENTCONNECTIONS=0
+STATE=INIT
+
+while :
+do
+  case X$STATE in
+  XINIT)
+    # Server startup
+    if mc_server_listening ; then
+      logRcon "MCServer is listening, running startup"
+      if [[ "$RCON_CMDS_STARTUP" ]]; then
+        while read -r cmd; do
+          run_command "$cmd"
+        done <<< "$RCON_CMDS_STARTUP"
+      fi
+      if 
+        [[ -z "$RCON_CMDS_ON_CONNECT" ]] && 
+        [[ -z "$RCON_CMDS_ON_DISCONNECT" ]] && 
+        [[ -z "$RCON_CMDS_FIRST_CONNECT" ]] && 
+        [[ -z "$RCON_CMDS_LAST_DISCONNECT" ]]
+      then
+        logRcon "No addition rcon commands are given, stopping rcon cmd service"
+        exit 0
+      fi
+      STATE=II
+    fi
+    ;;
+  XII)
+    CURR_CLIENTCONNECTIONS=$(java_clients_connections)
+    # First client connection
+    # Setting priority run order: on first client connection is usually to STOP maintence, aka DO THIS FIRST
+    if (( CURR_CLIENTCONNECTIONS > 0 )) && (( CLIENTCONNECTIONS == 0 )) && [[ "$RCON_CMDS_FIRST_CONNECT" ]]; then
+        logRcon "First Clients has Connected, running first connect cmds"
+        while read -r cmd; do
+          run_command "$cmd"
+        done <<< "$RCON_CMDS_FIRST_CONNECT"
+    fi
+
+    # When a client joins
+    if (( CURR_CLIENTCONNECTIONS > CLIENTCONNECTIONS )) && [[ "$RCON_CMDS_ON_CONNECT" ]]; then
+        logRcon "Clients have Connected, running connect cmds"
+        while read -r cmd; do
+          run_command "$cmd"
+        done <<< "$RCON_CMDS_ON_CONNECT"
+    # When a client leaves
+    elif (( CURR_CLIENTCONNECTIONS < CLIENTCONNECTIONS )) && [[ "$RCON_CMDS_ON_DISCONNECT" ]]; then
+        logRcon "Clients have Disconnected, running disconnect cmds"
+        while read -r cmd; do
+          run_command "$cmd"
+        done <<< "$RCON_CMDS_ON_DISCONNECT"
+    fi
+
+    # Last client connection
+    # Setting priority run order: on last client connection is usually to START maintence, aka DO THIS LAST
+    if (( CURR_CLIENTCONNECTIONS == 0 )) && (( CLIENTCONNECTIONS > 0 )) && [[ "$RCON_CMDS_LAST_DISCONNECT" ]]; then
+        logRcon "ALL Clients have Disconnected, running last disconnect cmds"
+        while read -r cmd; do
+          run_command "$cmd"
+        done <<< "$RCON_CMDS_LAST_DISCONNECT"
+    fi
+    CLIENTCONNECTIONS=$CURR_CLIENTCONNECTIONS
+    ;;
+  *)
+    logRcon "Error: invalid state: $STATE"
+    ;;
+  esac
+  sleep "$RCON_CMDS_PERIOD"
+done

build

@@ -1,14 +0,0 @@
-#!/bin/bash
-
-pkgs=ubuntu-openjdk-7
-pkgs="$pkgs minecraft-server"
-pkgs="$pkgs elasticsearch"
-pkgs="$pkgs kibana"
-pkgs="$pkgs titan-gremlin"
-pkgs="$pkgs cassandra"
-
-for p in $pkgs
-do
-  docker build -t itzg/$p $p
-done
-

build/alpine/install-packages.sh

@@ -0,0 +1,26 @@
+#!/bin/sh
+
+set -e
+
+apk add --no-cache -U \
+    openssl \
+    imagemagick \
+    file \
+    lsof \
+    su-exec \
+    coreutils \
+    findutils \
+    procps \
+    shadow \
+    bash \
+    curl iputils \
+    git \
+    jq \
+    mysql-client \
+    tzdata \
+    rsync \
+    nano \
+    sudo \
+    knock \
+    tar \
+    zstd

build/alpine/setup-user.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+set -e
+
+addgroup -g 1000 minecraft
+adduser -Ss /bin/false -u 1000 -G minecraft -h /home/minecraft minecraft

build/ol/install-gosu.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+if [[ $(uname -m) == "aarch64" ]]; then 
+    curl -sL -o /bin/gosu https://github.com/tianon/gosu/releases/download/1.14/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
+    chmod +x /bin/gosu
+else
+    echo "Not supported!"
+    exit 1
+fi  

build/ol/install-packages.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+
+set -e
+
+microdnf install dnf -y
+
+dnf install 'dnf-command(config-manager)' -y
+dnf config-manager --set-enabled ol8_codeready_builder
+tee /etc/yum.repos.d/ol8-epel.repo<<EOF
+[ol8_developer_EPEL]
+name= Oracle Linux \$releasever EPEL (\$basearch)
+baseurl=https://yum.oracle.com/repo/OracleLinux/OL8/developer/EPEL/\$basearch/
+gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-oracle
+gpgcheck=1
+enabled=1
+EOF
+dnf update -y
+
+dnf install -y ImageMagick \
+  file \
+  sudo \
+  net-tools \
+  iputils \
+  curl \
+  git \
+  jq \
+  dos2unix \
+  mysql \
+  procps-ng \
+  tzdata \
+  rsync \
+  nano \
+  unzip \
+  zstd \
+  lbzip2 \
+  knock
+
+bash /build/ol/install-gosu.sh

build/ol/setup-user.sh

@@ -0,0 +1,2 @@
+groupadd --gid 1000 minecraft
+useradd --system --shell /bin/false --uid 1000 -g minecraft --home /data minecraft

build/run.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+set -e
+
+distro=$(cat /etc/os-release | grep -E "^ID=" | cut -d= -f2 | sed -e 's/"//g')
+
+"$(dirname "$0")/${distro}/$1".sh

build/ubuntu/install-packages.sh

@@ -0,0 +1,28 @@
+#!/bin/sh
+
+set -e
+
+apt-get update
+
+DEBIAN_FRONTEND=noninteractive \
+apt-get install -y \
+  imagemagick \
+  file \
+  gosu \
+  sudo \
+  net-tools \
+  iputils-ping \
+  curl \
+  git \
+  jq \
+  dos2unix \
+  mysql-client \
+  tzdata \
+  rsync \
+  nano \
+  unzip \
+  zstd \
+  lbzip2 \
+  knockd
+
+apt-get clean

build/ubuntu/setup-user.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+set -e
+
+addgroup --gid 1000 minecraft
+adduser --system --shell /bin/false --uid 1000 --ingroup minecraft --home /data minecraft

cassandra/Dockerfile

@@ -1,26 +0,0 @@
-FROM java:openjdk-8u72-jdk
-
-MAINTAINER itzg
-
-ENV CASSANDRA_VERSION 2.2.8
-
-ADD http://mirrors.ibiblio.org/apache/cassandra/$CASSANDRA_VERSION/apache-cassandra-$CASSANDRA_VERSION-bin.tar.gz /tmp/apache-cassandra.tgz
-RUN tar -C /opt -zxf /tmp/apache-cassandra.tgz && \
-  rm /tmp/apache-cassandra.tgz
-
-
-RUN mv /opt/apache-cassandra-$CASSANDRA_VERSION /opt/cassandra
-ENV CASSANDRA_HOME /opt/cassandra
-ENV CASSANDRA_CONF /conf
-ENV CASSANDRA_DATA /data
-WORKDIR $CASSANDRA_HOME
-
-RUN ln -s $CASSANDRA_HOME/bin/* /usr/local/bin
-VOLUME ["/data","/conf"]
-
-EXPOSE 9042 9160 7000 7001
-
-ADD cassandra.in.sh $CASSANDRA_HOME/cassandra.in.sh
-RUN mv $CASSANDRA_HOME/bin/cassandra.in.sh $CASSANDRA_HOME/bin/orig.cassandra.in.sh
-
-CMD ["/opt/cassandra/bin/cassandra", "-f"]

cassandra/README.md

@@ -1,9 +0,0 @@
-Yet another Cassandra image, but this one got container and non-container access right.
-
-# Basic Usage
-
-To support access from both Docker containers and external, non-Docker clients:
-
-    docker run -d --name cassandra -e PUBLISH_AS=192.168.59.103 -p 9160:9160 itzg/cassandra
-
-replacing `192.168.59.103` with your Docker host's LAN IP address.

cassandra/cassandra.in.sh

@@ -1,24 +0,0 @@
-#!/bin/bash
-
-cassYml=$CASSANDRA_HOME/conf/cassandra.yaml
-
-privateAddr=$(hostname -i)
-
-seeds=${SEEDS:-${PUBLISH_AS:-$privateAddr}}
-
-sed -i -e "s/- seeds:.*/- seeds: \"$seeds\"/" \
-  -e "s/listen_address:.*/listen_address: $privateAddr/" \
-  -e "s/rpc_address:.*/rpc_address: $privateAddr/" \
-  -e "s/start_rpc:.*/start_rpc: true/" \
-  -e "s#- /var/lib/cassandra/data#- $CASSANDRA_DATA#" \
-  $cassYml
-
-if [ -n "$PUBLISH_AS" ]; then
-  sed -i -e "s/\(\s*#\)\?\s*broadcast_address:.*/broadcast_address: $PUBLISH_AS/" $cassYml
-fi
-
-# Copy over our tweaked files, but non-clobbering to let user have ultimate control
-cp -rn $CASSANDRA_HOME/conf/* $CASSANDRA_CONF
-
-# source the original
-. $CASSANDRA_HOME/bin/orig.cassandra.in.sh

circle.yml

@@ -1,11 +0,0 @@
-machine:
-  services:
-    - docker
-    
-test:
-  override:
-    - ./build
-    
-notify:
-  webhooks:
-    - url: https://webhooks.gitter.im/e/4726bb683d8aed018486

devbox/Dockerfile

@@ -1,30 +0,0 @@
-FROM itzg/ubuntu-openjdk-7
-
-RUN apt-get update
-RUN DEBIAN_FRONTEND=noninteractive \
-  apt-get install -yq git curl wget unzip openjdk-7-jdk && \
-  apt-get clean
-
-ENV MAVEN_VER 3.3.3
-ENV NODEJS_VER 0.12.7
-
-RUN wget -O /tmp/maven.tgz http://apache.mirrors.pair.com/maven/maven-3/$MAVEN_VER/binaries/apache-maven-$MAVEN_VER-bin.tar.gz
-RUN tar xvf /tmp/maven.tgz && rm /tmp/maven.tgz
-ENV M2_HOME /opt/apache-maven-$MAVEN_VER
-ENV PATH $PATH:$M2_HOME/bin
-
-RUN curl -s https://raw.githubusercontent.com/isaacs/nave/master/nave.sh > /usr/local/bin/nave
-RUN chmod +x /usr/local/bin/nave
-RUN nave usemain latest
-
-RUN apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
-
-VOLUME ["/shared"]
-
-RUN useradd -m -d /home/developer developer
-
-USER developer
-RUN curl -s get.gvmtool.net | bash
-
-WORKDIR /home/developer
-CMD bash

devbox/README.md

@@ -1,25 +0,0 @@
-Provides a development/build environment for Java, Groovy, and NodeJS.
-
-* Provides 'gvm' for Groovy (and more) installation management
-* Provides 'nave' for NodeJS installation management
-* Pre-installs the latest NodeJS via nave
-
-## Using the persistent/shared workarea
-
-Since devbox containers are intended to be disposable, the image is configured 
-with a "volume" at `/shared`. 
-
-There are a couple of ways you can leverage that volume. Either attach it to
-a host-local directory:
-
-    docker run -it -v $(pwd)/workarea:/shared --rm itzg/devbox
-
-or run a "base" container and mounts the `/shared` from that onto any
-subsequent containers:
-
-    docker run --name devbox-base itzg/devbox touch /shared/READY
-    ...later...
-    docker run -it --volumes-from devbox-base --rm itzg/devbox
-
-**NOTE** I am using the `--rm` option so the devbox containers will be truly
-"burn after use".

docker-compose.yml

@@ -0,0 +1,16 @@
+version: "3.8"
+
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: "true"
+    ports:
+      - "25565:25565"
+    volumes:
+      - data:/data
+    stdin_open: true
+    tty: true
+    restart: unless-stopped
+volumes:
+  data: {}

docs/Minecraft server containment.xml

@@ -0,0 +1 @@
+<mxfile userAgent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/57.0.2987.110 Safari/537.36" version="6.4.4" editor="www.draw.io" type="github"><diagram name="Page-1">1VVNc5swEP01HDMDUiDOMbGd5pK2Ux96VkGAxgJRIRvcX9+VWD40ODOZ1j0Uz9jS2w+t3ts1Ad1W/SfNmvJNZVwGJMz6gO4CQjZRCN8WuAxA8vgwAIUW2QBFM3AQvziCGFecRMZbz9EoJY1ofDBVdc1T42FMa9X5brmS/qkNK/gKOKRMrtHvIjMlolEYzoZXLooSj97EaPjB0mOh1anG8wJCc/cM5oqNudC/LVmmugVE9wHdaqXMsKr6LZeW2pG2Ie7lHetUt+a1+UgAGQLOTJ74WHEiIfQ5E2dbn7kgJ8nPky3q2fDe3DEpijqgT+AheW5mK6wK/HVZ2obVI7ZT6ZFrCHlVrRkdoLSlzwJ2BYwo8WohXSkMPzQstfsOWhCcSlNJ2EX21JFVu8mFlFsllXahdJ/YD+Bnro0AyZ+Gu+yMslnwZjt3LVd/KurCpgptLlWbA5aBXNs0vH+X/mgSFWaFq4obfQEXDKDYBhd/2809RzeIlYt2mxwZ9nkxZZ61hgXKfV16upK+EjBMmuXmruX67KSCATMMYL2SwDU5z5DkvxAE52NNvdHqyBeOoXs8UWIbplP8A3ES3UCVja/K41oVEl5RJYpuoMr9SpU34B+Qr0rD0ITD0JE4TuI/nopwLcKLexYi6OFet6CT3Pt8TjwtCI3IFUJv0eXxis9v2y+fr/D58P/yGf87PmE7v4ycbfHCp/vf</diagram></mxfile>

elasticsearch-marvel/README.md

@@ -1,5 +0,0 @@
-**This image is now deprecated. **
-
-Please use [itzg/elasticsearch](https://registry.hub.docker.com/u/itzg/elasticsearch/)
-instead. See the plugins configuration section for that image to see how
-to install Marvel.

elasticsearch/Dockerfile

@@ -1,31 +0,0 @@
-FROM java:8u92-jre-alpine
-
-MAINTAINER itzg
-
-RUN apk -U add bash
-
-ENV ES_VERSION=5.0.2
-
-ADD https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-$ES_VERSION.tar.gz /tmp/es.tgz
-RUN cd /usr/share && \
-  tar xf /tmp/es.tgz && \
-  rm /tmp/es.tgz
-
-EXPOSE 9200 9300
-
-ENV ES_HOME=/usr/share/elasticsearch-$ES_VERSION \
-    DEFAULT_ES_USER=elasticsearch \
-    DISCOVER_TRANSPORT_IP=eth0 \
-    DISCOVER_HTTP_IP=eth0 \
-    ES_JAVA_OPTS="-Xms1g -Xmx1g"
-
-RUN adduser -S -s /bin/sh $DEFAULT_ES_USER
-
-VOLUME ["/data","/conf"]
-
-WORKDIR $ES_HOME
-
-COPY start /start
-COPY log4j2.properties $ES_HOME/config/
-
-CMD ["/start"]

elasticsearch/README.md

@@ -1,213 +0,0 @@
-This Docker image provides an easily configurable Elasticsearch node. Via port mappings, it is easy to create an arbitrarily sized cluster of nodes. As long as the versions match, you can mix-and-match "real" Elasticsearch nodes with container-ized ones.
-
-# Basic Usage
-
-To start an Elasticsearch data node that listens on the standard ports on your host's network interface:
-
-    docker run -d -p 9200:9200 -p 9300:9300 itzg/elasticsearch
-
-You'll then be able to connect to the Elasticsearch HTTP interface to confirm it's alive:
-
-http://DOCKERHOST:9200/
-
-    {
-      "status" : 200,
-      "name" : "Charon",
-      "version" : {
-        "number" : "1.3.5",
-        "build_hash" : "4a50e7df768fddd572f48830ae9c35e4ded86ac1",
-        "build_timestamp" : "2014-11-05T15:21:28Z",
-        "build_snapshot" : false,
-        "lucene_version" : "4.9"
-      },
-      "tagline" : "You Know, for Search"
-    }
-
-Where `DOCKERHOST` would be the actual hostname of your host running Docker.
-
-# Simple, multi-node cluster
-
-To run a multi-node cluster (3-node in this example) on a single Docker machine use:
-
-    docker run -d --name es0 -p 9200:9200                    itzg/elasticsearch
-    docker run -d --name es1 --link es0 -e UNICAST_HOSTS=es0 itzg/elasticsearch
-    docker run -d --name es2 --link es0 -e UNICAST_HOSTS=es0 itzg/elasticsearch
-
-
-and then check the cluster health, such as http://192.168.99.100:9200/_cluster/health?pretty
-
-    {
-      "cluster_name" : "elasticsearch",
-      "status" : "green",
-      "timed_out" : false,
-      "number_of_nodes" : 3,
-      "number_of_data_nodes" : 3,
-      "active_primary_shards" : 0,
-      "active_shards" : 0,
-      "relocating_shards" : 0,
-      "initializing_shards" : 0,
-      "unassigned_shards" : 0
-    }
-
-# Configuration Summary
-
-## Ports
-
-* `9200` - HTTP REST
-* `9300` - Native transport
-
-## Volumes
-
-* `/data` - location of `path.data`
-* `/conf` - location of `path.conf`
-
-# Configuration Details
-
-The following configuration options are specified using `docker run` environment variables (`-e`) like
-
-    docker run ... -e NAME=VALUE ... itzg/elasticsearch
-
-Since Docker's `-e` settings are baked into the container definition, this image provides an extra feature to change any of the settings below for an existing container. Either create/edit the file `env` in the `/conf` volume mapping or edit within the running container's context using:
-
-    docker exec -it CONTAINER_ID vi /conf/env
-
-replacing `CONTAINER_ID` with the container's ID or name.
-
-The contents of the `/conf/env` file are standard shell
-
-    NAME=VALUE
-
-entries where `NAME` is one of the variables described below.
-
-Configuration options not explicitly supported below can be specified via the `OPTS` environment variable. For example, by default `OPTS` is set with
-
-    OPTS=-Dnetwork.bind_host=_non_loopback_
-
-_NOTE: That option is a default since `bind_host` defaults to `localhost` as of 2.0, which isn't helpful for
-port mapping out from the container_.
-
-## Cluster Name
-
-If joining a pre-existing cluster, then you may need to specify a cluster name different than the default "elasticsearch":
-
-    -e CLUSTER=dockers
-
-## Zen Unicast Hosts
-
-When joining a multi-physical-host cluster, multicast may not be supported on the physical network. In that case, your node can reference specific one or more hosts in the cluster via the [Zen Unicast Hosts](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-discovery-zen.html#unicast) capability as a comma-separated list of `HOST:PORT` pairs:
-
-    -e UNICAST_HOSTS=HOST:PORT[,HOST:PORT]
-
-such as
-
-    -e UNICAST_HOSTS=192.168.0.100:9300
-
-## Plugins
-
-You can install one or more plugins before startup by passing a comma-separated list of plugins.
-
-    -e PLUGINS=ID[,ID]
-
-In this example, it will install the Marvel plugin
-
-    -e PLUGINS=elasticsearch/marvel/latest
-
-Many more plugins [are available here](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-plugins.html#known-plugins).
-
-## Publish As
-
-Since the container gives the Elasticsearch software an isolated perspective of its networking, it will most likely advertise its published address with a container-internal IP address. This can be overridden with a physical networking name and port using:
-
-    -e PUBLISH_AS=DOCKERHOST:9301
-
-_Author Note: I have yet to hit a case where this was actually necessary. Other
-than the cosmetic weirdness in the logs, Elasticsearch seems to be quite tolerant._
-
-## Node Name
-
-Rather than use the randomly assigned node name, you can indicate a specific one using:
-
-    -e NODE_NAME=Docker
-
-## Node Type
-
-If you refer to [the Node section](https://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-node.html)
-of the Elasticsearch reference guide, you'll find that there's three main types of nodes: master-eligible, data, and client.
-
-In larger clusters it is important to dedicate a small number (>= 3) of master nodes. There are also cases where a large cluster may need dedicated gateway nodes that are neither master nor data nodes and purely operate as "smart routers" and have large amounts of CPU and memory to handle client requests and search-reduce.
-
-To simplify all that, this image provides a `TYPE` variable to let you amongst these combinations. The choices are:
-
-* (not set, the default) : the default node type which is both master-eligible and a data node
-* `MASTER` : master-eligible, but holds no data. It is good to have three or more of these in a
-large cluster
-* `DATA` (or `NON_MASTER`) : holds data and serves search/index requests. Scale these out for elastic-y goodness.
-* `GATEWAY` : only operates as a client node or a "smart router". These are the ones whose HTTP port 9200 will need to be exposed
-
-A [Docker Compose](https://docs.docker.com/compose/overview/) file will serve as a good example of these three node types:
-
-```
-version: '2'
-
-services:
-  gateway:
-    image: itzg/elasticsearch
-    environment:
-      UNICAST_HOSTS: master
-      TYPE: GATEWAY
-    ports:
-      - "9200:9200"
-
-  master:
-    image: itzg/elasticsearch
-    environment:
-      UNICAST_HOSTS: gateway
-      TYPE: MASTER
-      MIN_MASTERS: 2
-
-  data:
-    image: itzg/elasticsearch
-    environment:
-      UNICAST_HOSTS: master,gateway
-      TYPE: DATA
-```
-
-## Minimum Master Nodes
-
-In combination with the `TYPE` variable above, you will also want to configure the minimum master nodes to [avoid split-brain](https://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-node.html#split-brain) during network outages.
-
-The minimum, which can be calculated as `(master_eligible_nodes / 2) + 1`, can be set with the `MIN_MASTERS` variable.
-
-Using the Docker Compose file above, a value of `2` is appropriate when scaling the cluster to 3 master nodes:
-
-    docker-compose scale master=3
-
-## Auto transport/http discovery with Swarm Mode
-
-When using Docker Swarm mode (starting with 1.12), the overlay and ingress network interfaces are assigned
-multiple IP addresses. As a result, it creates confusion for the transport publish logic even when using
-the special value `_eth0_`.
-
-To resolve this, add
-
-    -e DISCOVER_TRANSPORT_IP=eth0
-
-replacing `eth0` with another interface within the container, if needed.
-
-The same can be done for publish/binding of the http module by adding:
-
-    -e DISCOVERY_HTTP_IP=eth2
-
-## Heap size and other JVM options
-
-By default this image will run Elasticsearch with a Java heap size of 1 GB. If that value
-or any other JVM options need to be adjusted, then replace the `ES_JAVA_OPTS`
-environment variable.
-
-For example, this would allow for the use of 16 GB of heap:
-
-    -e ES_JAVA_OPTS="-Xms16g -Xmx16g"
-
-Refer to [this page](https://www.elastic.co/guide/en/elasticsearch/reference/current/heap-size.html)
-for more information about why both the minimum and maximum sizes were set to
-the same value.

elasticsearch/log4j2.properties

@@ -1,74 +0,0 @@
-status = error
-
-# log action execution errors for easier debugging
-logger.action.name = org.elasticsearch.action
-logger.action.level = debug
-
-appender.console.type = Console
-appender.console.name = console
-appender.console.layout.type = PatternLayout
-appender.console.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] %marker%m%n
-
-appender.rolling.type = RollingFile
-appender.rolling.name = rolling
-appender.rolling.fileName = ${sys:es.logs}.log
-appender.rolling.layout.type = PatternLayout
-appender.rolling.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] %marker%.10000m%n
-appender.rolling.filePattern = ${sys:es.logs}-%d{yyyy-MM-dd}.log
-appender.rolling.policies.type = Policies
-appender.rolling.policies.time.type = TimeBasedTriggeringPolicy
-appender.rolling.policies.time.interval = 1
-appender.rolling.policies.time.modulate = true
-
-rootLogger.level = info
-rootLogger.appenderRef.console.ref = console
-#rootLogger.appenderRef.rolling.ref = rolling
-
-appender.deprecation_rolling.type = RollingFile
-appender.deprecation_rolling.name = deprecation_rolling
-appender.deprecation_rolling.fileName = ${sys:es.logs}_deprecation.log
-appender.deprecation_rolling.layout.type = PatternLayout
-appender.deprecation_rolling.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] %marker%.10000m%n
-appender.deprecation_rolling.filePattern = ${sys:es.logs}_deprecation-%i.log.gz
-appender.deprecation_rolling.policies.type = Policies
-appender.deprecation_rolling.policies.size.type = SizeBasedTriggeringPolicy
-appender.deprecation_rolling.policies.size.size = 1GB
-appender.deprecation_rolling.strategy.type = DefaultRolloverStrategy
-appender.deprecation_rolling.strategy.max = 4
-
-logger.deprecation.name = org.elasticsearch.deprecation
-logger.deprecation.level = warn
-#logger.deprecation.appenderRef.deprecation_rolling.ref = deprecation_rolling
-logger.deprecation.additivity = false
-
-appender.index_search_slowlog_rolling.type = RollingFile
-appender.index_search_slowlog_rolling.name = index_search_slowlog_rolling
-appender.index_search_slowlog_rolling.fileName = ${sys:es.logs}_index_search_slowlog.log
-appender.index_search_slowlog_rolling.layout.type = PatternLayout
-appender.index_search_slowlog_rolling.layout.pattern = [%d{ISO8601}][%-5p][%-25c] %marker%.10000m%n
-appender.index_search_slowlog_rolling.filePattern = ${sys:es.logs}_index_search_slowlog-%d{yyyy-MM-dd}.log
-appender.index_search_slowlog_rolling.policies.type = Policies
-appender.index_search_slowlog_rolling.policies.time.type = TimeBasedTriggeringPolicy
-appender.index_search_slowlog_rolling.policies.time.interval = 1
-appender.index_search_slowlog_rolling.policies.time.modulate = true
-
-logger.index_search_slowlog_rolling.name = index.search.slowlog
-logger.index_search_slowlog_rolling.level = trace
-logger.index_search_slowlog_rolling.appenderRef.index_search_slowlog_rolling.ref = console
-logger.index_search_slowlog_rolling.additivity = false
-
-appender.index_indexing_slowlog_rolling.type = RollingFile
-appender.index_indexing_slowlog_rolling.name = index_indexing_slowlog_rolling
-appender.index_indexing_slowlog_rolling.fileName = ${sys:es.logs}_index_indexing_slowlog.log
-appender.index_indexing_slowlog_rolling.layout.type = PatternLayout
-appender.index_indexing_slowlog_rolling.layout.pattern = [%d{ISO8601}][%-5p][%-25c] %marker%.10000m%n
-appender.index_indexing_slowlog_rolling.filePattern = ${sys:es.logs}_index_indexing_slowlog-%d{yyyy-MM-dd}.log
-appender.index_indexing_slowlog_rolling.policies.type = Policies
-appender.index_indexing_slowlog_rolling.policies.time.type = TimeBasedTriggeringPolicy
-appender.index_indexing_slowlog_rolling.policies.time.interval = 1
-appender.index_indexing_slowlog_rolling.policies.time.modulate = true
-
-logger.index_indexing_slowlog.name = index.indexing.slowlog.index
-logger.index_indexing_slowlog.level = trace
-logger.index_indexing_slowlog.appenderRef.index_indexing_slowlog_rolling.ref = console
-logger.index_indexing_slowlog.additivity = false

elasticsearch/start

@@ -1,132 +0,0 @@
-#!/bin/sh
-
-pre_checks() {
-  mmc=$(sysctl vm.max_map_count|sed 's/.*= //')
-  if [[ $mmc -lt 262144 ]]; then
-    echo "
-ERROR: As of 5.0.0 Elasticsearch requires increasing mmap counts.
-Refer to https://www.elastic.co/guide/en/elasticsearch/reference/current/vm-max-map-count.html
-"
-    exit 1
-  fi
-}
-
-discoverIpFromLink() {
-  dev=$1
-  mode=$2
-  ip=`ipaddr show dev $dev scope global|awk '$1 == "inet" { if (!match($2,"/32")) { gsub("/.*","",$2) ; print $2 } }'`
-  echo "Discovered $mode address $ip for $dev"
-  OPTS="$OPTS -E $mode.host=$ip"
-}
-
-setup_clustering() {
-
-  if [ -n "$CLUSTER" ]; then
-    OPTS="$OPTS -E cluster.name=$CLUSTER"
-    if [ -n "$CLUSTER_FROM" ]; then
-      if [ -d /data/$CLUSTER_FROM -a ! -d /data/$CLUSTER ]; then
-        echo "Performing cluster data migration from $CLUSTER_FROM to $CLUSTER"
-        mv /data/$CLUSTER_FROM /data/$CLUSTER
-      fi
-    fi
-  fi
-
-  if [ -n "$NODE_NAME" ]; then
-    OPTS="$OPTS -E node.name=$NODE_NAME"
-  fi
-
-  if [ -n "$MULTICAST" ]; then
-    OPTS="$OPTS -E discovery.zen.ping.multicast.enabled=$MULTICAST"
-  fi
-
-  if [ -n "$UNICAST_HOSTS" ]; then
-    OPTS="$OPTS -E discovery.zen.ping.unicast.hosts=$UNICAST_HOSTS"
-  fi
-
-  if [ -n "$PUBLISH_AS" ]; then
-    OPTS="$OPTS -E transport.publish_host=$(echo $PUBLISH_AS | awk -F: '{print $1}')"
-    OPTS="$OPTS -E transport.publish_port=$(echo $PUBLISH_AS | awk -F: '{if ($2) print $2; else print 9300}')"
-  fi
-
-  if [ -n "$MIN_MASTERS" ]; then
-    OPTS="$OPTS -E discovery.zen.minimum_master_nodes=$MIN_MASTERS"
-  fi
-
-}
-
-install_plugins() {
-
-  if [ -n "$PLUGINS" ]; then
-    for p in $(echo $PLUGINS | awk -v RS=, '{print}')
-    do
-      echo "Installing the plugin $p"
-      $ES_HOME/bin/elasticsearch-plugin install $p
-    done
-  else
-    mkdir -p $ES_HOME/plugins
-  fi
-}
-
-setup_personality() {
-
-  if [ -n "$TYPE" ]; then
-    case $TYPE in
-      MASTER)
-        OPTS="$OPTS -E node.master=true -E node.data=false"
-        ;;
-
-      GATEWAY)
-        OPTS="$OPTS -E node.master=false -E node.data=false"
-        ;;
-
-      DATA|NON_MASTER)
-        OPTS="$OPTS -E node.master=false -E node.data=true"
-        ;;
-
-      *)
-        echo "Unknown node type. Please use MASTER|GATEWAY|DATA|NON_MASTER"
-        exit 1
-    esac
-  fi
-
-}
-
-pre_checks
-
-if [ -f /conf/env ]; then
-  . /conf/env
-fi
-
-if [ ! -e /conf/elasticsearch.* ]; then
-  cp $ES_HOME/config/elasticsearch.yml /conf
-fi
-
-if [ ! -e /conf/log4j2.properties ]; then
-  cp $ES_HOME/config/log4j2.properties /conf
-fi
-
-OPTS="$OPTS \
-  -E path.conf=/conf \
-  -E path.data=/data \
-  -E path.logs=/data \
-  -E transport.tcp.port=9300 \
-  -E http.port=9200"
-
-discoverIpFromLink $DISCOVER_TRANSPORT_IP transport
-discoverIpFromLink $DISCOVER_HTTP_IP http
-
-setup_personality
-setup_clustering
-install_plugins
-
-mkdir -p /conf/scripts
-
-echo "Starting Elasticsearch with the options $OPTS"
-CMD="$ES_HOME/bin/elasticsearch $OPTS"
-if [ `id -u` = 0 ]; then
-  echo "Running as non-root..."
-  chown -R $DEFAULT_ES_USER /data /conf
-  su -c "$CMD" $DEFAULT_ES_USER
-else
-  $CMD
-fi

examples/.gitignore

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

examples/README.md

@@ -0,0 +1,3 @@
+# Deployment Examples
+
+This directory contains various deployment examples of the [itzg/minecraft-server](https://hub.docker.com/r/itzg/minecraft-server/) Docker image.

examples/docker-compose-autopause.yml

@@ -0,0 +1,21 @@
+version: '3.8'
+
+services:
+  minecraft:
+    image: itzg/minecraft-server
+    ports:
+      - "25565:25565"
+    volumes:
+      - "mc:/data"
+    environment:
+      EULA: "TRUE"
+      ENABLE_AUTOPAUSE: "TRUE"
+      OVERRIDE_SERVER_PROPERTIES: "TRUE"
+      MAX_TICK_TIME: "-1"
+      # More aggressive settings for demo purposes
+      AUTOPAUSE_TIMEOUT_INIT: "30"
+      AUTOPAUSE_TIMEOUT_EST: "10"
+    restart: unless-stopped
+
+volumes:
+  mc: {}

examples/docker-compose-autostop.yml

@@ -0,0 +1,20 @@
+version: '3.8'
+
+services:
+  minecraft:
+    image: itzg/minecraft-server
+    ports:
+      - "25565:25565"
+    volumes:
+      - "mc:/data"
+    environment:
+      EULA: "TRUE"
+      ENABLE_AUTOSTOP: "TRUE"
+      # More aggressive settings for demo purposes
+      AUTOSTOP_TIMEOUT_INIT: "30"
+      AUTOSTOP_TIMEOUT_EST: "20"
+    # Important not to auto-restart the server!!!
+    restart: "no"
+
+volumes:
+  mc: {}

examples/docker-compose-big.yml

@@ -0,0 +1,29 @@
+version: '3.8'
+
+services:
+  minecraft:
+    ports:
+      - "25565:25565"
+    volumes:
+      - "mcbig:/data"
+    environment:
+      EULA: "TRUE"
+      MAX_MEMORY: 32G
+      MAX_BUILD_HEIGHT: 256
+      VIEW_DISTANCE: 15
+      LEVEL_TYPE: LARGEBIOMES
+      MAX_PLAYERS: 100
+      CONSOLE: "false"
+    image: itzg/minecraft-server
+    restart: always
+  rcon:
+    image: itzg/rcon
+    ports:
+      - "4326:4326"
+      - "4327:4327"
+    volumes:
+      - "rcon:/opt/rcon-web-admin/db"
+
+volumes:
+  mcbig:
+  rcon:

examples/docker-compose-curseforge-atm7.yaml

@@ -0,0 +1,151 @@
+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"
+      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-curseforge.yml

@@ -0,0 +1,21 @@
+version: '3.8'
+
+services:
+  mc:
+    image: itzg/minecraft-server:${IMAGE_TAG:-java8}
+    volumes:
+    - ./modpacks:/modpacks:ro
+    - data:/data
+    environment:
+      EULA: "true"
+      TYPE: CURSEFORGE
+      CF_SERVER_MOD: /modpacks/SIMPLE-SERVER-FILES-0.3.20.zip
+#      CF_SERVER_MOD: /modpacks/createlive3serverfiles+1.4.2.zip
+#      CF_SERVER_MOD: /modpacks/Valhelsia+3-3.5.1-SERVER.zip
+#      CF_SERVER_MOD: https://media.forgecdn.net/files/3012/800/SkyFactory-4_Server_4.2.2.zip
+#      CF_SERVER_MOD: /modpacks/${MODPACK:-SkyFactory_4_Server_4.1.0.zip}
+    ports:
+      - "25565:25565"
+
+volumes:
+  data: {}

examples/docker-compose-fabric.yml

@@ -0,0 +1,15 @@
+version: "3"
+
+services:
+  mc:
+    image: ${IMAGE:-itzg/minecraft-server}
+    environment:
+      EULA: "true"
+      TYPE: FABRIC
+    ports:
+      - 25565:25565
+    volumes:
+      - fabric:/data
+
+volumes:
+  fabric: {}

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.      #
+#                                                                  #
+# FORGEVERSION: 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
+      FORGEVERSION: 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-forge.yml

@@ -0,0 +1,24 @@
+version: "3.8"
+
+services:
+  mc:
+    image: itzg/minecraft-server
+    ports:
+    # expose the Minecraft server port outside of container
+    - "25565:25565"
+    environment:
+      # REQUIRED for all types
+      EULA: "TRUE"
+      # Set server type (vs the default of vanilla)
+      TYPE: FORGE
+      DEBUG: "true"
+    volumes:
+    # use a named, managed volume for data volume
+    - mc_forge:/data
+    # attach local host directory "mods" in same directory as this compose file
+    # all mods in this directory get copied into /data/mods at startup
+    - ./mods:/mods:ro
+
+volumes:
+  # declared the named volume, but use default/local storage engine
+  mc_forge: {}

examples/docker-compose-ftba.yml

@@ -0,0 +1,24 @@
+version: "3.8"
+
+services:
+  mc:
+    # FTBA support is only available in non-Alpine images
+    image: itzg/minecraft-server:${IMAGE_TAG:-java8-multiarch}
+    ports:
+      # expose the Minecraft server port outside of container
+      - 25565:25565
+    environment:
+      # REQUIRED for all types
+      EULA: "TRUE"
+      # Set server type (vs the default of vanilla)
+      TYPE: FTBA
+      # Use Pack ID from https://ftb.neptunepowered.org/pack/ftb-presents-direwolf20-1-12/
+      FTB_MODPACK_ID: "31"
+      FTB_MODPACK_VERSION_ID: ""
+    volumes:
+      # use a named, managed volume for data volume
+      - ftba:/data
+
+volumes:
+  # declared the named volume, but use default/local storage engine
+  ftba: {}

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

@@ -0,0 +1,160 @@
+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.      #
+#                                                                  #
+# FORGEVERSION: 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
+      FORGEVERSION: 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: ""
+      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.yml

@@ -0,0 +1,21 @@
+version: '3.8'
+
+services:
+  mc:
+    image: itzg/minecraft-server:${IMAGE_TAG:-latest}
+    volumes:
+    - data:/data
+    - ./modpacks:/modpacks:ro
+    environment:
+      EULA: "true"
+      TYPE: FORGE
+      DEBUG: "${DEBUG:-false}"
+      VERSION: ${VERSION:-1.17.1}
+      FORGEVERSION: ${FORGEVERSION:-37.0.90}
+      GENERIC_PACK: /modpacks/${MODPACK:-Server-Files-0.0.21.zip}
+      REMOVE_OLD_MODS: "${REMOVE_OLD_MODS:-false}"
+    ports:
+      - "25565:25565"
+
+volumes:
+  data: {}

examples/docker-compose-magma.yml

@@ -0,0 +1,17 @@
+version: "3.8"
+
+services:
+  mc:
+    image: itzg/minecraft-server:java8
+    tty: true
+    stdin_open: true
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: "TRUE"
+      TYPE: MAGMA
+      VERSION: 1.16.5
+    volumes:
+      - data:/data
+volumes:
+  data: {}

examples/docker-compose-modrinth.yml

@@ -0,0 +1,18 @@
+version: "3.8"
+
+services:
+  mc:
+    image: itzg/minecraft-server
+    tty: true
+    stdin_open: true
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: "TRUE"
+      TYPE: FABRIC
+      MODRINTH_PROJECTS: fallingtree
+    volumes:
+      - data:/data
+
+volumes:
+  data: {}

examples/docker-compose-mods-file.yml

@@ -0,0 +1,19 @@
+version: '3.8'
+
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: "true"
+      TYPE: FORGE
+      VERSION: 1.15.2
+      MODS_FILE: /extras/mods.txt
+      REMOVE_OLD_MODS: "true"
+    ports:
+      - 25565:25565
+    volumes:
+      - data:/data
+      - ./mods.txt:/extras/mods.txt:ro
+
+volumes:
+  data:

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-mohist.yml

@@ -0,0 +1,17 @@
+version: "3.8"
+
+services:
+  mc:
+    image: itzg/minecraft-server
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: "TRUE"
+      TYPE: MOHIST
+      VERSION: 1.12.2
+      DEBUG: "true"
+    volumes:
+      - data:/data
+
+volumes:
+  data: {}

examples/docker-compose-paper.yml

@@ -0,0 +1,19 @@
+version: '3.8'
+services:
+  mc:
+    image: itzg/minecraft-server
+    container_name: paper
+    environment:
+      EULA: "true"
+      ENABLE_RCON: "true"
+      TYPE: PAPER
+      VIEW_DISTANCE: 10
+      MEMORY: 2G
+      CONSOLE: "false"
+    ports:
+      - 25565:25565
+    volumes:
+      - mc-paper:/data
+    restart: unless-stopped
+volumes:
+  mc-paper:

examples/docker-compose-proxied.yml

@@ -0,0 +1,16 @@
+version: '3.8'
+
+services:
+  mc:
+#    build: .
+    image: itzg/minecraft-server
+    ports:
+      - 25565:25565
+    environment:
+      EULA: "TRUE"
+#      TYPE: SPIGOT
+#      VERSION: 1.11.2
+      PROXY: proxy:3128
+  proxy:
+    image: sameersbn/squid
+

examples/docker-compose-rconcmd.yml

@@ -0,0 +1,36 @@
+version: '3'
+
+services:
+  minecraft:
+    image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
+    ports:
+      - "25565:25565"
+    volumes:
+      - "mc:/data"
+    environment:
+      EULA: "TRUE"
+      TYPE: FABRIC
+      MODS_FORGEAPI_PROJECTIDS: 433175
+      MODS_FORGEAPI_KEY: ${MODS_FORGEAPI_KEY}
+      MODS_FORGEAPI_DOWNLOAD_DEPENDENCIES: "TRUE"
+      REMOVE_OLD_FORGEAPI_MODS: "TRUE"
+      # YAML Heredoc, be sure to use '|-' this will remove the first newline and final new line.
+      # This is versus '|' that will leaving with two empty strings at top and bottom.
+      RCON_CMDS_STARTUP:  |-
+        /gamerule doFireTick false
+        /team add New
+        /team add Old
+        /chunky radius 1000
+        /chunky start
+      RCON_CMDS_ON_CONNECT: |-
+        /team join New @a[team=]
+        /give @a[team=New] birch_boat
+        /team join Old @a[team=New]
+      RCON_CMDS_FIRST_CONNECT: |-
+        /chunky pause
+      RCON_CMDS_LAST_DISCONNECT: |-
+        /kill @e[type=minecraft:boat]
+        /chunky continue
+    restart: unless-stopped
+volumes:
+  mc: {}

examples/docker-compose-rlcraft.yml

@@ -0,0 +1,27 @@
+version: '3.8'
+
+services:
+  mc:
+    image: itzg/minecraft-server:java8
+    volumes:
+    - data:/data
+    - ./modpacks:/modpacks:ro
+    environment:
+      EULA: "true"
+      TYPE: "FORGE"
+      VERSION: "1.12.2"
+      FORGEVERSION: "14.23.5.2860"
+      OVERRIDE_SERVER_PROPERTIES: "true"
+      DIFFICULTY: "hard"
+      MAX_TICK_TIME: "-1"
+      ALLOW_FLIGHT: "true"
+      ENABLE_COMMAND_BLOCK: "true"
+      VIEW_DISTANCE: "10"
+      MEMORY: "4G"
+      # Download from https://www.curseforge.com/minecraft/modpacks/rlcraft and place in modpacks subdir
+      GENERIC_PACK: "/modpacks/RLCraft+Server+Pack+1.12.2+-+Release+v2.9.1c.zip"
+    ports:
+      - 25565:25565
+
+volumes:
+  data:

examples/docker-compose-simple.yml

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

examples/docker-compose-spiget.yml

@@ -0,0 +1,20 @@
+version: "3"
+
+services:
+  mc:
+    # Only using IMAGE variable to allow for local testing
+    image: itzg/minecraft-server
+#    image: ${IMAGE:-itzg/minecraft-server}
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: "TRUE"
+      TYPE: SPIGOT
+#      SPIGET_RESOURCES: 34315,3836
+      SPIGET_RESOURCES: ""
+      REMOVE_OLD_MODS: "true"
+    volumes:
+      - data:/data
+
+volumes:
+  data: {}

examples/docker-compose-spongeforge.yml

@@ -0,0 +1,34 @@
+version: '3.8'
+# Forge with Sponge API support. THIS REQUIRES DOWNLOADING SPONGEFORGE.
+# Place the SpongeForge jar file in /data/mods. Other Forge mods go here as well.
+# Place Sponge mods in /data/mods/plugins. Yes, this is a directory inside the Forge mod directory. Do NOT use /data/plugins.
+
+services:
+  minecraft:
+    image: itzg/minecraft-server:java8
+    ports:
+      - "25565:25565"
+    volumes:
+      - "mc:/data"
+    environment:
+      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"
+      CONSOLE: "false"
+      ENABLE_RCON: "true"
+      RCON_PASSWORD: "testing"
+      RCON_PORT: 28016
+    restart: unless-stopped
+  rcon:
+    image: itzg/rcon
+    ports:
+      - "4326:4326"
+      - "4327:4327"
+    volumes:
+      - "rcon:/opt/rcon-web-admin/db"
+
+volumes:
+  mc:
+  rcon:

examples/docker-compose-world-download.yml

@@ -0,0 +1,11 @@
+version: "3.8"
+
+services:
+  mc:
+    image: itzg/minecraft-server
+    ports:
+      - 25565:25565
+    environment:
+      EULA: "TRUE"
+      VERSION: 1.7.2
+      WORLD: https://www.minecraftmaps.com/survival-maps/cube-survival/download

examples/docker-compose.yml

@@ -0,0 +1,16 @@
+version: '3'
+# Other docker-compose examples in /examples
+
+services:
+  minecraft:
+    image: itzg/minecraft-server
+    ports:
+      - "25565:25565"
+    volumes:
+      - "mc:/data"
+    environment:
+      EULA: "TRUE"
+    restart: always
+
+volumes:
+  mc: {}

examples/k8s/using-statefulset.yml

@@ -0,0 +1,62 @@
+---
+apiVersion: apps/v1
+kind: StatefulSet
+metadata:
+  labels:
+    app: mc-example
+  name: mc-example
+spec:
+  replicas: 1
+  serviceName: mc-example
+  selector:
+    matchLabels:
+      app: mc-example
+  template:
+    metadata:
+      labels:
+        app: mc-example
+    spec:
+      containers:
+        - name: mc
+          image: itzg/minecraft-server
+          env:
+            - name: EULA
+              value: "TRUE"
+          volumeMounts:
+            - mountPath: /data
+              name: data
+          readinessProbe:
+            exec:
+              command:
+                - mc-monitor 
+                - status 
+                - --host 
+                - localhost 
+                - --port
+                - "25565"
+            initialDelaySeconds: 30
+            periodSeconds: 5
+            failureThreshold: 18
+  volumeClaimTemplates:
+    - metadata:
+        name: data
+      spec:
+        accessModes:
+          - ReadWriteOnce
+        resources:
+          requests:
+            storage: 1Gi
+---
+apiVersion: v1
+kind: Service
+metadata:
+  labels:
+    service: mc-example
+  name: mc-example
+spec:
+  ports:
+    - port: 25565
+      targetPort: 25565
+  selector:
+    app: mc-example
+  type: NodePort

examples/k8s/vanilla-deployment.yml

@@ -0,0 +1,54 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: mc-vanilla
+spec:
+  type: NodePort
+  ports:
+  - port: 25565
+    nodePort: 30000
+  selector:
+    app: mc-vanilla
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: mc-vanilla
+spec:
+  selector:
+    matchLabels:
+      app: mc-vanilla
+  template:
+    metadata:
+      labels:
+        app: mc-vanilla
+    spec:
+      containers:
+      - image: itzg/minecraft-server
+        name: mc-vanilla
+        env:
+          # Use secret in real usage
+        - name: EULA
+          value: "true"
+        ports:
+        - containerPort: 25565
+          name: main
+        readinessProbe:
+          exec:
+            command: [ "/usr/local/bin/mc-monitor", "status", "--host", "localhost" ]
+          # Give it i + p * f seconds to be ready, so 120 seconds
+          initialDelaySeconds: 20
+          periodSeconds: 5
+          failureThreshold: 20
+        # Monitor ongoing liveness
+        livenessProbe:
+          exec:
+            command: ["/usr/local/bin/mc-monitor", "status", "--host", "localhost"]
+          initialDelaySeconds: 120
+          periodSeconds: 60
+        volumeMounts:
+        - name: mc-data
+          mountPath: /data
+      volumes:
+      - name: mc-data
+        emptyDir: {}

examples/modpacks/.gitignore

@@ -0,0 +1 @@
+*.zip

examples/modpacks/README.md

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

examples/mods.txt

@@ -0,0 +1,80 @@
+https://edge.forgecdn.net/files/2965/233/Bookshelf-1.15.2-5.6.40.jar
+https://edge.forgecdn.net/files/2926/27/ProgressiveBosses-2.1.5-mc1.15.2.jar
+https://edge.forgecdn.net/files/3248/905/goblintraders-1.3.1-1.15.2.jar
+https://edge.forgecdn.net/files/3272/32/jei-1.15.2-6.0.3.16.jar
+https://edge.forgecdn.net/files/2871/647/ToastControl-1.15.2-3.0.1.jar
+https://edge.forgecdn.net/files/3101/903/Druidcraft-1.15-0.4.45.jar
+https://edge.forgecdn.net/files/2880/426/DefaultOptions_1.15.2-11.0.1.jar
+https://edge.forgecdn.net/files/2996/535/MekanismAdditions-1.15.2-9.10.9.422.jar
+https://edge.forgecdn.net/files/3147/275/blockcarpentry-1.15-0.8.2.jar
+https://edge.forgecdn.net/files/3005/715/refinedstorageaddons-0.6.3.jar
+https://edge.forgecdn.net/files/3140/146/rftoolsbase-1.15-1.1.10.jar
+https://edge.forgecdn.net/files/3236/649/cc-tweaked-1.15.2-1.95.3.jar
+https://edge.forgecdn.net/files/3048/970/light-overlay-4.7.2.jar
+https://edge.forgecdn.net/files/3015/904/randompatches-1.15.2-1.22.1.1.jar
+https://edge.forgecdn.net/files/3131/439/engineersdecor-1.15.2-1.1.4.jar
+https://edge.forgecdn.net/files/3051/255/carryon-1.15.2-1.13.0.5.jar
+https://edge.forgecdn.net/files/3175/752/EnderStorage-1.15.2-2.5.2.164-universal.jar
+https://edge.forgecdn.net/files/2997/84/Savage-and-Ravage-1.15.2-1.1.4.jar
+https://edge.forgecdn.net/files/3053/840/PackMenu-1.15.2-1.2.8.jar
+https://edge.forgecdn.net/files/3003/397/JEITweaker-1.15.2-1.0.1.3.jar
+https://edge.forgecdn.net/files/3069/489/absentbydesign-1.15.2-1.1.1.jar
+https://edge.forgecdn.net/files/2997/601/Upgrade-Aquatic-1.15.2-1.7.1.jar
+https://edge.forgecdn.net/files/2950/766/ReAuth-1.14-1.15-3.8.1.jar
+https://edge.forgecdn.net/files/3024/179/Powah-1.15.2-1.1.15.jar
+https://edge.forgecdn.net/files/3092/975/StorageDrawers-1.15.2-7.0.3.jar
+https://edge.forgecdn.net/files/2853/267/furniture-7.0.0-pre16-1.15.1.jar
+https://edge.forgecdn.net/files/2987/251/AppleSkin-mc1.15.2-forge-1.0.14.jar
+https://edge.forgecdn.net/files/2980/323/industrial-foregoing-1.15.2-2.3.3-e356e61.jar
+https://edge.forgecdn.net/files/3024/178/Lollipop-1.15.2-1.0.16.jar
+https://edge.forgecdn.net/files/3210/106/tablechair-1.4.jar
+https://edge.forgecdn.net/files/3047/358/xercapaint-1.15.2-3.3.jar
+https://edge.forgecdn.net/files/2873/657/BonsaiTrees-2.1.2.6.jar
+https://edge.forgecdn.net/files/2938/583/config-2-3.0.jar
+https://edge.forgecdn.net/files/2991/235/Waystones_1.15.2-6.0.2.jar
+https://edge.forgecdn.net/files/2957/23/OpenLoader-1.15.2-4.0.5.jar
+https://edge.forgecdn.net/files/3275/718/XaerosWorldMap_1.13.2_Forge_1.15.2.jar
+https://edge.forgecdn.net/files/2876/104/AI-Improvements-1.15.2-0.3.0.jar
+https://edge.forgecdn.net/files/3005/515/mysticallib-1.15.2-2.0.1.jar
+https://edge.forgecdn.net/files/3008/867/WAWLA-1.15.2-3.0.4.jar
+https://edge.forgecdn.net/files/2964/474/WailaHarvestability-mc1.15.2-1.1.12.jar
+https://edge.forgecdn.net/files/3103/508/Kiwi-1.15.2-2.8.5.jar
+https://edge.forgecdn.net/files/3128/662/Atum-1.15.2-2.1.12.jar
+https://edge.forgecdn.net/files/2988/910/Buzzier-Bees-1.15.2-1.5.2.jar
+https://edge.forgecdn.net/files/3030/627/u_team_core-1.15.2-3.0.2.169.jar
+https://edge.forgecdn.net/files/3003/984/SilentLib-1.15.2-4.6.6+59.jar
+https://edge.forgecdn.net/files/2968/353/refinedpipes-0.4.2.jar
+https://edge.forgecdn.net/files/3140/149/rftoolsbuilder-1.15-2.1.16.jar
+https://edge.forgecdn.net/files/3067/203/mightyarchitect-mc1.15.2_v0.5.jar
+https://edge.forgecdn.net/files/2980/153/EquipmentTooltips-1.15.2-1.4.3+14.jar
+https://edge.forgecdn.net/files/3103/510/FruitTrees-1.15.2-1.7.0.jar
+https://edge.forgecdn.net/files/2989/38/Atmospheric-1.15.2-1.4.1.jar
+https://edge.forgecdn.net/files/3096/836/rftoolscontrol-1.15-3.0.9.jar
+https://edge.forgecdn.net/files/2989/662/Enhanced-Mushrooms-1.15.2-v1.2.2.jar
+https://edge.forgecdn.net/files/3227/891/SimpleStorageNetwork-1.15.2-1.0.2.jar
+https://edge.forgecdn.net/files/3217/290/minecolonies-0.13.645-RELEASE-universal.jar
+https://edge.forgecdn.net/files/2935/384/SnowRealMagic-1.15.2-1.7.5.jar
+https://edge.forgecdn.net/files/2988/584/aiotbotania-1.15.2-1.2.3.jar
+https://edge.forgecdn.net/files/3255/408/mowziesmobs-1.5.15.jar
+https://edge.forgecdn.net/files/3062/510/HealthOverlay-1.15.2-1.0.2.jar
+https://edge.forgecdn.net/files/3023/121/neoncraft-1.1.jar
+https://edge.forgecdn.net/files/2997/617/Swamp-Expansion-1.15.2-1.7.3.jar
+https://edge.forgecdn.net/files/2980/252/titanium-1.15.2-2.4.2.jar
+https://edge.forgecdn.net/files/3152/946/rftoolsutility-1.15-2.1.20.jar
+https://edge.forgecdn.net/files/3083/277/swingthroughgrass-1.15.2-1.4.1.jar
+https://edge.forgecdn.net/files/3138/530/SilentGear-1.15.2-1.11.4+187.jar
+https://edge.forgecdn.net/files/3105/429/DarkUtilities-1.15.2-3.1.9.jar
+https://edge.forgecdn.net/files/3099/23/ImmersiveEngineering-1.15.2-4.1.1-125.jar
+https://edge.forgecdn.net/files/2856/529/FastFurnace-1.15.1-3.0.0.jar
+https://edge.forgecdn.net/files/2988/999/BiomesOPlenty-1.15.2-10.0.0.366-universal.jar
+https://edge.forgecdn.net/files/2989/95/The-Endergetic-Expansion-1.15.2-v1.3.2.jar
+https://edge.forgecdn.net/files/2993/960/FluxNetworks-1.15.2-5.0.3-4.jar
+https://edge.forgecdn.net/files/3028/611/ServerTabInfo-1.15.2-1.2.8.jar
+https://edge.forgecdn.net/files/3134/277/fairylights-3.0.15-1.15.2.jar
+https://edge.forgecdn.net/files/3048/54/useful_backpacks-1.15.2-1.10.3.77.jar
+https://edge.forgecdn.net/files/3273/515/mcw-trapdoors-1.0.2-mc1.15.2.jar
+https://edge.forgecdn.net/files/2986/639/CraftingTweaks_1.15.2-11.0.1.jar
+https://edge.forgecdn.net/files/3261/454/create-mc1.15.2_v0.3.1a.jar
+https://edge.forgecdn.net/files/3211/10/supermartijn642configlib-1.0.5-mc1.15.jar
+https://edge.forgecdn.net/files/2995/786/TerraForged-1.15.2-0.0.15.jar
+https://edge.forgecdn.net/files/2892/562/leavesdecayonotherleaves-1.1.jar

examples/paper-build-plugins/Dockerfile

@@ -0,0 +1,5 @@
+FROM itzg/minecraft-server
+
+ENV TYPE=PAPER
+
+COPY plugins/*.jar /plugins/

examples/paper-build-plugins/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3.7'
+
+services:
+  mc:
+    build: .
+    environment:
+      EULA: "TRUE"
+    ports:
+    - 25565:25565
+    stdin_open: true
+    tty: true

examples/paper-build-plugins/plugins/.gitignore

@@ -0,0 +1 @@
+*.jar

examples/paper-build-plugins/plugins/README.md

@@ -0,0 +1 @@
+Download Bukkit/Spigot plugin jars, such as [WorldEdit](https://dev.bukkit.org/projects/worldedit/files) and place them here. At image build time the `COPY` step will place those jars in `/plugins`. At container startup, the contents of `/plugins` are sync'ed into `/data/plugins` for use with Bukkit/Spigot/Paper server types.

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/vanilla-tweaks/docker-compose.yml

@@ -0,0 +1,27 @@
+version: "3.3"
+
+services:
+  vanillatweaks_file:
+    restart: "no"
+    image: itzg/minecraft-server
+    ports:
+      - "25565:25565/tcp"
+    environment:
+      EULA: "TRUE"
+      VERSION: ${MINECRAFT_VERSION:-LATEST}
+      VANILLATWEAKS_FILE: /config/vanillatweaks-datapacks.json
+      REMOVE_OLD_VANILLATWEAKS: "TRUE"
+    volumes:
+      - data:/data
+      - ./vanillatweaks-datapacks.json:/config/vanillatweaks-datapacks.json:ro
+  vanillatweaks_sharecode:
+    # port is set to 25566 to not conflict with vanillatweaks_file example
+    ports:
+      - "25566:25565/tcp"
+    restart: "no"
+    image: itzg/minecraft-server
+    environment:
+      EULA: "TRUE"
+      VERSION: ${MINECRAFT_VERSION:-LATEST}
+      VANILLATWEAKS_SHARECODE: MGr52E
+      REMOVE_OLD_VANILLATWEAKS: "TRUE"

examples/vanilla-tweaks/vanillatweaks-datapacks.json

@@ -0,0 +1,15 @@
+{
+    "version": "1.18",
+    "packs": {
+        "survival": [
+            "graves",
+            "multiplayer sleep",
+            "afk display",
+            "armor statues",
+            "unlock all recipes",
+            "fast leaf decay",
+            "coordinates hud"
+        ],
+        "items": ["armored elytra"]
+    }
+}

files/auto/autopause-daemon.sh

@@ -0,0 +1,135 @@
+#!/bin/bash
+
+. /auto/autopause-fcns.sh
+
+# shellcheck source=../../scripts/start-utils
+. "${SCRIPTS:-/}start-utils"
+if isTrue "${DEBUG_AUTOPAUSE}"; then
+  set -x
+fi
+
+autopause_error_loop() {
+  logAutopause "Available interfaces within the docker container:"
+  INTERFACES=$(echo /sys/class/net/*)
+  INTERFACES=${INTERFACES//\/sys\/class\/net\//}
+  logAutopause "  $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."
+  while :
+  do
+    sleep 1800
+    logAutopause "Autopause failed to initialize."
+  done
+}
+
+# wait for java process to be started
+while :
+do
+  if java_process_exists ; then
+    break
+  fi
+  sleep 0.1
+done
+
+# check for interface existence
+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
+  logAutopause "Selected interface \"$AUTOPAUSE_KNOCK_INTERFACE\" does not exist!"
+  autopause_error_loop
+fi
+
+knockdArgs=(-c /tmp/knockd-config.cfg -d -i "$AUTOPAUSE_KNOCK_INTERFACE")
+if isTrue "${DEBUG_AUTOPAUSE}"; then
+  knockdArgs+=(-D)
+fi
+
+sudo /usr/sbin/knockd "${knockdArgs[@]}"
+if [ $? -ne 0 ] ; then
+  logAutopause "Failed to start knockd daemon."
+  logAutopause "Probable cause: Unable to attach to interface \"$AUTOPAUSE_KNOCK_INTERFACE\"."
+  autopause_error_loop
+fi
+
+STATE=INIT
+
+while :
+do
+  isTrue "${DEBUG_AUTOPAUSE}" && log "DEBUG: autopause state = $STATE"
+  case X$STATE in
+  XINIT)
+    # Server startup
+    if mc_server_listening ; then
+      TIME_THRESH=$(($(current_uptime)+$AUTOPAUSE_TIMEOUT_INIT))
+      logAutopause "MC Server listening for connections - pausing in $AUTOPAUSE_TIMEOUT_INIT seconds"
+      STATE=K
+    fi
+    ;;
+  XK)
+    # Knocked
+    if java_clients_connected ; then
+      logAutopause "Client connected - waiting for disconnect"
+      STATE=E
+    else
+      if [[ $(current_uptime) -ge $TIME_THRESH ]] ; then
+        logAutopause "No client connected since startup / knocked - pausing"
+        /auto/pause.sh
+        STATE=S
+      fi
+    fi
+    ;;
+  XE)
+    # Established
+    if ! java_clients_connected ; then
+      TIME_THRESH=$(($(current_uptime)+$AUTOPAUSE_TIMEOUT_EST))
+      logAutopause "All clients disconnected - pausing in $AUTOPAUSE_TIMEOUT_EST seconds"
+      STATE=I
+    fi
+    ;;
+  XI)
+    # Idle
+    if java_clients_connected ; then
+      logAutopause "Client reconnected - waiting for disconnect"
+      STATE=E
+    else
+      if [[ $(current_uptime) -ge $TIME_THRESH ]] ; then
+        logAutopause "No client reconnected - pausing"
+        /auto/pause.sh
+        STATE=S
+      fi
+    fi
+    ;;
+  XS)
+    # Stopped
+    if rcon_client_exists ; then
+      /auto/resume.sh
+    fi
+    if java_running ; then
+      if java_clients_connected ; then
+        logAutopause "Client connected - waiting for disconnect"
+        STATE=E
+      else
+        TIME_THRESH=$(($(current_uptime)+$AUTOPAUSE_TIMEOUT_KN))
+        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
+    ;;
+  *)
+    logAutopause "Error: invalid state: $STATE"
+    ;;
+  esac
+  if [[ "$STATE" == "S" ]] ; then
+    # before rcon times out
+    sleep 5
+  else
+    sleep "$AUTOPAUSE_PERIOD"
+  fi
+done

files/auto/autopause-fcns.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+current_uptime() {
+  awk '{print $1}' /proc/uptime | cut -d . -f 1
+}
+
+java_running() {
+  [[ $( ps -ax -o stat,comm | grep 'java' | awk '{ print $1 }') =~ ^S.*$ ]]
+}
+
+java_process_exists() {
+  [[ -n "$(ps -ax -o comm | grep 'java')" ]]
+}
+
+rcon_client_exists() {
+  [[ -n "$(ps -ax -o comm | grep 'rcon-cli')" ]]
+}
+
+mc_server_listening() {
+  mc-monitor status --host localhost --port "$SERVER_PORT" --timeout 10s >& /dev/null
+}
+
+java_clients_connections() {
+  local connections
+  if java_running ; then
+    connections=$(mc-monitor status --host localhost --port "$SERVER_PORT" --show-player-count)
+  else
+    connections=0
+  fi
+  echo $connections
+}
+
+java_clients_connected() {
+  (( $(java_clients_connections) > 0 ))
+}

files/auto/autostop-daemon.sh

@@ -0,0 +1,74 @@
+#!/bin/bash
+
+# needed for the clients connected function residing in autopause
+. /auto/autopause-fcns.sh
+
+# shellcheck source=../../scripts/start-utils
+. "${SCRIPTS:-/}start-utils"
+if isTrue "${DEBUG_AUTOSTOP}"; then
+  set -x
+fi
+
+# wait for java process to be started
+while :
+do
+  if java_process_exists ; then
+    break
+  fi
+  sleep 0.1
+done
+
+STATE=INIT
+
+while :
+do
+  isTrue "${DEBUG_AUTOSTOP}" && log "DEBUG: autostop state = $STATE"
+  case X$STATE in
+  XINIT)
+    # Server startup
+    if mc_server_listening ; then
+      TIME_THRESH=$(($(current_uptime)+AUTOSTOP_TIMEOUT_INIT))
+      logAutostop "MC Server listening for connections - stopping in $AUTOSTOP_TIMEOUT_INIT seconds"
+      STATE=II
+    fi
+    ;;
+  XII)
+    # Initial idle
+    if java_clients_connected ; then
+      logAutostop "Client connected - waiting for disconnect"
+      STATE=E
+    else
+      if [[ $(current_uptime) -ge $TIME_THRESH ]] ; then
+        logAutostop "No client connected since startup - stopping server"
+        /auto/stop.sh
+        exit 0
+      fi
+    fi
+    ;;
+  XE)
+    # Established
+    if ! java_clients_connected ; then
+      TIME_THRESH=$(($(current_uptime)+$AUTOSTOP_TIMEOUT_EST))
+      logAutostop "All clients disconnected - stopping in $AUTOSTOP_TIMEOUT_EST seconds"
+      STATE=I
+    fi
+    ;;
+  XI)
+    # Idle
+    if java_clients_connected ; then
+      logAutostop "Client reconnected - waiting for disconnect"
+      STATE=E
+    else
+      if [[ $(current_uptime) -ge $TIME_THRESH ]] ; then
+        logAutostop "No client reconnected - stopping"
+        /auto/stop.sh
+        exit 0
+      fi
+    fi
+    ;;
+  *)
+    logAutostop "Error: invalid state: $STATE"
+    ;;
+  esac
+  sleep $AUTOSTOP_PERIOD
+done

files/auto/knockd-config.cfg

@@ -0,0 +1,15 @@
+[options]
+ logfile = /dev/null
+[unpauseMCServer-server]
+ sequence = 25565
+ seq_timeout = 1
+ command = /auto/resume.sh %IP%
+ tcpflags = syn
+[unpauseMCServer-rcon]
+ sequence = 25575
+ seq_timeout = 1
+ command = /auto/resume.sh %IP%
+ tcpflags = syn
+[unpauseMCServer-bedrock]
+ sequence = 19132:udp
+ command = /auto/resume.sh %IP%

files/auto/pause.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+. /start-utils
+if isTrue "${DEBUG_AUTOPAUSE}"; then
+  set -x
+fi
+
+if [[ $( ps -ax -o stat,comm | grep 'java' | awk '{ print $1 }') =~ ^S.*$ ]] ; then
+  # save world
+  rcon-cli save-all >/dev/null
+
+  # wait until mc-monitor is no longer connected to the server
+  while :
+  do
+    if [[ -z "$(netstat -nt | grep "127.0.0.1:$SERVER_PORT" | grep 'ESTABLISHED')" ]]; then
+      break
+    fi
+    sleep 0.1
+  done
+
+  # finally pause the process
+  logAutopauseAction "Pausing Java process"
+  pkill -STOP java
+fi

files/auto/resume.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+. /start-utils
+if isTrue "${DEBUG_AUTOPAUSE}"; then
+  set -x
+fi
+
+if [[ $( ps -ax -o stat,comm | grep 'java' | awk '{ print $1 }') =~ ^T.*$ ]] ; then
+  logAutopauseAction "Knocked from $1, resuming Java process"
+  echo "$1" > /var/log/knocked-source
+  pkill -CONT java
+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/log4j2.xml

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Configuration status="WARN" packages="com.mojang.util">
+    <Appenders>
+        <Console name="SysOut" target="SYSTEM_OUT">
+            <PatternLayout pattern="[%d{HH:mm:ss}] [%t/%level]: %msg%n" />
+        </Console>
+        <Queue name="TerminalConsole">
+            <PatternLayout pattern="[%d{HH:mm:ss} %level]: %msg%n" />
+        </Queue>
+        <RollingRandomAccessFile name="File" fileName="logs/latest.log" filePattern="logs/%d{yyyy-MM-dd}-%i.log.gz">
+            <PatternLayout pattern="[%d{HH:mm:ss}] [%t/%level]: %msg%n" />
+            <Policies>
+                <!-- Based on filePattern resolution, so daily -->
+                <TimeBasedTriggeringPolicy />
+                <SizeBasedTriggeringPolicy size="100 MB" />
+                <OnStartupTriggeringPolicy />
+            </Policies>
+            <DefaultRolloverStrategy>
+                <Delete basePath="logs">
+                    <IfFileName glob="*.log.gz" />
+                    <IfLastModified age="7d" />
+                    <IfAccumulatedFileCount exceeds="20"/>
+                </Delete>
+            </DefaultRolloverStrategy>
+        </RollingRandomAccessFile>
+    </Appenders>
+    <Loggers>
+        <Root level="info">
+            <filters>
+                <MarkerFilter marker="NETWORK_PACKETS" onMatch="DENY" onMismatch="NEUTRAL" />
+            </filters>
+            <AppenderRef ref="SysOut"/>
+            <AppenderRef ref="File"/>
+            <AppenderRef ref="TerminalConsole"/>
+        </Root>
+    </Loggers>
+</Configuration>

files/server.properties

@@ -22,6 +22,7 @@ snooper-enabled=true
 texture-pack=
 online-mode=true
 resource-pack=
+resource-pack-sha1=
 pvp=true
 difficulty=1
 enable-command-block=true
@@ -36,3 +37,15 @@ motd=A Minecraft Server powered by Docker
 generator-settings=
 rcon.password=
 max-world-size=29999984
+broadcast-console-to-ops=true
+broadcast-rcon-to-ops=true
+enable-jmx-monitoring=false
+sync-chunk-writes=true
+enable-status=true
+entity-broadcast-range-percentage=100
+function-permission-level=2
+network-compression-threshold=256
+op-permission-level=4
+prevent-proxy-connections=false
+use-native-transport=true
+enforce-whitelist=false

files/sudoers-mc

@@ -0,0 +1,2 @@
+minecraft ALL=(ALL) NOPASSWD:/usr/bin/pkill
+minecraft ALL=(ALL) NOPASSWD:/usr/sbin/knockd