docs: updated to new name of itzg/mc-proxy (#2917)

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

.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,41 @@
+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:
+        1. Do you just have a question about something? If so, asking in the [Q&A Discussions](https://github.com/itzg/docker-minecraft-server/discussions/categories/q-a) or asking on [the Discord server](https://discord.gg/DXfKpjB) would be best.
+        2. Did you **re-pull the newest image** and confirmed the issue after that? Run `docker pull <image>` or if using a compose file, it's as easy as running `docker compose pull`. If using Kubernetes, add `imagePullPolicy: Always` to the container. 
+        4. 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.
+        5. Are you seeing a performance problem? If so, that is typically outside the scope of this image. 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,24 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      updates:
+        patterns:
+          - "*"
+        update-types:
+          - patch
+          - minor
+  - package-ecosystem: pip
+    directory: "/docs"
+    schedule:
+      interval: weekly
+    groups:
+      patches:
+        patterns:
+          - "*"
+        update-types:
+          - patch
+          - minor

.github/no-response.yml

@@ -1,6 +0,0 @@
-daysUntilClose: 14
-responseRequiredLabel: "status/waiting on feedback"
-closeComment: >
-  This issue has been automatically closed because there has been no response
-  after requesting feedback. Please feel free to re-open this issue if the
-  scenario still exists and provide a comment with more information.

.github/release.yml

@@ -0,0 +1,17 @@
+changelog:
+  exclude:
+    authors:
+      - dependabot
+  categories:
+    - title: Enhancements
+      labels:
+        - enhancement
+    - title: Bug Fixes
+      labels:
+        - bug
+    - title: Documentation
+      labels:
+        - documentation
+    - title: Other Changes
+      labels:
+        - "*"

.github/workflows/build-multiarch.yml

@@ -1,82 +1,208 @@
-name: Build and publish multiarch
+name: Build and Publish
 on:
   push:
     branches:
-      - multiarch
-      - java8-multiarch
-      - multiarch-latest
-      - java15
-      - test/multiarch/*
+      - master
+      - test/**
     tags:
-      - "[0-9]+.[0-9]+.[0-9]+-multiarch"
-      - "[0-9]+.[0-9]+.[0-9]+-multiarch-latest"
-      - "[0-9]+.[0-9]+.[0-9]+-java15"
+      - "[0-9]+.[0-9]+.[0-9]+"
+    paths-ignore:
+      - "*.md"
+      - "docs/**"
+      - "examples/**"
+      - "notes/**"
 
 jobs:
-  docker-buildx:
-    runs-on: ubuntu-20.04
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        # NOTE: the "latest" variant is identified in the Docker meta step's 'latest' config
+        variant:
+          - java21-graalvm
+          - java21
+          - java21-jdk
+          - java21-alpine
+          - java17
+          - java17-graalvm
+          - java17-alpine
+          - java8
+          - java8-graalvm-ce
+          - java8-openj9
+          - java8-jdk
+          - java8-alpine
+          - java11
+        include:
+        # JAVA 21:
+          - variant: java21-graalvm
+            baseImage: container-registry.oracle.com/graalvm/jdk:21-ol8
+            platforms: linux/amd64,linux/arm64
+            mcVersion: latest
+          - variant: java21
+            baseImage: eclipse-temurin:21-jre
+            platforms: linux/amd64,linux/arm64
+            mcVersion: latest
+          - variant: java21-jdk
+            baseImage: eclipse-temurin:21
+            platforms: linux/amd64,linux/arm64
+            mcVersion: latest
+          - variant: java21-alpine
+            baseImage: eclipse-temurin:21-jre-alpine
+            platforms: linux/amd64,linux/arm64
+            mcVersion: latest
+        # 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.20.4
+          - variant: java17-graalvm
+            baseImage: container-registry.oracle.com/graalvm/jdk:17-ol8
+            platforms: linux/amd64,linux/arm64
+            mcVersion: 1.20.4
+          - variant: java17-jdk
+            baseImage: eclipse-temurin:17-focal
+            platforms: linux/amd64,linux/arm/v7,linux/arm64
+            mcVersion: 1.20.4
+          - variant: java17-alpine
+            baseImage: eclipse-temurin:17-jre-alpine
+            platforms: linux/amd64
+            mcVersion: 1.20.4
+        # JAVA 11:
+          - variant: java11
+            baseImage: adoptopenjdk:11-jre-hotspot
+            platforms: linux/amd64,linux/arm/v7,linux/arm64
+            mcVersion: 1.16.5
+        # JAVA 8: NOTE: Unable to go past 8u312 because of Forge dependencies
+          - variant: java8
+            baseImage: eclipse-temurin:8u312-b07-jre-focal
+            platforms: linux/amd64,linux/arm/v7,linux/arm64
+            mcVersion: 1.12.2
+          - variant: java8-alpine
+            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-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 != '' }}
+      MAIN_VARIANT: java21
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v2.2.0
+        uses: actions/checkout@v4.1.7
+        with:
+          # for build-files step
+          fetch-depth: 0
 
-      - name: Prepare
-        id: prep
-        run: |
-          DOCKER_IMAGE=itzg/minecraft-server
-          VERSION=edge
-          if [[ $GITHUB_REF == refs/tags/* ]]; then
-            VERSION=${GITHUB_REF#refs/tags/}
-          fi
-          if [[ $GITHUB_REF == refs/heads/* ]]; then
-            VERSION=${GITHUB_REF#refs/heads/}
-            if [[ $VERSION == master ]]; then
-              VERSION=latest
-            fi
-          fi
-          TAGS="${DOCKER_IMAGE}:${VERSION//\//-}"
-          echo ::set-output name=tags::${TAGS}
-          echo ::set-output name=cache_from::${TAGS}
-          echo ::set-output name=version::${VERSION//\//-}
-          echo ::set-output name=cache_version::${VERSION//\//-}
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5.5.1
+        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
+            ghcr.io/${{ github.repository_owner }}/minecraft-server
+          tags: |
+            # For the "main" variant, it gets the tag as-is, without suffix
+            type=ref,event=tag,enable=${{ matrix.variant == env.MAIN_VARIANT }}
+            # and each variant (including main one) gets the tag with the variant suffix, such as 2023.1.1-java17
+            type=ref,event=tag,suffix=-${{ matrix.variant }}
+            # for building test/* branch images
+            type=ref,event=branch,suffix=-${{ matrix.variant }},enable=${{ github.ref_name != github.event.repository.default_branch }}
+            # latest repo tag gets a moving 'stable' image tag applied to the main variant
+            type=raw,value=stable,enable=${{ github.ref_type == 'tag' && matrix.variant == env.MAIN_VARIANT }}            
+            # apply the variant as a moving tag for most recent commit per variant
+            type=raw,value=${{ matrix.variant }},enable=${{ github.ref_name == github.event.repository.default_branch }}
+            # for backward compatibility with users referencing java8-multiarch, this will set an extra label on java8
+            type=raw,value=java8-multiarch,enable=${{ matrix.variant == 'java8' && github.ref_name == github.event.repository.default_branch }}
+          # NOTE this identifies which variant will be published as "latest", which isn't
+          # necessarily the newest version of Java
+          flavor: |
+            latest=${{ matrix.variant == env.MAIN_VARIANT && github.ref_name == github.event.repository.default_branch }}
+          labels: |
+            org.opencontainers.image.authors=Geoff Bourne <itzgeoff@gmail.com>
 
       - name: Setup Docker Buildx
-        uses: docker/setup-buildx-action@v1
-
-      - name: Cache Docker layers
-        uses: actions/cache@v2
-        with:
-          path: /tmp/.buildx-cache
-          key: ${{ runner.os }}-buildx-${{ steps.prep.outputs.cache_version }}-${{ github.sha }}
-          restore-keys: |
-            ${{ runner.os }}-buildx-${{ steps.prep.outputs.cache_version }}-
+        uses: docker/setup-buildx-action@v3.3.0
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v1
+        uses: docker/setup-qemu-action@v3.0.0
+
+      - name: Build for test
+        uses: docker/build-push-action@v5.4.0
+        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 }}
+          CF_API_KEY: ${{ secrets.CF_API_KEY }}
+        run: |
+          tests/test.sh
 
       - name: Login to DockerHub
-        uses: docker/login-action@v1
+        uses: docker/login-action@v3.2.0
+        if: env.HAS_IMAGE_REPO_ACCESS
         with:
           username: ${{ secrets.DOCKER_USER }}
           password: ${{ secrets.DOCKER_PASSWORD }}
 
-      - name: Build and push
-        id: docker_build
-        uses: docker/build-push-action@v2
+      - name: Login to GHCR
+        uses: docker/login-action@v3.2.0
+        if: env.HAS_IMAGE_REPO_ACCESS
         with:
-          context: .
-          file: ./Dockerfile
-          platforms: linux/amd64,linux/arm/v7,linux/arm64
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.prep.outputs.tags }}
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ github.token }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v5.4.0
+        if: github.actor == github.repository_owner
+        with:
+          platforms: ${{ matrix.platforms }}
+          push: >
+            ${{ 
+            github.ref_type == 'tag' 
+            || github.ref_name == github.event.repository.default_branch
+            || startsWith(github.ref_name, 'test/')
+            || ( 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
-          cache-from: type=local,src=/tmp/.buildx-cache
-          cache-to: type=local,dest=/tmp/.buildx-cache
-          labels: |
-            org.opencontainers.image.documentation=https://github.com/itzg/docker-minecraft-server
-            org.opencontainers.image.source=https://github.com/itzg/docker-minecraft-server
-            org.opencontainers.image.version=${{ steps.prep.outputs.version }}
-            org.opencontainers.image.revision=${{ github.sha }}
-
-      - name: Image digest
-        run: echo ${{ steps.docker_build.outputs.digest }}
+          labels: ${{ steps.meta.outputs.labels }}
+          # Since some consumers, like Watchtower are broken https://github.com/containrrr/watchtower/discussions/1529
+          # Also refer to https://github.com/docker/build-push-action/releases/tag/v3.3.0
+          provenance: false
+          build-args: |
+            BASE_IMAGE=${{ matrix.baseImage }}
+            BUILD_FILES_REV=${{ steps.build-files-rev.outputs.REV }}
+          cache-from: type=gha,scope=${{ matrix.variant }}
+          cache-to: type=gha,mode=max,scope=${{ matrix.variant }}

.github/workflows/discord.yml

@@ -0,0 +1,42 @@
+name: Discord notifications
+
+on:
+  release:
+    types:
+      - published
+  workflow_run:
+    workflows: ["Build and Publish"]
+    types:
+      - completed
+
+env:
+  DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
+
+jobs:
+  discord:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: on-publish
+        if: github.event_name == 'release' && github.event.action == 'published'
+        uses: SethCohen/github-releases-to-discord@v1.15.0
+        with:
+          webhook_url: ${{ secrets.DISCORD_WEBHOOK }}
+      - name: on-success
+        if: github.event.workflow_run.conclusion == 'success'
+        uses: Ilshidur/action-discord@master
+        with:
+          args: |
+            Github repo: ${{ github.repository }}
+            - Branch: ${{ github.event.workflow_run.head_branch }}
+            - [Link: to Actions](<${{ github.event.workflow_run.html_url }}>)
+            - 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 }}
+            - Branch: ${{ github.event.workflow_run.head_branch }}
+            - [Link: to Actions](<${{ github.event.workflow_run.html_url }}>)
+            - 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/main.yml

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

.github/workflows/pr.yml

@@ -1,16 +0,0 @@
-name: Validate PR
-
-on:
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Run tests
-        run: |
-          tests/test.sh

.github/workflows/stale-check.yml

@@ -0,0 +1,25 @@
+name: Stale Check
+
+on:
+  schedule:
+    - cron: 0 2 * * *
+
+jobs:
+  check:
+    runs-on: ubuntu-22.04
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - name: Process Stale Issues
+        uses: actions/stale@v9
+        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,90 @@
+name: Verify PR
+on:
+  pull_request:
+    branches: [ master ]
+    types: [assigned, opened, synchronize, labeled]
+    paths-ignore:
+      - "*.md"
+      - "docs/**"
+      - "examples/**"
+      - "notes/**"
+      - "docker-compose*.yml"
+      - "mkdocs.yml"
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        variant:
+          - java21
+          - java21-alpine
+          - java17
+          - java8
+        include:
+        # JAVA 21:
+          - variant: java21
+            baseImage: eclipse-temurin:21-jre
+            platforms: linux/amd64,linux/arm64
+            mcVersion: latest
+          - variant: java21-alpine
+            baseImage: eclipse-temurin:21-jre-alpine
+            platforms: linux/amd64,linux/arm64
+            mcVersion: latest
+        # 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.20.4
+          - variant: java8
+            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-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4.1.7
+        with:
+          # for build-files step
+          fetch-depth: 0
+
+      - name: Setup Docker Buildx
+        uses: docker/setup-buildx-action@v3.3.0
+
+      - name: Confirm multi-arch build
+        uses: docker/build-push-action@v5.4.0
+        with:
+          platforms: ${{ matrix.platforms }}
+          # ensure latest base image is used
+          pull: true
+          build-args: |
+            BASE_IMAGE=${{ matrix.baseImage }}
+          cache-from: type=gha,scope=${{ matrix.variant }}
+
+      - name: Build for test
+        uses: docker/build-push-action@v5.4.0
+        with:
+          # Only build single platform since loading multi-arch image into daemon fails with
+          # "docker exporter does not currently support exporting manifest lists"
+          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 }}
+          CF_API_KEY: ${{ secrets.CF_API_KEY }}
+          DEBUG: ${{ runner.debug }}
+        run: |
+          tests/test.sh

.gitignore

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

.readthedocs.yaml

@@ -0,0 +1,14 @@
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+python:
+  install:
+    - requirements: docs/requirements.txt

DEVELOPMENT.md

@@ -1,74 +0,0 @@
-## 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](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-finalSetupWorld` 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](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:
-
-```shell script
-docker build -t mc-dev .
-```
-
-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.
-
-## Multi-base-image variants
-
-Several base-image variants are maintained in order to offer choices in JDK provider and version. The variants are maintained in their respective branches:
-- openj9 
-- openj9-nightly
-- adopt11
-- adopt13
-- multiarch
-
-The [docker-versions-create.sh](docker-versions-create.sh) script is configured with the branches to maintain and is used to merge changes from the master branch into the mulit-base variant branches. The script also manages git tagging the master branch along with the merged branches. So a typical use of the script would be like:
-
-```shell script
-./docker-versions-create.sh -s -t 1.2.0
-```
-
-> Most often the major version will be bumped unless a bug or hotfix needs to be published in which case the patch version should be incremented.
-
-> The build and publishing of those branches and their tags is currently performed within Docker Hub.
-
-## multiarch support
-
-The [multiarch branch](https://github.com/itzg/docker-minecraft-server/tree/multiarch) supports running the image on amd64, arm64, and armv7 (aka RaspberryPi). Unlike the mainline branches, it is based on Ubuntu 18.04 since the openjdk package provided by Ubuntu includes full JIT support on all of the processor types.
-
-The multiarch images are built and published by [a Github action](https://github.com/itzg/docker-minecraft-server/actions?query=workflow%3A%22Build+and+publish+multiarch%22), which [is configured in that branch](https://github.com/itzg/docker-minecraft-server/blob/multiarch/.github/workflows/build-multiarch.yml).
-
-## 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

@@ -1,89 +1,77 @@
-FROM openjdk:8u212-jre-alpine
-
-LABEL org.opencontainers.image.authors="Geoff Bourne <itzgeoff@gmail.com>"
-
-# upgrade all packages since alpine jre8 base image tops out at 8u212
-RUN apk -U --no-cache upgrade
-
-RUN apk add --no-cache -U \
-  openssl \
-  imagemagick \
-  lsof \
-  su-exec \
-  shadow \
-  bash \
-  curl iputils wget \
-  git \
-  jq \
-  mysql-client \
-  tzdata \
-  rsync \
-  nano \
-  sudo \
-  knock \
-  ttf-dejavu
-
-RUN addgroup -g 1000 minecraft \
-  && adduser -Ss /bin/false -u 1000 -G minecraft -h /home/minecraft minecraft \
-  && mkdir -m 777 /data \
-  && chown minecraft:minecraft /data /home/minecraft
-
-COPY 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=linux
-ARG TARGETARCH=amd64
-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.4.7 --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.1.7 --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.5.0 --var app=mc-server-runner --file {{.app}} \
- --from https://github.com/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
-
-RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
- --var version=0.1.1 --var app=maven-metadata-release --file {{.app}} \
- --from https://github.com/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
-
-COPY mcstatus /usr/local/bin
-
-VOLUME ["/data"]
-COPY server.properties /tmp/server.properties
-COPY log4j2.xml /tmp/log4j2.xml
-WORKDIR /data
-
-ENV UID=1000 GID=1000 \
-  JVM_XX_OPTS="-XX:+UseG1GC" MEMORY="1G" \
-  TYPE=VANILLA VERSION=LATEST \
-  ENABLE_RCON=true RCON_PORT=25575 RCON_PASSWORD=minecraft \
-  SERVER_PORT=25565 ONLINE_MODE=TRUE SERVER_NAME="Dedicated Server" \
-  ENABLE_AUTOPAUSE=false AUTOPAUSE_TIMEOUT_EST=3600 AUTOPAUSE_TIMEOUT_KN=120 AUTOPAUSE_TIMEOUT_INIT=600 \
-  AUTOPAUSE_PERIOD=10 AUTOPAUSE_KNOCK_INTERFACE=eth0
-
-COPY start* /
-COPY health.sh /
-ADD files/autopause /autopause
-
-RUN dos2unix /start* && chmod +x /start*
-RUN dos2unix /health.sh && chmod +x /health.sh
-RUN dos2unix /autopause/* && chmod +x /autopause/*.sh
-
-ENTRYPOINT [ "/start" ]
-HEALTHCHECK --start-period=1m CMD /health.sh
+# syntax = docker/dockerfile:1.3
+
+ARG BASE_IMAGE=eclipse-temurin:21-jre
+FROM ${BASE_IMAGE}
+
+# 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 FORCE_INSTALL_PACKAGES=1
+RUN --mount=target=/build,source=build \
+    TARGET=${TARGETARCH}${TARGETVARIANT} /build/run.sh install-packages
+
+RUN --mount=target=/build,source=build \
+    /build/run.sh setup-user
+
+COPY --chmod=644 files/sudoers* /etc/sudoers.d
+
+EXPOSE 25565
+
+ARG APPS_REV=1
+ARG GITHUB_BASEURL=https://github.com
+
+ARG EASY_ADD_VERSION=0.8.6
+ADD ${GITHUB_BASEURL}/itzg/easy-add/releases/download/${EASY_ADD_VERSION}/easy-add_${TARGETOS}_${TARGETARCH}${TARGETVARIANT} /usr/bin/easy-add
+RUN chmod +x /usr/bin/easy-add
+
+ARG RESTIFY_VERSION=1.7.3
+RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
+  --var version=${RESTIFY_VERSION} --var app=restify --file {{.app}} \
+  --from ${GITHUB_BASEURL}/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
+
+ARG RCON_CLI_VERSION=1.6.7
+RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
+  --var version=${RCON_CLI_VERSION} --var app=rcon-cli --file {{.app}} \
+  --from ${GITHUB_BASEURL}/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
+
+ARG MC_MONITOR_VERSION=0.12.12
+RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
+  --var version=${MC_MONITOR_VERSION} --var app=mc-monitor --file {{.app}} \
+  --from ${GITHUB_BASEURL}/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
+
+ARG MC_SERVER_RUNNER_VERSION=1.12.2
+RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
+  --var version=${MC_SERVER_RUNNER_VERSION} --var app=mc-server-runner --file {{.app}} \
+  --from ${GITHUB_BASEURL}/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
+
+ARG MC_HELPER_VERSION=1.39.0
+ARG MC_HELPER_BASE_URL=${GITHUB_BASEURL}/itzg/mc-image-helper/releases/download/${MC_HELPER_VERSION}
+# used for cache busting local copy of mc-image-helper
+ARG MC_HELPER_REV=1
+RUN curl -fsSL ${MC_HELPER_BASE_URL}/mc-image-helper-${MC_HELPER_VERSION}.tgz \
+  | tar -C /usr/share -zxf - \
+  && ln -s /usr/share/mc-image-helper-${MC_HELPER_VERSION}/bin/mc-image-helper /usr/bin
+
+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
+
+COPY --chmod=755 scripts/start* /
+COPY --chmod=755 bin/ /usr/local/bin/
+COPY --chmod=755 bin/mc-health /health.sh
+COPY --chmod=644 files/* /image/
+COPY --chmod=755 files/auto /auto
+
+RUN curl -fsSL -o /image/Log4jPatcher.jar https://github.com/CreeperHost/Log4jPatcher/releases/download/v1.0.1/Log4jPatcher-1.0.1.jar
+
+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 "${SERVER_HOST:-localhost}" --port "${SERVER_PORT:-25565}"
+  exit $?
+fi

bin/mc-send-to-console

@@ -0,0 +1,28 @@
+#!/bin/bash
+. "/start-utils"
+: "${CONSOLE_IN_NAMED_PIPE:=/tmp/minecraft-console-in}"
+
+if isFalse "${CREATE_CONSOLE_IN_PIPE:-false}"; then
+  echo "ERROR: console pipe needs to be enabled by setting CREATE_CONSOLE_IN_PIPE to true"
+fi
+
+
+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/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/alpine/install-packages.sh

@@ -0,0 +1,39 @@
+#!/bin/sh
+
+set -e
+set -o pipefail
+
+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 \
+    tar \
+    zstd \
+    nfs-utils \
+    libpcap \
+    libwebp \
+    libcap
+
+# Patched knockd
+curl -fsSL -o /tmp/knock.tar.gz https://github.com/Metalcape/knock/releases/download/0.8.1/knock-0.8.1-alpine-amd64.tar.gz
+tar -xf /tmp/knock.tar.gz -C /usr/local/ && rm /tmp/knock.tar.gz
+ln -s /usr/local/sbin/knockd /usr/sbin/knockd
+setcap cap_net_raw=ep /usr/local/sbin/knockd
+
+# Set git credentials
+echo -e "[user]\n       name = Minecraft Server on Docker\n     email = server@example.com" >> /etc/gitconfig

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.16/gosu-arm64
+    chmod +x /bin/gosu
+elif [[ $(uname -m) == "x86_64" ]]; then 
+    curl -sL -o /bin/gosu https://github.com/tianon/gosu/releases/download/1.16/gosu-amd64
+    chmod +x /bin/gosu
+else
+    echo "Not supported!"
+    exit 1
+fi  

build/ol/install-packages.sh

@@ -0,0 +1,59 @@
+#!/bin/bash
+
+export TARGET
+
+set -euo pipefail
+
+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 \
+  git-lfs \
+  jq \
+  dos2unix \
+  mysql \
+  procps-ng \
+  tzdata \
+  rsync \
+  nano \
+  unzip \
+  zstd \
+  lbzip2 \
+  libpcap \
+  libwebp \
+  findutils \
+  which
+
+curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.rpm.sh | sudo bash
+dnf update -y
+dnf install -y \
+  git-lfs
+
+bash /build/ol/install-gosu.sh
+
+# Patched knockd
+curl -fsSL -o /tmp/knock.tar.gz https://github.com/Metalcape/knock/releases/download/0.8.1/knock-0.8.1-$TARGET.tar.gz
+tar -xf /tmp/knock.tar.gz -C /usr/local/ && rm /tmp/knock.tar.gz
+ln -s /usr/local/sbin/knockd /usr/sbin/knockd
+setcap cap_net_raw=ep /usr/local/sbin/knockd
+
+# Set git credentials
+echo -e "[user]\n       name = Minecraft Server on Docker\n     email = server@example.com" >> /etc/gitconfig

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,47 @@
+#!/bin/bash
+
+export TARGET
+
+set -euo pipefail
+
+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 \
+  nfs-common \
+  libpcap0.8 \
+  webp
+
+curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh | sudo bash
+apt-get update
+apt-get install -y \
+  git-lfs
+
+apt-get clean
+
+# Patched knockd
+curl -fsSL -o /tmp/knock.tar.gz https://github.com/Metalcape/knock/releases/download/0.8.1/knock-0.8.1-$TARGET.tar.gz
+tar -xf /tmp/knock.tar.gz -C /usr/local/ && rm /tmp/knock.tar.gz
+ln -s /usr/local/sbin/knockd /usr/sbin/knockd
+setcap cap_net_raw=ep /usr/local/sbin/knockd
+find /usr/lib -name 'libpcap.so.0.8' -execdir cp '{}' libpcap.so.1 \;
+
+# Set git credentials
+echo -e "[user]\n	name = Minecraft Server on Docker\n	email = server@example.com" >> /etc/gitconfig

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

docker-compose-mkdocs.yml

@@ -0,0 +1,19 @@
+# This composition can be used to serve up the rendered mkdocs for local authoring.
+#
+# docker compose -f docker-compose-mkdocs.yml -p mkdocs up
+#
+# and then access http://localhost:8000
+
+services:
+  mkdocs:
+    build:
+      context: .
+      dockerfile: docs/Dockerfile
+    volumes:
+      - ./mkdocs.yml:/mkdocs/mkdocs.yml
+      - ./docs:/mkdocs/docs
+    command:
+      - serve
+      - --dev-addr=0.0.0.0:8000
+    ports:
+      - "8000:8000"

docker-compose.yml

@@ -1,16 +1,14 @@
-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: {}
+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: {}

docker-versions-create.sh

@@ -1,124 +0,0 @@
-#!/bin/bash
-#set -x
-# Use this variable to indicate a list of branches that docker hub is watching
-branches_list=('java8' 'java8-multiarch' 'openj9' 'openj9-11' 'adopt11' 'java15' 'multiarch' 'multiarch-latest')
-
-function TrapExit {
-  echo "Checking out back in master"
-  git checkout master
-}
-
-batchMode=false
-
-while getopts "hbt:s" arg
-do
-  case $arg in
-    b)
-      batchMode=true
-      ;;
-    t)
-      tag=${OPTARG}
-      ;;
-    s)
-      tagArgs="-s -m 'Signed during docker-versions-create"
-      ;;
-    h)
-      echo "
-Usage $0 [options]
-
-Options:
-  -b      enable batch mode, which avoids interactive prompts and causes script to fail immediately
-          when any merge fails
-  -t TAG  tag and push the current revision on master with the given tag
-          and apply respective tags to each branch
-  -s      enable signed tags
-  -h      display this help and exit
-"
-      exit
-      ;;
-    *)
-      echo "Unsupported arg $arg"
-      exit 2
-      ;;
-  esac
-done
-
-${batchMode} && echo "Using batch mode"
-
-trap TrapExit EXIT SIGTERM
-
-test -d ./.git || { echo ".git folder was not found. Please start this script from root directory of the project!";
-  exit 1; }
-
-# Making sure we are in master
-git checkout master
-git pull --all || { echo "Can't pull the repo!"; \
-  exit 1; }
-if [[ $tag ]]; then
-  git tag $tag
-  git push origin $tag
-fi
-
-git_branches=$(git branch -a)
-
-for branch in "${branches_list[@]}"; do
-  if [[ "$git_branches" != *"$branch"* ]]; then
-    echo "Can't update $branch because I can't find it in the list of branches."
-    exit 1
-  else
-    echo "Branch $branch found. Working with it."
-    git checkout "$branch" || { echo "Can't checkout into the branch. Don't know the cause."; \
-      exit 1; }
-    proceed='False'
-    while [[ "$proceed" == "False" ]]; do
-      # Ensure local branch is aligned with remote since docker-versions-create may have been run elsewhere
-      git pull
-
-      if git merge -m 'Auto-merging via docker-versions-create' master; then
-        proceed="True"
-        echo "Branch $branch updated to current master successfully"
-        # pushing changes to remote for this branch
-        git commit -m "Auto merge branch with master" -a
-        # push may fail if remote doesn't have this branch yet. In this case - sending branch
-        git push || git push -u origin "$branch" || { echo "Can't push changes to the origin."; exit 1; }
-        if [[ $tag ]]; then
-          git tag "$tag-$branch"
-          git push origin "$tag-$branch"
-        fi
-      elif ${batchMode}; then
-        status=$?
-        echo "Git merge failed in batch mode"
-        exit ${status}
-        # and trap exit gets us back to master
-      else
-        cat<<EOL
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-Master merge in the branch $branch encountered an error!
-You may try to fix the error and merge again. (Commit changes)
-Or skip this branch merge completely.
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-EOL
-        printf "Should we try again? (y):"
-        read -r answer
-        if [[ "$answer" == '' ]] || [[ "$answer" == 'y' ]] || [[ "$answer" == 'Y' ]]; then
-          # If you use non-local editor or files are changed in repo
-          cat <<EOL
-
-The following commands may encounter an error!
-This is completely fine if the changes were made locally and remote branch doesn't know about them.
-
-EOL
-          # Updating branch from remote before trying again
-          git checkout master
-          git fetch --all
-          git pull -a
-          git checkout "$branch"
-          continue
-        else
-          break
-        fi
-      fi
-    done
-  fi
-
-done

docs/Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.8
+
+RUN pip install --upgrade pip
+
+WORKDIR /mkdocs
+
+RUN --mount=target=/build/requirements.txt,source=docs/requirements.txt \
+    pip install -r /build/requirements.txt
+
+ENTRYPOINT ["mkdocs"]

docs/commands.md

@@ -0,0 +1,61 @@
+---
+title: Sending commands
+---
+
+[RCON](http://wiki.vg/RCON) is enabled by default, so you can `exec` into the container to
+access the Minecraft server console:
+
+```
+docker exec -i mc rcon-cli
+```
+
+Note: The `-i` is required for interactive use of rcon-cli.
+
+To run a simple, one-shot command, such as stopping a Minecraft server, pass the command as arguments to `rcon-cli`, such as:
+
+```
+docker exec mc rcon-cli stop
+```
+
+_The `-i` is not needed in this case._
+
+## When RCON is disabled
+
+If rcon is disabled you can send commands by passing them as arguments to the packaged `mc-send-to-console` script after setting the env var `CREATE_CONSOLE_IN_PIPE` to "true". For example, a player can be op'ed in the container `mc` with: 
+
+```shell
+docker exec mc mc-send-to-console op player
+            |                     |
+            +- container name     +- Minecraft commands start here
+```
+
+## Enabling interactive console
+
+In order to attach and interact with the Minecraft server make sure to enable TTY and keep stdin open.
+
+!!! example
+
+    With `docker run` use the `-it` arguments:
+
+    ```shell
+    docker run -d -it -p 25565:25565 --name mc itzg/minecraft-server
+    ```
+
+    or with a compose file:
+
+    ```yaml
+    services:
+      minecraft:
+        stdin_open: true
+        tty: true
+    ```
+
+With that you can attach and interact at any time using
+
+    docker attach mc
+
+and then Control-p Control-q to **detach**.
+
+!!! info "RCON is required for fully interactive, color console"
+
+    RCON must be enabled, which is the default, in order to use a fully interactive console with auto-completion and colorized log output. 

docs/configuration/auto-rcon-commands.md

@@ -0,0 +1,71 @@
+
+# Auto-execute RCON commands
+
+RCON commands can be configured to execute when the server starts, a client connects, or a client disconnects.
+
+!!! note
+
+    When declaring several commands within a compose file environment variable, it's easiest to use YAML's `|-` [block style indicator](https://yaml-multiline.info/).
+
+**On Server Start:**
+
+``` yaml
+      RCON_CMDS_STARTUP:  |-
+        gamerule doFireTick false
+        pregen start 200
+```
+
+**On Client Connection:**
+
+``` yaml
+      RCON_CMDS_ON_CONNECT:  |-
+        team join New @a[team=]
+```
+
+**Note:**
+* On client connect we only know there was a connection, and not who connected. RCON commands will need to be used for that.
+
+**On Client Disconnect:**
+
+``` yaml
+      RCON_CMDS_ON_DISCONNECT:  |-
+        gamerule doFireTick true
+```
+
+**On First Client Connect**
+
+``` yaml
+      RCON_CMDS_FIRST_CONNECT: |-
+        pregen stop
+```
+
+**On Last Client Disconnect**
+
+``` yaml
+      RCON_CMDS_LAST_DISCONNECT: |-
+        kill @e[type=minecraft:boat]
+        pregen start 200
+
+```
+
+**Example of rules for new players**
+
+Uses team NEW and team OLD to track players on the server. So move player with no team to NEW, run a command, move them to team OLD.
+[Reference Article](https://www.minecraftforum.net/forums/minecraft-java-edition/redstone-discussion-and/2213523-detect-players-first-join)
+
+``` yaml
+      RCON_CMDS_STARTUP:  |-
+        /pregen start 200
+        /gamerule doFireTick false
+        /team add New
+        /team add Old
+      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: |-
+        /pregen stop
+      RCON_CMDS_LAST_DISCONNECT: |-
+        /kill @e[type=minecraft:boat]
+        /pregen start 200
+```

docs/configuration/interpolating.md

@@ -0,0 +1,145 @@
+---
+title: Modifying config files
+---
+
+## Replacing variables inside configs
+
+Sometimes you have mods or plugins that require configuration information that is only available at runtime.
+For example if you need to configure a plugin to connect to a database,
+you don't want to include this information in your Git repository or Docker image.
+Or maybe you have some runtime information like the server name that needs to be set
+in your config files after the container starts.
+
+For those cases there is the option to replace defined variables inside your configs
+with environment variables defined at container runtime.
+
+When the environment variable `REPLACE_ENV_IN_PLACE` is set to `true` (the default), the startup script will go through all files inside the container's `/data` path and replace variables that match the container's environment variables. Variables can instead (or in addition to) be replaced in files sync'ed from `/plugins`, `/mods`, and `/config` by setting `REPLACE_ENV_DURING_SYNC` to `true` (defaults to `false`).
+
+Variables that you want to replace need to be declared inside curly brackets and prefixed with a dollar sign, such as  `${CFG_YOUR_VARIABLE}`, which is same as many scripting languages.
+
+You can also change `REPLACE_ENV_VARIABLE_PREFIX`, which defaults to "CFG_", to limit which environment variables are allowed to be used. For example, with "CFG_" as the prefix, the variable `${CFG_DB_HOST}` would be substituted, but not `${DB_HOST}`. The prefix can be set to an empty string to allow for matching any variable name.
+
+If you want to use a file's content for value, such as when using secrets mounted as files, declare the placeholder named like normal in the file and declare an environment variable named the same but with the suffix `_FILE`.
+
+For example, a `my.cnf` file could contain:
+
+```
+[client]
+password = ${CFG_DB_PASSWORD}
+```
+
+...a secret declared in the compose file with:
+```yaml
+secrets:
+  db_password:
+    external: true
+```
+
+...and finally the environment variable would be named with a `_FILE` suffix and point to the mounted secret:
+```yaml
+    environment:
+      CFG_DB_PASSWORD_FILE: /run/secrets/db_password
+```
+
+Variables will be replaced in files with the following extensions:
+`.yml`, `.yaml`, `.txt`, `.cfg`, `.conf`, `.properties`.
+
+Specific files can be excluded by listing their name (without path) in the variable `REPLACE_ENV_VARIABLES_EXCLUDES`.
+
+Paths can be excluded by listing them in the variable `REPLACE_ENV_VARIABLES_EXCLUDE_PATHS`. Path
+excludes are recursive. Here is an example:
+```
+REPLACE_ENV_VARIABLES_EXCLUDE_PATHS="/data/plugins/Essentials/userdata /data/plugins/MyPlugin"
+```
+
+Here is a full example where we want to replace values inside a `database.yml`.
+
+```yml
+
+---
+database:
+  host: ${CFG_DB_HOST}
+  name: ${CFG_DB_NAME}
+  password: ${CFG_DB_PASSWORD}
+```
+
+This is how your `docker-compose.yml` file could look like:
+
+```yml
+# Other docker-compose examples in /examples
+
+services:
+  minecraft:
+    image: itzg/minecraft-server
+    ports:
+      - "25565:25565"
+    volumes:
+      - "mc:/data"
+    environment:
+      EULA: "TRUE"
+      ENABLE_RCON: "true"
+      RCON_PASSWORD: "testing"
+      RCON_PORT: 28016
+      # enable env variable replacement
+      REPLACE_ENV_VARIABLES: "TRUE"
+      # define an optional prefix for your env variables you want to replace
+      ENV_VARIABLE_PREFIX: "CFG_"
+      # and here are the actual variables
+      CFG_DB_HOST: "http://localhost:3306"
+      CFG_DB_NAME: "minecraft"
+      CFG_DB_PASSWORD_FILE: "/run/secrets/db_password"
+
+volumes:
+  mc:
+  rcon:
+
+secrets:
+  db_password:
+    file: ./db_password
+```
+
+## Patching existing files
+
+JSON path based patches can be applied to one or more existing files by setting the variable `PATCH_DEFINITIONS` to the path of a directory that contains one or more [patch definition json files](https://github.com/itzg/mc-image-helper#patchdefinition) or a [patch set json file](https://github.com/itzg/mc-image-helper#patchset). 
+
+The `file` and `value` fields of the patch definitions may contain `${...}` variable placeholders. The allowed environment variables in placeholders can be restricted by setting `REPLACE_ENV_VARIABLE_PREFIX`, which defaults to "CFG_".
+
+The following example shows a patch-set file where various fields in the `paper.yaml` configuration file can be modified and added:
+
+```json
+{
+  "patches": [
+    {
+      "file": "/data/paper.yml",
+      "ops": [
+        {
+          "$set": {
+            "path": "$.verbose",
+            "value": true
+          }
+        },
+        {
+          "$set": {
+            "path": "$.settings['velocity-support'].enabled",
+            "value": "${CFG_VELOCITY_ENABLED}",
+            "value-type": "bool"
+          }
+        },
+        {
+          "$put": {
+            "path": "$.settings",
+            "key": "my-test-setting",
+            "value": "testing"
+          }
+        }
+      ]
+    }
+  ]
+}
+```
+
+Supports the file formats:
+- JSON
+- JSON5
+- Yaml
+- TOML, but processed output is not pretty

docs/configuration/jvm-options.md

@@ -0,0 +1,132 @@
+# JVM Options
+
+## Memory Limit
+
+By default, the image declares an initial and maximum Java memory-heap limit of 1 GB. There are several ways to adjust the memory settings:
+
+- `MEMORY`: "1G" by default, can be used to adjust both initial (`Xms`) and max (`Xmx`) memory heap settings of the JVM
+- `INIT_MEMORY`: independently sets the initial heap size
+- `MAX_MEMORY`: independently sets the max heap size
+
+The values of all three are passed directly to the JVM and support format/units as `<size>[g|G|m|M|k|K]`. 
+
+!!! example "Using docker run"
+ 
+    ```
+        -e MEMORY=2G
+    ```
+
+    or to use init and max memory:
+
+    ```
+        -e INIT_MEMORY=1G -e MAX_MEMORY=4G
+    ```
+
+!!! example "Using compose file"
+     
+    ```
+        environment:
+          MEMORY: 2G
+    ```
+
+    or to use init and max memory:
+
+    ```
+        environment:
+          INIT_MEMORY: 1G
+          MAX_MEMORY: 4G
+    ```
+
+To let the JVM calculate the heap size from the container declared memory limit, unset `MEMORY` with an empty value, such as `-e MEMORY=""`. By default, the JVM will use 25% of the container memory limit as the heap limit; however, as an example the following would tell the JVM to use 75% of the container limit of 4GB of memory:
+
+!!! example "MaxRAMPercentage using compose file"
+
+    ```
+        environment:
+          MEMORY: ""
+          JVM_XX_OPTS: "-XX:MaxRAMPercentage=75"
+        deploy:
+          limits:
+            memory: 4G  
+    ```
+
+!!! important
+    The settings above only set the Java **heap** limits. Memory resource requests and limits on the overall container should also account for non-heap memory usage. An extra 25% is [a general best practice](https://dzone.com/articles/best-practices-java-memory-arguments-for-container).
+
+## Extra JVM Options
+
+General JVM options can be passed to the Minecraft Server invocation by passing a `JVM_OPTS`
+environment variable. The JVM requires `-XX` options to precede `-X` options, so those can be declared in `JVM_XX_OPTS`. Both variables are space-delimited, raw JVM arguments.
+
+```
+docker run ... -e JVM_OPTS="-someJVMOption someJVMOptionValue" ...
+```
+
+**NOTE** When declaring `JVM_OPTS` in a compose file's `environment` section with list syntax, **do not** include the quotes:
+
+```yaml
+    environment:
+      - EULA=true
+      - JVM_OPTS=-someJVMOption someJVMOptionValue 
+```
+
+Using object syntax is recommended and more intuitive:
+
+```yaml
+    environment:
+      EULA: "true"
+      JVM_OPTS: "-someJVMOption someJVMOptionValue"
+# or
+#     JVM_OPTS: -someJVMOption someJVMOptionValue
+```
+
+As a shorthand for passing several system properties as `-D` arguments, you can instead pass a comma separated list of `name=value` or `name:value` pairs with `JVM_DD_OPTS`. (The colon syntax is provided for management platforms like Plesk that don't allow `=` inside a value.)
+
+For example, instead of passing
+
+```yaml
+  JVM_OPTS: -Dfml.queryResult=confirm -Dname=value
+```
+
+you can use
+
+```yaml
+  JVM_DD_OPTS: fml.queryResult=confirm,name=value
+```
+
+## Enable Remote JMX for Profiling
+
+To enable remote JMX, such as for profiling with VisualVM or JMC, set the environment variable `ENABLE_JMX` to "true", set `JMX_HOST` to the IP/host running the Docker container, and add a port forwarding of TCP port 7091, such as:
+
+!!! example
+
+    With `docker run`
+
+    ```
+    -e ENABLE_JMX=true -e JMX_HOST=$HOSTNAME -p 7091:7091
+    ```
+
+If needing to map to a different port, then also set the environment variable `JMX_PORT` to the desired host port.
+
+!!! example
+
+    With a compose file:
+    
+    ```yaml
+    environment:
+      ENABLE_JMX: true
+      JMX_HOST: ${HOSTNAME}
+      JMX_PORT: "7092"
+    ports:
+      - "7092:7092"
+    ```
+
+## Enable Aikar's Flags
+
+[Aikar has done some research](https://aikar.co/2018/07/02/tuning-the-jvm-g1gc-garbage-collector-flags-for-minecraft/) into finding the optimal JVM flags for GC tuning, which becomes more important as more users are connected concurrently. [PaperMC also has an explanation](https://docs.papermc.io/paper/aikars-flags) of what the JVM flags are doing.
+
+The set of flags documented there can be added using
+
+    -e USE_AIKAR_FLAGS=true
+
+When `MEMORY` is greater than or equal to 12G, then the Aikar flags will be adjusted according to the article.

docs/configuration/misc-options.md

@@ -0,0 +1,156 @@
+
+## Running with a custom server JAR
+
+If you would like to run a custom server JAR, set `-e TYPE=CUSTOM` and pass the custom server
+JAR via `CUSTOM_SERVER`. It can either be a URL or a container path to an existing JAR file.
+
+If it is a URL, it will only be downloaded into the `/data` directory if it wasn't already. As
+such, if you need to upgrade or re-download the JAR, then you will need to stop the container,
+remove the file from the container's `/data` directory, and start again.
+
+## Force re-download of the server file
+
+For VANILLA, FORGE, BUKKIT, SPIGOT, PAPER, CURSEFORGE, SPONGEVANILLA server types, set
+`$FORCE_REDOWNLOAD` to some value (e.g. 'true) to force a re-download of the server file for
+the particular server type. by adding a `-e FORCE_REDOWNLOAD=true` to your command-line.
+
+For example, with PaperSpigot, it would look something like this:
+
+```
+docker run -d -v /path/on/host:/data \
+    -e TYPE=PAPER -e FORCE_REDOWNLOAD=true \
+    -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
+```
+
+## Running as alternate user/group ID
+
+By default, the container will switch to user ID 1000 and group ID 1000;
+however, you can override those values by setting `UID` and/or `GID` as environmental entries, during the `docker run` command.
+
+    -e UID=1234
+    -e GID=1234
+
+The container will also skip user switching if the `--user`/`-u` argument
+is passed to `docker run`.
+
+## Extra Arguments
+
+Arguments that would usually be passed to the jar file (those which are written after the filename) can be passed via the `EXTRA_ARGS` environment variable.
+
+See [Custom worlds directory path](../misc/world-data.md#custom-worlds-directory-path) for an example.
+
+## Interactive and Color Console
+
+When RCON is enabled, which is the default, and [TTY](https://docs.docker.com/compose/compose-file/05-services/#tty) is enabled on the container, then some server types will output colorized logs and provide a fully interactive console. To access the interactive console, use [`docker attach`](https://docs.docker.com/engine/reference/commandline/container_attach/) (not `exec`). When finished, make sure to use the sequence Control-P, Control-Q to detach without stopping the container.
+
+If this behavior interferes with the log content, then disable TTY or remove the setting entirely since the default is disabled. In a compose file, set the service's `tty` parameter to `false`. On the `docker run` command-line remove the `-t` argument.
+
+## Server Shutdown Options
+
+To allow time for players to finish what they're doing during a graceful server shutdown, set `STOP_SERVER_ANNOUNCE_DELAY` to a number of seconds to delay after an announcement is posted by the server.
+
+!!! warning "Increase stop grace period"
+
+    The Docker stop grace period must be increased to a value longer than the announce delay. The value to use that is longer than announce delay will vary based upon the amount of time it takes for final world data saving. If the container exits with exit code 137, then that indicates a longer grace period is needed. 
+    
+    The grace period can be increased using [the -t option on docker-compose down](https://docs.docker.com/compose/reference/down/) or set the [stop_grace_period](https://docs.docker.com/compose/compose-file/05-services/#stop_grace_period) in the compose file.
+
+## Configuration Options for Minecraft Server Health Monitoring
+
+The image tags include specific variables to simplify configuration for monitoring the health of a Minecraft server:
+
+- `-e SERVER_HOST=localhost` : This variable sets the host address of the Minecraft server to be monitored. By default, it is set to `localhost`, but you can replace it with the actual hostname or IP address of your Minecraft server.
+
+- `-e SERVER_PORT=25565` : This variable sets the port number on which the Minecraft server is running. By default, Minecraft servers run on port 25565, but if your server is configured to use a different port, you should replace `25565` with the correct port number. This helps the monitoring system to accurately check the health status of the Minecraft server on the specified port.
+
+## OpenJ9 Specific Options
+
+The openj9 image tags include specific variables to simplify configuration:
+
+- `-e TUNE_VIRTUALIZED=TRUE` : enables the option to
+  [optimize for virtualized environments](https://www.eclipse.org/openj9/docs/xtunevirtualized/)
+- `-e TUNE_NURSERY_SIZES=TRUE` : configures nursery sizes where the initial size is 50%
+  of the `MAX_MEMORY` and the max size is 80%.
+
+## Enabling rolling logs
+
+By default the vanilla log file will grow without limit. The logger can be reconfigured to use a rolling log files strategy by using:
+
+```
+  -e ENABLE_ROLLING_LOGS=true
+```
+
+> **NOTE** this will interfere with interactive/color consoles [as described in the section above](#interactive-and-color-console)
+
+## Timezone Configuration
+
+You can configure the timezone to match yours by setting the `TZ` environment variable:
+
+        -e TZ=Europe/London
+
+such as:
+
+        docker run -d -it -e TZ=Europe/London -p 25565:25565 --name mc itzg/minecraft-server
+
+Or mounting `/etc/timezone` as readonly (not supported on Windows):
+
+        -v /etc/timezone:/etc/timezone:ro
+
+such as:
+
+        docker run -d -it -v /etc/timezone:/etc/timezone:ro -p 25565:25565 --name mc itzg/minecraft-server
+
+## HTTP Proxy
+
+You may configure the use of an HTTP/HTTPS proxy by passing the proxy's URL via the `PROXY`
+environment variable. In [the example compose file](https://github.com/itzg/docker-minecraft-server/blob/master/examples/docker-compose-proxied.yml) it references
+a companion squid proxy by setting the equivalent of
+
+    -e PROXY=proxy:3128
+
+## Using "noconsole" option
+
+Some older versions (pre-1.14) of Spigot required `--noconsole` to be passed when detaching stdin, which can be done by setting `-e CONSOLE=FALSE`.
+
+## Explicitly disable GUI
+
+Some older servers get confused and think that the GUI interface is enabled. You can explicitly
+disable that by passing `-e GUI=FALSE`.
+
+## Stop Duration
+
+When the container is signalled to stop, the Minecraft process wrapper will attempt to send a "stop" command via RCON or console and waits for the process to gracefully finish. By default it waits 60 seconds, but that duration can be configured by setting the environment variable `STOP_DURATION` to the number of seconds.
+
+## Setup only
+
+If you are using a host-attached data directory, then you can have the image setup the Minecraft server files and stop prior to launching the server process by setting `SETUP_ONLY` to `true`. 
+    
+## Enable Flare Flags
+    
+To enable the JVM flags required to fully support the [Flare profiling suite](https://blog.airplane.gg/flare), set the following variable:
+    
+    -e USE_FLARE_FLAGS=true
+    
+Flare is built-in to Pufferfish/Purpur, and is available in [plugin form](https://github.com/TECHNOVE/FlarePlugin) for other server types.
+
+## Enable support for optimized SIMD operations
+
+To enable support for optimized SIMD operations, the JVM flag can be set with the following variable:
+
+    -e USE_SIMD_FLAGS=true
+
+SIMD optimized operations are supported by Pufferfish and Purpur.
+
+## Enable timestamps in init logs
+
+Before the container starts the Minecraft Server its output is prefixed with `[init]`, such as
+
+```
+[init] Starting the Minecraft server...
+```
+
+To also include the timestamp with each log, set `LOG_TIMESTAMP` to "true". The log output will then look like:
+
+```
+[init] 2022-02-05 16:58:33+00:00 Starting the Minecraft server...
+```

docs/configuration/server-properties.md

@@ -0,0 +1,498 @@
+In order to unify management of the Minecraft server container, all of the [`server.properties`](https://minecraft.wiki/w/Server.properties) entries can be managed by the environment variables described in the sections below. Some of the mappings provide additional functionality above and beyond the properties file.
+
+If you prefer to manually manage the `server.properties` file, set `OVERRIDE_SERVER_PROPERTIES` to "false". Similarly, you can entirely skip the startup script's creation of `server.properties` by setting `SKIP_SERVER_PROPERTIES` to "true".
+
+!!! note
+  
+    To clear a server property, set the variable to an empty string, such as `-e RESOURCE_PACK=""`. An unset variable is ignored and the existing server property is left unchanged.
+
+To see what `server.properties` will get used by the server, set the environment variable `DUMP_SERVER_PROPERTIES` to "true" and the contents of `server.properties` will get output before the server starts.
+
+## Placeholders
+
+When declaring a server properties via container environment variables, those values may contain placeholders that are processed when the `server.properties` file is updated. 
+
+The syntax of placeholders is DOS-style, `%VAR%`, to avoid being processed by Docker or the shell and the following options are available:
+
+`%VAR%` or `%env:VAR%`
+
+: Replaced with the resolved value or the environment variable `VAR`
+
+`%date:FMT%`
+
+: Formats the current date/time with the given `FMT` string processed by [Java's DateTimeFormatter](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/format/DateTimeFormatter.html).
+
+Any declared or resolved environment variable may be referenced, such as `VERSION` and `TYPE`. Additionally, [Modrinth](../types-and-platforms/mod-platforms/modrinth-modpacks.md) and [Auto CurseForge](../types-and-platforms/mod-platforms/auto-curseforge.md) modpacks will expose the environment variables `MODPACK_NAME` and `MODPACK_VERSION`. The originally declared version, such as "LATEST" or "SNAPSHOT", is available in the variable `DECLARED_VERSION` 
+
+!!! example
+
+    As a compose file environment entry:
+
+    ```yaml
+        MOTD: Running %MODPACK_NAME% version %env:MODPACK_VERSION%
+        LEVEL: world-%date:yyyy-MM-dd%
+    ```
+
+!!! warning
+
+    Placeholders are not supported when manually managing `server.properties`
+
+## Properties
+
+### Message of the Day
+
+The message of the day, shown below each server entry in the client UI, can be changed with the `MOTD` environment variable or a default is computed from the server type and version, such as
+
+    A Paper Minecraft Server powered by Docker
+
+That way you can easily differentiate between several server types you may have started.
+
+The section symbol (§) and other unicode characters are automatically converted to allow [formatting codes](https://minecraft.wiki/w/Formatting_codes) to be used consistently with all server versions. For Minecraft versions less than 1.20, unicode characters in `server.properties` will be escaped as `\uXXXX`, by default. That behavior can be altered by setting `SERVER_PROPERTIES_ESCAPE_UNICODE` to "true" or "false".
+
+!!! example
+
+    With `docker run`
+    
+         -e MOTD="A §l§cMinecraft§r §nserver"
+    
+    or within a compose file
+    
+        environment:
+          MOTD: "A §l§cMinecraft§r §nserver"
+
+    renders
+    
+    ![](../img/motd-example.png)
+
+To produce a multi-line MOTD, embed a newline character as `\n` in the string, such as the following example.
+
+!!! example "Multi-line MOTD"
+
+    With `docker run`
+    
+    ```
+    -e MOTD="Line one\nLine two"
+    ```
+    
+    or within a compose file
+    
+    ```yaml
+          MOTD: |
+            line one
+            line two
+    # or
+    #      MOTD: "line one\nline two"
+    ```
+
+!!! tip
+
+    You can also embed configured and resolved environment variables using [placeholders](#placeholders).
+
+### Difficulty
+
+The difficulty level (default: `easy`) can be set like:
+
+```
+docker run -d -e DIFFICULTY=hard ...
+```
+
+Valid values are: `peaceful`, `easy`, `normal`, and `hard`, and an
+error message will be output in the logs if it's not one of these
+values.
+
+Refer to [the Minecraft wiki](https://minecraft.wiki/w/Difficulty)
+
+### Whitelist Players
+
+!!! warning "For public servers" 
+    
+    It is very important to consider setting a whitelist of expected players.
+
+To whitelist players for your Minecraft server, you can:  
+
+- Provide a list of usernames and/or UUIDs separated by commas or newlines via the `WHITELIST` environment variable
+- Provide the URL or container path to a whitelist file via `WHITELIST_FILE` that will be retrieved/copied into the standard location
+
+!!! example 
+
+    In a compose file, a text block can be used to improve maintainability, such as
+
+    ```yaml
+          WHITELIST: |
+            user1
+            user2
+            user3
+    ```
+
+When either is set, [whitelisting of connecting users](https://minecraft.wiki/w/Server.properties#white-list) is enabled.
+
+To change the behavior when the whitelist file already exists, set the variable `EXISTING_WHITELIST_FILE` to one of the following options:
+
+`SKIP` (default)
+: Skip processing of the whitelist file when one is already present. This is the same as setting the legacy variable `OVERRIDE_WHITELIST` to "false".
+
+`SYNCHRONIZE`
+: Synchronize the list of users in the file with the `WHITELIST` or `WHITELIST_FILE` provided. When using both, `WHITELIST` will take precedence. This is the same as setting the legacy variable `OVERRIDE_WHITELIST` to "true".
+
+`MERGE`
+: Merge the list of users from `WHITELIST` into the existing file. `WHITELIST_FILE` cannot be used with this option.
+
+`SYNC_FILE_MERGE_LIST`
+: When `WHITELIST_FILE` is provided it will overwrite an existing whitelist file. Also, if `WHITELIST` is provided, then those users will be merged into the newly copied file.
+
+!!! note 
+
+    For versions prior to 1.7.3, `white-list.txt` will be maintained instead. Only usernames are supported for those versions.
+
+To [enforce the whitelist changes immediately](https://minecraft.wiki/w/Server.properties#enforce-whitelist) when whitelist commands are used , set `ENFORCE_WHITELIST` to "true". If managing the whitelist file manually, `ENABLE_WHITELIST` can be set to "true" to set the `white-list` property.
+
+!!! tip "Changing user API provider"
+
+    The usernames provided for whitelist and ops processing are resolved using either [PlayerDB](https://playerdb.co/) or [Mojang's API](https://wiki.vg/Mojang_API#Username_to_UUID). The default uses PlayerDB, but can be changed by setting the environment variable `USER_API_PROVIDER` to "mojang". Sometimes one or the other service can become overloaded, which is why there is the ability to switch providers.
+
+
+### Op/Administrator Players
+
+Similar to the whitelist, users can be provisioned as operators (aka administrators) to your Minecraft server by
+
+- Providing a list of usernames and/or UUIDs separated by commas or newlines via the `OPS` environment variable
+- Providing the URL or container path to an ops file via `OPS_FILE` that will be retrieved/copied into the standard location
+
+!!! example
+
+    In a compose file, a text block can be used to improve maintainability, such as
+
+    ```yaml
+          OPS: |
+            user1
+            user2
+            user3
+    ```
+
+To change the behavior when the ops file already exists, set the variable `EXISTING_OPS_FILE` to one of the following options:
+
+`SKIP` (default)
+: Skip processing of the ops file when one is already present. This is the same as setting the legacy variable `OVERRIDE_OPS` to "false".
+
+`SYNCHRONIZE`
+: Synchronize the list of users in the file with the `OPS` or `OPS_FILE` provided. When using both, `OPS` will take precedence. The `level` and `bypassesPlayerLimit` will be retained from previous entries. This is the same as setting the legacy variable `OVERRIDE_OPS` to "true".
+
+`MERGE`
+: Merge the list of users from `OPS` into the existing file. `OPS_FILE` cannot be used with this option.
+
+`SYNC_FILE_MERGE_LIST`
+: When `OPS_FILE` is provided it will overwrite an existing ops file. Also, if `OPS` is provided, then those users will be merged into the newly copied file.
+
+!!! note
+
+    For versions prior to 1.7.3, `ops.txt` will be maintained instead. Only usernames are supported for those versions.
+
+### Enable/disable initial selection of datapacks
+
+New to [22W42A](https://www.minecraft.net/en-us/article/minecraft-snapshot-22w42a), datapacks with feature flags can be controlled before initial world creation by setting these to a comma separated list of packs:
+
+- `INITIAL_ENABLED_PACKS`
+  such as "update_1_20,bundle"
+- `INITIAL_DISABLED_PACKS`
+
+### Server icon
+
+A server icon can be configured using the `ICON` variable. The image will be automatically
+downloaded, scaled, and converted from any other image format:
+
+    docker run -d -e ICON=http://..../some/image.png ...
+
+The server icon which has been set doesn't get overridden by default. It can be changed and overridden by setting `OVERRIDE_ICON` to `TRUE`.
+
+    docker run -d -e ICON=http://..../some/other/image.png -e OVERRIDE_ICON=TRUE...
+
+### RCON
+
+RCON is **enabled by default** to allow for graceful shut down the server and coordination of save state during backups. RCON can be disabled by setting `ENABLE_RCON` to "false".
+
+!!! warning
+
+    Disabling RCON will remove and limit some features, such as interactive and color console support.
+
+The default password is randomly generated on each startup; however, a specific one can be set with `RCON_PASSWORD`.
+
+**DO NOT MAP THE RCON PORT EXTERNALLY** unless you are aware of all the consequences and have set a **secure password** with `RCON_PASSWORD`. 
+
+!!! info 
+
+    Mapping ports (`-p` command line or `ports` in compose) outside the container and docker networking needs to be a purposeful choice. Most production Docker deployments do not need any of the Minecraft ports mapped externally from the server itself.
+
+By default, the server listens for RCON on port 25575 within the container. It can be changed with `RCON_PORT` but only do this if you have a very good reason. **DO NOT change `rcon.port` via `server.properties`** or integrations will break.
+
+### Query
+
+Enabling this will enable the gamespy query protocol.
+By default the query port will be `25565` (UDP) but can easily be changed with the `QUERY_PORT` variable.
+
+    docker run -d -e ENABLE_QUERY=true
+
+### Max players
+
+By default max players is 20, you can increase this with the `MAX_PLAYERS` variable.
+
+    docker run -d -e MAX_PLAYERS=50
+
+### Max world size
+
+This sets the maximum possible size in blocks, expressed as a radius, that the world border can obtain.
+
+    docker run -d -e MAX_WORLD_SIZE=10000
+
+### Allow Nether
+
+Allows players to travel to the Nether.
+
+    docker run -d -e ALLOW_NETHER=true
+
+### Announce Player Achievements
+
+Allows server to announce when a player gets an achievement.
+
+    docker run -d -e ANNOUNCE_PLAYER_ACHIEVEMENTS=true
+
+### Enable Command Block
+
+Enables command blocks
+
+     docker run -d -e ENABLE_COMMAND_BLOCK=true
+
+### Force Gamemode
+
+Force players to join in the default game mode.
+
+- false - Players will join in the gamemode they left in.
+- true - Players will always join in the default gamemode.
+
+  `docker run -d -e FORCE_GAMEMODE=false`
+
+### Generate Structures
+
+Defines whether structures (such as villages) will be generated.
+
+- false - Structures will not be generated in new chunks.
+- true - Structures will be generated in new chunks.
+
+  `docker run -d -e GENERATE_STRUCTURES=true`
+
+### Hardcore
+
+If set to true, players will be set to spectator mode if they die.
+
+    docker run -d -e HARDCORE=false
+
+### Snooper
+
+If set to false, the server will not send data to snoop.minecraft.net server.
+
+    docker run -d -e SNOOPER_ENABLED=false
+
+### Max Build Height
+
+The maximum height in which building is allowed.
+Terrain may still naturally generate above a low height limit.
+
+    docker run -d -e MAX_BUILD_HEIGHT=256
+
+### Max Tick Time
+
+The maximum number of milliseconds a single tick may take before the server watchdog stops the server with the message, A single server tick took 60.00 seconds (should be max 0.05); Considering it to be crashed, server will forcibly shutdown. Once this criteria is met, it calls System.exit(1).
+Setting this to -1 will disable watchdog entirely
+
+    docker run -d -e MAX_TICK_TIME=60000
+
+### Spawn Animals
+
+Determines if animals will be able to spawn.
+
+    docker run -d -e SPAWN_ANIMALS=true
+
+### Spawn Monsters
+
+Determines if monsters will be spawned.
+
+    docker run -d -e SPAWN_MONSTERS=true
+
+### Spawn NPCs
+
+Determines if villagers will be spawned.
+
+    docker run -d -e SPAWN_NPCS=true
+
+### Set spawn protection
+
+Sets the area that non-ops can not edit (0 to disable)
+
+    docker run -d -e SPAWN_PROTECTION=0
+
+### View Distance
+
+Sets the amount of world data the server sends the client, measured in chunks in each direction of the player (radius, not diameter).
+It determines the server-side viewing distance.
+
+    docker run -d -e VIEW_DISTANCE=10
+
+### Level Seed
+
+If you want to create the Minecraft level with a specific seed, use `SEED`, such as
+
+    -e SEED=1785852800490497919
+
+If using a negative value for the seed, make sure to quote the value such as:
+
+    -e SEED="-1785852800490497919"
+
+### Game Mode
+
+By default, Minecraft servers are configured to run in Survival mode. You can
+change the mode using `MODE` where you can either provide the [standard
+numerical values](http://minecraft.wiki/Game_mode#Game_modes) or the
+shortcut values:
+
+- creative
+- survival
+- adventure
+- spectator (only for Minecraft 1.8 or later)
+
+For example:
+
+    docker run -d -e MODE=creative ...
+
+### PVP Mode
+
+By default, servers are created with player-vs-player (PVP) mode enabled. You can disable this with the `PVP`
+environment variable set to `false`, such as
+
+    docker run -d -e PVP=false ...
+
+### Level Type and Generator Settings
+
+By default, a standard world is generated with hills, valleys, water, etc. A different level type can
+be configured by setting `LEVEL_TYPE` to [an expected type listed here](https://minecraft.wiki/w/Server.properties#level-type).
+
+For some of the level types, `GENERATOR_SETTINGS` can be used to further customize the world generation.
+
+To configure the `GENERATOR_SEETINGS` you need to add the appropriate `GeneratorOptions` JSON configuration. In the case of a superflat world, you may omit the `flat_world_options`.
+
+The layers are applied from -64 and up and are added in the order of the list
+
+Example for a superflat world:
+
+- 1x bedrock
+- 2x stone
+- 15x sandstone
+- Desert biome
+
+```yaml
+LEVEL_TYPE: FLAT
+GENERATOR_SETTINGS: >-4
+    {
+        "layers": [
+            {
+                "block": "minecraft:bedrock",
+                "height": 1
+            },
+            {
+                "block": "minecraft:stone",
+                "height": 2
+            },
+            {
+                "block": "minecraft:sandstone",
+                "height": 15
+            }
+        ],
+        "biome": "minecraft:desert"
+    }
+
+
+```
+For more details, check the [official wiki](https://minecraft.wiki/w/Java_Edition_level_format#generatorOptions_tag_format).
+
+### Custom Server Resource Pack
+
+You can set a link to a custom resource pack and set it's checksum using the `RESOURCE_PACK` and `RESOURCE_PACK_SHA1` options respectively, the default is blank:
+
+    docker run -d -e 'RESOURCE_PACK=http://link.com/to/pack.zip?=1' -e 'RESOURCE_PACK_SHA1=d5db29cd03a2ed055086cef9c31c252b4587d6d0'
+
+You can enforce the resource pack on clients by setting `RESOURCE_PACK_ENFORCE` to `TRUE` (default: `FALSE`).
+
+### Level / World Save Name
+
+You can either switch between world saves or run multiple containers with different saves by using the `LEVEL` option,
+where the default is "world":
+
+    docker run -d -e LEVEL=bonus ...
+
+> **NOTE:** if running multiple containers be sure to either specify a different `-v` host directory for each
+`LEVEL` in use or don't use `-v` and the container's filesystem will keep things encapsulated.
+
+> **INFO** Refer to the [data directory](../data-directory.md) section for a visual description of where the `$LEVEL` directory is situated.
+
+### Online mode
+
+By default, server checks connecting players against Minecraft's account database. If you want to create an offline server or your server is not connected to the internet, you can disable the server to try connecting to minecraft.net to authenticate players with environment variable `ONLINE_MODE`, like this
+
+    docker run -d -e ONLINE_MODE=FALSE ...
+
+### Allow flight
+
+Allows users to use flight on your server while in Survival mode, if they have a mod that provides flight installed.
+
+    -e ALLOW_FLIGHT=TRUE|FALSE
+
+### Server name
+
+The server name (e.g. for bungeecord) can be set like:
+
+    docker run -d -e SERVER_NAME=MyServer ...
+
+### Server port
+
+> **WARNING:** only change this value if you know what you're doing. It is only needed when using host networking and it is rare that host networking should be used. Use `-p` port mappings instead.
+
+If you must, the server port can be set like:
+
+    docker run -d -e SERVER_PORT=25566 ...
+
+**however**, be sure to change your port mapping accordingly and be prepared for some features to break.
+
+### Custom server properties
+
+Some mods/plugins utilize custom `server.properties` entries which can be declared via the `CUSTOM_SERVER_PROPERTIES` environment variable. The contents must be newline delimited `name=value` pairs.
+
+Within a compose file, newline delimited entries can be declared as shown here:
+
+```yaml
+      CUSTOM_SERVER_PROPERTIES: |
+        custom1=value1
+        defaultworldgenerator-port=f8c04631-f744-11ec-b260-f02f74b094e0
+```
+
+When using `docker run` from a bash shell, the entries must be quoted with the `$'` syntax, such as
+
+```
+-e CUSTOM_SERVER_PROPERTIES=$'k1=v1\nk2=v2'
+```
+
+### Other server property mappings
+
+| Environment Variable              | Server Property                   |
+|-----------------------------------|-----------------------------------|
+| BROADCAST_CONSOLE_TO_OPS          | broadcast-console-to-ops          |
+| BROADCAST_RCON_TO_OPS             | broadcast-rcon-to-ops             |
+| ENABLE_STATUS                     | enable-status                     |
+| ENFORCE_SECURE_PROFILE            | enforce-secure-profile            |
+| ENTITY_BROADCAST_RANGE_PERCENTAGE | entity-broadcast-range-percentage |
+| FUNCTION_PERMISSION_LEVEL         | function-permission-level         |
+| NETWORK_COMPRESSION_THRESHOLD     | network-compression-threshold     |
+| OP_PERMISSION_LEVEL               | op-permission-level               |
+| PLAYER_IDLE_TIMEOUT               | player-idle-timeout               |
+| PREVENT_PROXY_CONNECTIONS         | prevent-proxy-connections         |
+| SIMULATION_DISTANCE               | simulation-distance               |
+| SYNC_CHUNK_WRITES                 | sync-chunk-writes                 |
+| USE_NATIVE_TRANSPORT              | use-native-transport              |
+

docs/data-directory.md

@@ -0,0 +1,88 @@
+Everything the container manages is located under the **container's** `/data` path, as shown here:
+
+![](img/level-vs-world.drawio.png)
+
+!!! note
+
+    The container path `/data` is pre-declared as a volume, so if you do nothing then it will be allocated as an anonymous volume. As such, it is subject to removal when the container is removed. 
+
+### Attaching data directory to host filesystem
+
+In most cases the easiest way to persist and work with the minecraft data files is to use [bind mounts](https://docs.docker.com/storage/bind-mounts/) with the `-v` argument to map a directory on your host machine to the container's `/data` directory. In the following example, the path `/home/user/minecraft-data` **must be** a directory on your host machine:
+
+    -v /home/user/minecraft-data:/data
+       ------------------------- -----
+        |                         |
+        |                         +-- must always be /data
+        |
+        +-- replace with a directory on your host machine
+
+When attached in this way you can stop the server, edit the configuration under your attached directory and start the server again to pick up the new configuration.
+
+!!! important "Rootless, Podman, SELinux, AppArmor usage"
+    When running rootless containers, such as with Podman, or using SELinux / AppArmor on your system, append ":Z" to the volume mapping. For example:
+
+    ```
+    /home/user/minecraft-data:/data:Z
+    ```
+
+    There might be a safer/better way to accommodate these systems. Please post an issue or PR if you have more information.
+    
+With Docker Compose, setting up a host attached directory is even easier since relative paths can be configured. For example, with the following `docker-compose.yml` Docker will automatically create/attach the relative directory `minecraft-data` to the container.
+
+``` yaml title="docker-compose.yml"
+
+services:
+  mc:
+    image: itzg/minecraft-server
+    ports:
+      - 25565:25565
+    environment:
+      EULA: "TRUE"
+    tty: true
+    stdin_open: true
+    restart: unless-stopped
+    volumes:
+      # attach a directory relative to the directory containing this compose file
+      - ./minecraft-data:/data
+```
+
+### Converting anonymous `/data` volume to named volume
+
+If you had used the commands in the first section, without the `-v` volume attachment, then an anonymous data volume was created by Docker. You can later bring over that content to a named or host attached volume using the following procedure.
+
+!!! note 
+
+    In this example, it is assumed the original container was given a `--name` of "mc", so change the container identifier accordingly.
+    
+    You can also locate the Docker-managed directory from the `Source` field obtained from `docker inspect <container id or name> -f "{{json .Mounts}}"`
+
+First, stop the existing container:
+
+``` shell
+docker stop mc
+```
+
+Use a temporary container to copy over the anonymous volume's content into a named volume, "mc" in this case:
+
+``` shell
+docker run --rm --volumes-from mc -v mc:/new alpine cp -avT /data /new
+```
+
+Now you can recreate the container with any environment variable changes, etc by attaching the named volume created from the previous step:
+
+``` shell
+docker run -d -it --name mc-new -v mc:/data -p 25565:25565 -e EULA=TRUE -e MEMORY=2G itzg/minecraft-server
+```
+
+### Locating filesystem path of anonymous volume
+
+The `Source` field from the output of this command will show where the anonymous volume is mounted from:
+
+``` shell
+docker inspect -f "{{json .Mounts}}" CONTAINER_NAME_OR_ID
+```
+
+!!! note
+
+    On Windows with WSL the volumes path is `\\wsl$\docker-desktop-data\data\docker\volumes`

docs/img/.gitignore

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

docs/img/docs-banner.txt

@@ -0,0 +1,12 @@
+Generated at https://textcraft.net/
+
+Line 1:
+"Click here for"
+Small, none, Minecraftia
+
+Line 2:
+"Documentation"
+Large, non, Minecrafter
+
+Overall settings:
+- drop shadow

docs/index.md

@@ -0,0 +1,65 @@
+# Intro
+
+[![Docker Pulls](https://img.shields.io/docker/pulls/itzg/minecraft-server.svg)](https://hub.docker.com/r/itzg/minecraft-server/)
+[![Docker Stars](https://img.shields.io/docker/stars/itzg/minecraft-server.svg?maxAge=2592000)](https://hub.docker.com/r/itzg/minecraft-server/)
+[![GitHub Issues](https://img.shields.io/github/issues-raw/itzg/docker-minecraft-server.svg)](https://github.com/itzg/docker-minecraft-server/issues)
+[![Discord](https://img.shields.io/discord/660567679458869252?label=Discord&logo=discord)](https://discord.gg/DXfKpjB)
+[![Build and Publish](https://github.com/itzg/docker-minecraft-server/workflows/Build%20and%20Publish/badge.svg)](https://github.com/itzg/docker-minecraft-server/actions)
+[![](https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-orange.svg)](https://www.buymeacoffee.com/itzg)
+
+This docker image provides a Minecraft Server that will automatically download the latest stable
+version at startup. You can also run/upgrade to any specific version or the
+latest snapshot. See the _Versions_ section below for more information.
+
+To simply use the latest stable version, run
+
+    docker run -d -it -p 25565:25565 -e EULA=TRUE itzg/minecraft-server
+
+where, in this case, the standard server port 25565, will be exposed on your host machine.
+
+!!! note
+
+    If you plan on running a server for a longer amount of time it is highly recommended using a management layer such as [Docker Compose](#using-docker-compose) or [Kubernetes](#deployment-templates-and-examples) to allow for incremental reconfiguration and image upgrades.
+
+!!! info 
+
+    Be sure to always include `-e EULA=TRUE` in your commands and container definitions, as Mojang/Microsoft requires EULA acceptance.
+
+!!! warning 
+
+    **DO NOT** port forward RCON on 25575 without first setting `RCON_PASSWORD` to a secure value. It is highly recommended to only use RCON within the container, such as with `rcon-cli`. 
+
+By default, the container will download the latest version of the "vanilla" [Minecraft: Java Edition server](https://www.minecraft.net/en-us/download/server) provided by Mojang. The [`VERSION`](versions/java.md) and the [`TYPE`](types-and-platforms/index.md) can be configured to create many variations of desired Minecraft server. 
+
+## Using [Docker Compose](https://docs.docker.com/compose/)
+
+1. Create a new directory
+2. Put the contents of the file below in a file called `docker-compose.yml`
+3. Run `docker compose up -d` in that directory
+4. Done! Point your client at your host's name/IP address and port 25565.
+
+```yaml
+
+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
+```
+
+To apply changes made to the compose file, just run `docker compose up -d` again.
+
+Follow the logs of the container using `docker compose logs -f`, check on the status with `docker compose ps`, and stop the container using `docker compose stop`.
+
+!!! note "More Compose Examples"
+    There are more [examples located in the Github repo](https://github.com/itzg/docker-minecraft-server/tree/master/examples).
+
+!!! note "Deployment Examples"
+    The [deployments page](misc/deployment/index.md) provides more examples of deployment with and beyond Docker Compose.

docs/misc/autopause-autostop/autopause.md

@@ -0,0 +1,64 @@
+# Auto-Pause
+
+An auto-pause functionality is provided that monitors whether clients are connected to the server. If a client is not connected for a specified time, the Java process is put into a pause state. When a client attempts to connect while the process is paused, then process will be restored to a running state. The experience for the client does not change. This feature can be enabled by setting the environment variable `ENABLE_AUTOPAUSE` to "true".
+
+!!! important
+
+    **You must greatly increase or disable max-tick-time watchdog functionality.** From the server's point of view, the pausing causes a single tick to take as long as the process is stopped, so the server watchdog might intervene after the process is continued, possibly forcing a container restart. To prevent this, ensure that the `max-tick-time` in the `server.properties` file is set to a very large value or -1 to disable it entirely, which is highly recommended. That can be set with `MAX_TICK_TIME` as described in [the section below](../../configuration/server-properties.md#max-tick-time).
+
+    Non-vanilla versions might have their own configuration file, you might have to disable their watchdogs separately. For PaperMC servers, you need to send the JVM flag `-Ddisable.watchdog=true`, this can be done with the docker env variable `-e JVM_DD_OPTS=disable.watchdog:true`
+
+    On startup the `server.properties` file is checked and, if applicable, a warning is printed to the terminal. When the server is created (no data available in the persistent directory), the properties file is created with the Watchdog disabled.
+
+The utility used to wake the server (`knock(d)`) works at network interface level. So the correct interface has to be set using the `AUTOPAUSE_KNOCK_INTERFACE` variable when using non-default networking environments (e.g. host-networking, Portainer oder NAS solutions). See the description of the variable below.
+
+A file called `.paused` is created in `/data` directory when the server is paused and removed when the server is resumed. Other services may check for this file's existence before waking the server.
+
+A `.skip-pause` file can be created in the `/data` directory to make the server skip autopausing, for as long as the file is present. The autopause timer will also be reset.
+
+A starting, example compose file has been provided in [examples/docker-compose-autopause.yml](https://github.com/itzg/docker-minecraft-server/blob/master/examples/docker-compose-autopause.yml).
+
+Auto-pause is not compatible with `EXEC_DIRECTLY=true` and the two cannot be set together.
+
+!!! note 
+
+    When configuring kubernetes readiness/liveness health checks with auto-pause enabled, be sure to reference the `mc-health` wrapper script rather than `mc-status` directly.
+
+## Additional configuration
+
+The following environment variables define the behaviour of auto-pausing:
+
+- `AUTOPAUSE_TIMEOUT_EST`, default `3600` (seconds)
+  describes the time between the last client disconnect and the pausing of the process (read as timeout established)
+- `AUTOPAUSE_TIMEOUT_INIT`, default `600` (seconds)
+  describes the time between server start and the pausing of the process, when no client connects inbetween (read as timeout initialized)
+- `AUTOPAUSE_TIMEOUT_KN`, default `120` (seconds)
+  describes the time between knocking of the port (e.g. by the main menu ping) and the pausing of the process, when no client connects inbetween (read as timeout knocked)
+- `AUTOPAUSE_PERIOD`, default `10` (seconds)
+  describes period of the daemonized state machine, that handles the pausing of the process (resuming is done independently)
+- `AUTOPAUSE_KNOCK_INTERFACE`, default `eth0`
+  <br>Describes the interface passed to the `knockd` daemon. If the default interface does not work, run the `ifconfig` command inside the container and derive the interface receiving the incoming connection from its output. The passed interface must exist inside the container. Using the loopback interface (`lo`) does likely not yield the desired results.
+
+!!! tip
+
+    To troubleshoot, add `DEBUG_AUTOPAUSE=true` to see additional output
+
+## Rootless Auto-Pause
+
+If you're running the container as rootless, then it is necessary to add the `CAP_NET_RAW` capability to the container, such as using [the `cap_add` service field](https://docs.docker.com/compose/compose-file/05-services/#cap_add) in a compose file or [`--cap-add` docker run argument](https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities). It may also be necessary to set the environment variable `SKIP_SUDO` to "true". 
+
+You might need to set change the default port forwarder from RootlessKit to slirp4netns.
+
+For Docker, see the following for setup:
+
+- https://docs.docker.com/engine/security/rootless/#networking-errors
+- https://rootlesscontaine.rs/getting-started/docker/#changing-the-port-forwarder
+
+For Podman, see the following for setup:
+- https://rootlesscontaine.rs/getting-started/podman/#changing-the-port-forwarder
+
+
+!!! example "Using docker run"
+
+    -e AUTOPAUSE_KNOCK_INTERFACE=tap0 --cap-add=CAP_NET_RAW --network slirp4netns:port_handler=slirp4netns
+

docs/misc/autopause-autostop/autostop.md

@@ -0,0 +1,27 @@
+# Auto-Stop
+
+An option to stop the server after a specified time has been added for niche applications (e.g. billing saving on AWS Fargate). The function is incompatible with the Autopause functionality, as they basically cancel out each other.
+
+!!! note 
+
+    the docker container variables have to be set accordingly (restart policy set to "no") and that the container has to be manually restarted.
+
+A `.skip-stop` file can be created in the `/data` directory to make the server skip autostopping, for as long as the file is present. The autostop timer will also be reset.
+
+A starting, example compose file has been provided in [examples/docker-compose-autostop.yml](https://github.com/itzg/docker-minecraft-server/blob/master/examples/docker-compose-autostop.yml).
+
+Enable the Autostop functionality by setting:
+
+```
+-e ENABLE_AUTOSTOP=TRUE
+```
+
+The following environment variables define the behavior of auto-stopping:
+* `AUTOSTOP_TIMEOUT_EST`, default `3600` (seconds)
+  describes the time between the last client disconnect and the stopping of the server (read as timeout established)
+* `AUTOSTOP_TIMEOUT_INIT`, default `1800` (seconds)
+  describes the time between server start and the stopping of the server, when no client connects in-between (read as timeout initialized)
+* `AUTOSTOP_PERIOD`, default `10` (seconds)
+  describes period of the daemonized state machine, that handles the stopping of the server
+
+> To troubleshoot, add `DEBUG_AUTOSTOP=true` to see additional output

docs/misc/contributing/building.md

@@ -0,0 +1,28 @@
+
+## Building image locally with alternate Java base
+
+The following shows how to change the base Java image used by the build:
+
+```shell
+docker build --build-arg BASE_IMAGE=ghcr.io/graalvm/graalvm-ce:ol8-java11 -t IMG_PREFIX/minecraft-server:java11-graalvm .
+```
+
+## Building a multi-architecture image
+
+Ensure buildx/BuildKit support is enabled and run the following to build multi-architecture and push to the repository as named by the image:
+
+```shell
+docker buildx build --platform=linux/arm64 --platform=linux/arm/v7 --platform=linux/amd64 --tag IMG_PREFIX/minecraft-server --push .
+```
+
+To build for local images, multi-architecture is not supported, use the following with buildx to load the image into the local daemon:
+
+```shell
+docker buildx build --tag IMG_PREFIX/minecraft-server --load .
+```
+
+or just a plain build
+
+```shell
+docker build -t IMG_PREFIX/minecraft-server .
+```

docs/misc/contributing/development.md

@@ -0,0 +1,109 @@
+## 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-deployFabric](https://github.com/itzg/docker-minecraft-server/blob/master/scripts/start-deployFabric) 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](https://github.com/itzg/docker-minecraft-server/blob/master/scripts/start-configuration)
+5. Add a section to the [docs](https://github.com/itzg/docker-minecraft-server/tree/master/docs). 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: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 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
+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
+export VERSION=1.12.2
+/scripts/start-magma
+```
+
+...or pre-pending script execution:
+
+```shell
+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 tools
+
+In the cloned repo, such as [`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
+```
+
+!!! note
+
+    The distribution's version will be `0.0.0-<branch>-SNAPSHOT`
+
+For Go base tools, run
+
+```shell
+goreleaser release --snapshot --clean
+```
+
+Clone [itzg/github-releases-proxy](https://github.com/itzg/github-releases-proxy) and run it according to the instructions shown there.
+
+In the Docker build, configure the following 
+
+```shell
+--build-arg GITHUB_BASEURL=http://host.docker.internal:8080 \
+--build-arg APPS_REV=1
+```
+
+and declare one or more version overrides, such as
+
+```
+--build-arg MC_HELPER_VERSION=1.8.1-SNAPSHOT
+```
+
+## 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
+```

docs/misc/contributing/docs.md

@@ -0,0 +1,16 @@
+# Site documentation
+
+The documentation for this image/repository is written in markdown and built by [MkDocs](https://www.mkdocs.org/) into a documentation website hosted at [Read the Docs](https://readthedocs.org/). [Here is general information about writing MkDocs markdown](https://www.mkdocs.org/user-guide/writing-your-docs/) and [specifics for the Material theme used](https://squidfunk.github.io/mkdocs-material/reference/).
+
+!!! note
+    The README.md rarely needs to be modified and only serves as a brief introduction to the project.
+
+The documentation source is maintained in the [docs](https://github.com/itzg/docker-minecraft-server/tree/master/docs) folder and is organized into sections by directory and files. Look through the existing content to determine if an existing file should be updated or a new file/directory added.
+
+It will be very helpful to view the rendered documentation as you're editing. To do that run the following from the top-level directory:
+
+```shell
+docker compose -f docker-compose-mkdocs.yml -p mkdocs up
+```
+
+You can access the live documentation rendering at <http://localhost:8000>.

docs/misc/deployment/index.md

@@ -0,0 +1,28 @@
+# More Deployment Info 
+
+## On Kubernetes
+
+### Using Helm
+
+- itzg Helm Chart:
+    - [GitHub repo](https://github.com/itzg/minecraft-server-charts)
+      - [Helm Chart repo](https://itzg.github.io/minecraft-server-charts/)
+- [mcsh/server-deployment](https://github.com/mcserverhosting-net/charts)
+
+### Using Shulker
+
+[Shulker](https://github.com/jeremylvln/Shulker) is a Kubernetes operator for managing complex and dynamic Minecraft infrastructures, including game servers and proxies. It uses the docker-minecraft-server and docker-bungeecord images under-the-hood.
+
+## On CloudFormation (AWS)
+
+If you're looking for a simple way to deploy this to the Amazon Web Services Cloud, check out the [Minecraft Server Deployment (CloudFormation) repository](https://github.com/vatertime/minecraft-spot-pricing). This repository contains a CloudFormation template that will get you up and running in AWS in a matter of minutes. Optionally it uses Spot Pricing so the server is very cheap, and you can easily turn it off when not in use.
+
+## Supporting Articles
+
+Below are supporting articles for server deployment.
+
+- "Zero to Minecraft Server with Docker Desktop and Compose"
+
+    https://dev.to/rela-v/zero-to-minecraft-server-with-docker-desktop-and-compose-500a
+
+    - This is a reference guide/tutorial on how to set up a vanilla Minecraft server using this project, including step-by-step instructions, and information on topics such as port-forwarding.

docs/misc/examples.md

@@ -0,0 +1,68 @@
+# Examples
+
+Various examples are [maintained in the repository](https://github.com/itzg/docker-minecraft-server/tree/master/examples). The sections below highlight a few particular ones.
+
+## Bedrock compatible server
+
+Using the [GeyserMC plugin](https://geysermc.org/) with a Paper server (or similar) "enables clients from Minecraft Bedrock Edition to join your Minecraft Java server". The example also includes [Floodgate](https://wiki.geysermc.org/floodgate/) which "allows Xbox Live authenticated Bedrock users to join without a Java Edition account". 
+
+```yaml
+
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: "true"
+      TYPE: "PAPER"
+      PLUGINS: |
+        https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/spigot
+        https://download.geysermc.org/v2/projects/floodgate/versions/latest/builds/latest/downloads/spigot
+    ports:
+      - "25565:25565"
+      - "19132:19132/udp"
+    volumes:
+      - ./data:/data
+```
+
+[Source](https://github.com/itzg/docker-minecraft-server/blob/master/examples/geyser/docker-compose.yml)
+
+## Lazytainer - Stop Minecraft container based on traffic
+Monitors network traffic to the Minecraft containers. If there is traffic, the container runs, otherwise the container is stopped/paused.
+
+By using [Lazytainer](https://github.com/vmorganp/Lazytainer) with the [docker-minecraft-server](https://github.com/itzg/docker-minecraft-server) a somehow similar behaviour to [Lazymc](https://github.com/timvisee/lazymc) can be archived.
+
+```yaml
+services:
+  lazytainer:
+    image: ghcr.io/vmorganp/lazytainer:master
+    environment:
+      VERBOSE: false
+    ports:
+      - 25565:25565
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock:ro
+    labels:
+      - lazytainer.group.minecraft.sleepMethod=stop
+      - lazytainer.group.minecraft.ports=25565
+      - lazytainer.group.minecraft.minPacketThreshold=2 # Start after two incomming packets
+      - lazytainer.group.minecraft.inactiveTimeout=600 # 10 minutes, to allow the server to bootstrap. You can probably make this lower later if you want.
+    restart: unless-stopped
+    network_mode: bridge
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: TRUE
+      TYPE: PAPER
+      MEMORY: 4G
+    volumes:
+      - ./data:/data
+    labels:
+      - lazytainer.group=minecraft
+    depends_on:
+      - lazytainer
+    network_mode: service:lazytainer
+    tty: true
+    stdin_open: true
+    restart: unless-stopped
+```
+[Source](https://github.com/itzg/docker-minecraft-server/blob/master/examples/lazytainer/docker-compose.yml)

docs/misc/healthcheck.md

@@ -0,0 +1,32 @@
+## Healthcheck
+
+This image contains [mc-monitor](https://github.com/itzg/mc-monitor) and uses its `status` command to continually check on the container's. That can be observed from the `STATUS` column of `docker ps`
+
+```
+CONTAINER ID        IMAGE               COMMAND             CREATED             STATUS                    PORTS                                 NAMES
+b418af073764        mc                  "/start"            43 seconds ago      Up 41 seconds (healthy)   0.0.0.0:25565->25565/tcp, 25575/tcp   mc
+```
+
+You can also query the container's health in a script friendly way:
+
+``` shell
+> docker container inspect -f "{{.State.Health.Status}}" mc
+healthy
+```
+
+There's actually a wrapper script called `mc-health` that takes care of calling `mc-monitor status` with the correct arguments. If needing to customize the health checks parameters, such as in a compose file, then use something like the following in the service declaration:
+
+``` yaml
+healthcheck:
+  test: mc-health
+  start_period: 1m
+  interval: 5s
+  retries: 20
+```
+
+Some orchestration systems, such as Portainer, don't allow for disabling the default `HEALTHCHECK` declared by this image. In those cases you can approximate the disabling of healthchecks by setting the environment variable `DISABLE_HEALTHCHECK` to `true`.
+
+### Healthchecks for older versions
+
+This container disables Healthchecks for Versions before b1.8 as those versions do not support any kind of server pinging.
+For more information see [Server List Ping](https://wiki.vg/Server_List_Ping#Beta_1.8_to_1.3)

docs/misc/log4j.md

@@ -0,0 +1 @@
+**Please ensure you have pulled the latest image** since [all official mitigations](https://www.minecraft.net/en-us/article/important-message--security-vulnerability-java-edition) are automatically applied by the container startup process.

docs/misc/raspberrypi.md

@@ -0,0 +1,11 @@
+# Running on RaspberryPi
+
+To run this image on a RaspberryPi 3 B+, 4, or newer, use any of the image tags [list in the Java version section](../versions/java.md) that specify `armv7` for the architecture, which includes `itzg/minecraft-server:latest`.
+
+!!! note
+   
+   You may need to lower the memory allocation, such as `-e MEMORY=750m`
+
+!!! note
+
+    If experiencing issues such as "sleep: cannot read realtime clock: Operation not permitted", ensure `libseccomp` is up to date on your host. In some cases adding `:Z` flag to the `/data` mount may be needed, [but use cautiously](https://docs.docker.com/storage/bind-mounts/#configure-the-selinux-label).

docs/misc/related-projects.md

@@ -0,0 +1,31 @@
+### [itzg/minecraft-bedrock-server](https://github.com/itzg/docker-minecraft-bedrock-server)
+
+Docker image that runs a Minecraft Bedrock server.
+
+### [mc-router](https://github.com/itzg/mc-router)
+
+Lightweight multiplexer/proxy for Minecraft Java servers. Provided as a stand-alone application and a Docker image.
+
+### [itzg/mc-proxy](https://github.com/itzg/docker-bungeecord/)
+
+Docker image that runs a proxy powered by Bungeecord, Velocity, or Waterfall
+
+### [itzg/mc-backup](https://github.com/itzg/docker-mc-backup)
+
+Docker image that runs as a side-car container to backup world data.
+
+### [rcon-cli](https://github.com/itzg/rcon-cli)
+
+A tool that is bundled with this image to provide CLI access to an RCON endpoint.
+
+### [mc-monitor](https://github.com/itzg/mc-monitor)
+
+A tool that is bundled with this image that provides health checks and metrics reporting, such as a Prometheus exporter or a telegraf data source.
+
+### [mc-image-helper](https://github.com/itzg/mc-image-helper)
+
+A tool that is bundled with this image to provide complex, re-usable preparation operations. 
+
+### [itzg/rcon](https://github.com/itzg/docker-rcon-web-admin)
+
+An image that dockerizes [rcon-web-admin](https://github.com/rcon-web-admin/rcon-web-admin).

docs/misc/troubleshooting.md

@@ -0,0 +1,5 @@
+To troubleshoot the container initialization, such as when server files are pre-downloaded, set the environment variable `DEBUG` to `true`. The container logs will include **much more** output, and it is highly recommended including that output when reporting any [issues](https://github.com/itzg/docker-minecraft-server/issues).
+
+To troubleshoot just the command-line used to start the Minecraft server, set the environment variable `DEBUG_EXEC` to `true`.
+
+To troubleshoot any issues with memory allocation reported by the JVM, set the environment variable `DEBUG_MEMORY` to `true`.

docs/misc/world-data.md

@@ -0,0 +1,126 @@
+
+## Downloadable world
+
+Instead of mounting the `/data` volume, you can instead specify the URL of a ZIP or compressed TAR file containing an archived world. It will be searched for a file `level.dat` and the containing subdirectory moved to the directory named by `$LEVEL`. This means that most of the archived Minecraft worlds downloadable from the Internet will already be in the correct format.
+
+    docker run -d -e WORLD=http://www.example.com/worlds/MySave.zip ...
+
+!!! note
+
+    This URL must be accessible from inside the container. Therefore, you should use an IP address or a globally resolvable FQDN, or else the name of a linked container.
+
+!!! note
+
+    If the archive contains more than one `level.dat`, then the one to select can be picked with `WORLD_INDEX`, which defaults to 1.
+
+## Cloning world from a container path
+
+The `WORLD` option can also be used to reference a directory, zip file, or compressed tar file that will be used as a source to clone or extract the world directory.
+
+For example, the following would initially clone the world's content from `/worlds/basic`. Also notice in the example that you should use a read-only volume attachment to ensure the clone source remains pristine.
+
+```
+docker run ... -v $HOME/worlds:/worlds:ro -e WORLD=/worlds/basic
+```
+
+The following diagram shows how this option can be used in a compose deployment with a relative directory:
+
+![](../img/world-copy-compose-project.drawio.png)
+
+## Overwrite world on start
+The world will only be downloaded or copied if it doesn't exist already. Set `FORCE_WORLD_COPY=TRUE` to force overwrite the world on every server start.
+
+## Custom worlds directory path
+To set a custom worlds directory for the Multiverse plugin on a baremetal server, you'd pass the `--world-dir` argument after the jar file.
+In order to accomplish the same in a containerized server, set the `EXTRA_ARGS` environment variable in your command line or docker compose yaml to the same argument string. For example:
+
+```
+docker run -d -e EXTRA_ARGS='--world-dir ./worlds/'
+```
+`--world-container`, `-W`, and `--universe` are aliases to `--world-dir` and can also be used.
+
+## Datapacks
+
+Datapacks can be installed in a similar manner to mods/plugins. There are many environment variables which function in the same way they do for [mods](../mods-and-plugins/index.md):
+
+* `DATAPACKS`: comma-separated list of zip file URL, zip file in container, or directory in container
+* `DATAPACKS_FILE`: a text file within the container where each line is a zip file URL, zip file in container, or directory in container
+* `REMOVE_OLD_DATAPACKS`: if "true" the datapacks directory is removed of everything matching `REMOVE_OLD_DATAPACKS_INCLUDE`, but excluding `REMOVE_OLD_DATAPACKS_EXCLUDE` no deeper than `REMOVE_OLD_DATAPACKS_DEPTH`
+* `REMOVE_OLD_DATAPACKS_DEPTH`: default is 16
+* `REMOVE_OLD_DATAPACKS_INCLUDE`: default is `*.zip`
+* `REMOVE_OLD_DATAPACKS_EXCLUDE`: default is empty
+
+Datapacks will be placed in `/data/$LEVEL/datapacks`
+
+## VanillaTweaks
+
+[VanillaTweaks](https://vanillatweaks.net/) datapacks, crafting tweaks, and resource packs can be installed with a share code from the website **OR** a json file to specify packs to download and install. Datapacks and crafting tweaks will be installed into the current world directory specified by `$LEVEL`. As new versions of the packs are retrieved the previous versions will automatically be cleaned up.
+
+The share code is the part following the hash sign, as shown here:
+
+```
+https://vanillatweaks.net/share/#MGr52E
+                                 ------
+                                  |
+                                  +- share code MGr52E
+```
+
+Accepted Parameters:
+
+- `VANILLATWEAKS_FILE`: comma separated list of JSON VanillaTweak pack files accessible within the container
+- `VANILLATWEAKS_SHARECODE`: comma separated list of share codes
+
+Example of expected VanillaTweaks share codes:
+
+!!! note
+
+    ResourcePacks, DataPacks, and CraftingTweaks all have separate sharecodes
+
+``` yaml
+VANILLATWEAKS_SHARECODE: MGr52E,tF1zL2,LnEDwT
+```
+
+Example of expected VanillaTweaks files:
+
+``` yaml
+VANILLATWEAKS_FILE: /config/vt-datapacks.json,/config/vt-craftingtweaks.json,/config/vt-resourcepacks.json
+```
+
+``` json title="DataPacks json"
+{
+  "type": "datapacks",
+  "version": "1.18",
+  "packs": {
+    "survival": [
+      "graves",
+      "multiplayer sleep"
+    ],
+    "items": ["armored elytra"]
+  }
+}
+```
+
+``` json title="ResourcePacks json"
+{
+    "type": "resourcepacks",
+    "version": "1.18",
+    "packs": {
+        "aesthetic": ["CherryPicking", "BlackNetherBricks", "AlternateBlockDestruction"]
+    }
+}
+```
+
+
+``` json title="CraftingTweaks Json"
+{
+    "type": "craftingtweaks",
+    "version": "1.18",
+    "packs": {
+        "quality of life": [
+            "dropper to dispenser",
+            "double slabs",
+            "back to blocks"
+        ]
+    }
+}
+```

docs/mods-and-plugins/curseforge-files.md

@@ -0,0 +1,53 @@
+# Auto-download from CurseForge
+
+Mods and plugins can be auto-downloaded and upgraded from CurseForge by setting `CURSEFORGE_FILES` to a comma or space delimited list of [project-file references](#project-file-references). References removed from the declaration are automatically cleaned up and setting `CURSEFORGE_FILES` to an empty string removes all previously managed project-files.
+
+A specific file can be omitted from each reference to allow for auto-selecting the newest version of the selected mod/plugin. The resolved `VERSION` and `TYPE` will be taken into consideration for selecting the appropriate file. 
+
+!!! warning "CurseForge API key usage"
+
+    A CurseForge API key must be allocated and set with `CF_API_KEY` [as described here](../types-and-platforms/mod-platforms/auto-curseforge.md#api-key).
+
+## Project-file references
+
+!!! tip
+
+    Individual project files typically represent a version of the mod/plugin, but CurseForge refers to these items broadly as "files" rather than "versions". 
+
+The following formats are supported in the list of project-file references:
+
+- A project page URL, such as `https://www.curseforge.com/minecraft/mc-mods/jei`. _The newest applicable file will be automatically selected._
+- A file page URL, such as `https://www.curseforge.com/minecraft/mc-mods/jei/files/4593548`
+- Project slug, such as `jei`. _The newest applicable file will be automatically selected._
+- Project ID, such as `238222`. _The newest applicable file will be automatically selected._
+- Project slug or ID, `:`, and a file ID, such as `jei:4593548` or `238222:4593548`
+- Project slug or ID, `@`, and a partial filename, such as `jei@10.2.1.1005`. This option is useful to refer to a version of the mod/plugin rather than looking up the file ID.
+
+An `@` followed by the container path to a listing file can also be provided as a project-file reference. Each line is processed as a reference where blank lines and comments that start with `#` are ignored.
+
+For example, `CURSEFORGE_FILES` can be set to "@/extras/cf-mods.txt" where the container file `/extras/cf-mods.txt` contains
+
+```text
+# This comment is ignored
+jei:10.2.1.1005
+
+# This and previous blank line are ignore
+geckolib
+aquaculture
+naturalist
+```
+
+!!! tip "Docker Compose"
+
+    Making use of the space delimited option, compose file declarations can be organized nicely with a [multi-line string](https://yaml-multiline.info/), such as
+    
+    ```yaml
+          CURSEFORGE_FILES: |
+            geckolib
+            aquaculture
+            naturalist
+    ```
+
+## Dependencies
+
+The files processing can detect if a dependency is missing from the given list, but is not able to resolve the dependencies otherwise since their metadata only gives the mod ID and not the specific file version/ID that is needed.

docs/mods-and-plugins/index.md

@@ -0,0 +1,134 @@
+# Working with mods and plugins
+
+## Mod platforms
+
+By far the easiest way to work with mod and plugins, especially large numbers of them, is to utilize modpacks with [one of the supported mod platforms](../types-and-platforms/index.md).
+
+The following are some supported mod platforms:
+
+- [Modrinth](../types-and-platforms/mod-platforms/modrinth-modpacks.md) 
+- [CurseForge](../types-and-platforms/mod-platforms/auto-curseforge.md)
+- [Feed the Beast](../types-and-platforms/mod-platforms/ftb.md)
+
+## Download automation
+
+On the left, there are sections describing some download automation options.
+
+## Mods vs Plugins
+
+The terms "mods" and "plugins" can be quite confusing. Generally, the rule of thumb is that "mods" are used by the types that run client side to modify rendering, add new blocks, and add behaviors server, such as [Forge](../types-and-platforms/server-types/forge.md) and [Fabric](../types-and-platforms/server-types/fabric.md). "Plugins" are used by the types that **only run on servers** to add behaviors, commands, etc such as [Paper](../types-and-platforms/server-types/paper.md) (which derives from [Bukkit/Spigot](../types-and-platforms/server-types/bukkit-spigot.md)). There are also some types that are [hybrids](../types-and-platforms/server-types/hybrids.md), such as Magma, that use both "mods" and "plugins"
+
+## Optional plugins, mods, and config attach points
+
+There are optional volume paths that can be attached to supply content to be copied into the data area:
+
+`/plugins`
+: content in this directory is synchronized into `/data/plugins` for server types that use plugins, [as described above](#mods-vs-plugins). For special cases, the source can be changed by setting `COPY_PLUGINS_SRC` and destination by setting `COPY_PLUGINS_DEST`.
+
+`/mods`
+: content in this directory is synchronized into `/data/mods` for server types that use mods, [as described above](#mods-vs-plugins). For special cases, the source can be changed by setting `COPY_MODS_SRC` and destination by setting `COPY_MODS_DEST`.
+
+`/config`
+: contents are synchronized into `/data/config` by default, but can be changed with `COPY_CONFIG_DEST`. For example, `-v ./config:/config -e COPY_CONFIG_DEST=/data` will allow you to copy over files like `bukkit.yml` and so on directly into the server directory. The source can be changed by setting `COPY_CONFIG_SRC`. Set `SYNC_SKIP_NEWER_IN_DESTINATION=false` if you want files from `/config` to take precedence over newer files in `/data/config`.
+
+By default, the [environment variable processing](../configuration/interpolating.md) is performed on synchronized files that match the expected suffixes in `REPLACE_ENV_SUFFIXES` (by default "yml,yaml,txt,cfg,conf,properties,hjson,json,tml,toml") and are not excluded by `REPLACE_ENV_VARIABLES_EXCLUDES` and `REPLACE_ENV_VARIABLES_EXCLUDE_PATHS`. This processing can be disabled by setting `REPLACE_ENV_DURING_SYNC` to `false`.
+
+If you want old mods/plugins to be removed before the content is brought over from those attach points, then add `-e REMOVE_OLD_MODS=TRUE`. You can fine tune the removal process by specifying the `REMOVE_OLD_MODS_INCLUDE` and `REMOVE_OLD_MODS_EXCLUDE` variables, which are comma separated lists of file glob patterns. If a directory is excluded, then it and all of its contents are excluded. By default, only jars are removed. 
+
+You can also specify the `REMOVE_OLD_MODS_DEPTH` (default is 16) variable to only delete files up to a certain level.
+
+For example: `-e REMOVE_OLD_MODS=TRUE -e REMOVE_OLD_MODS_INCLUDE="*.jar" -e REMOVE_OLD_MODS_DEPTH=1` will remove all old jar files that are directly inside the `plugins/` or `mods/` directory.
+
+These paths work well if you want to have a common set of modules in a separate location, but still have multiple worlds with different server requirements in either persistent volumes or a downloadable archive.
+
+!!! information ""
+    For more flexibility with mods/plugins preparation, you can declare other directories, files, and URLs to use in [the `MODS` / `PLUGINS` variables](#modsplugins-list).
+
+
+## Zip file modpack
+
+Like the `WORLD` option above, you can specify the URL or container path of a "mod pack" to download and install into `mods` for Forge/Fabric or `plugins` for Bukkit/Spigot. To use this option pass the environment variable `MODPACK`, such as
+
+```shell
+docker run -d -e MODPACK=http://www.example.com/mods/modpack.zip ...
+```
+
+!!! note
+    The referenced URL/file must be a zip file with one or more jar files at the
+    top level of the zip archive. Make sure the jars are compatible with the
+    particular `TYPE` of server you are running.
+
+## Generic pack files
+
+To install all the server content (jars, mods, plugins, configs, etc.) from a zip or tgz file, then set `GENERIC_PACK` to the container path or URL of the archive file. This can also be used to apply a CurseForge modpack that is missing a server start script and/or Forge installer.
+
+If multiple generic packs need to be applied together, set `GENERIC_PACKS` instead, with a comma separated list of archive file paths and/or URLs to files.
+
+To avoid repetition, each entry will be prefixed by the value of `GENERIC_PACKS_PREFIX` and suffixed by the value of `GENERIC_PACKS_SUFFIX`, both of which are optional. For example, the following variables
+
+```
+GENERIC_PACKS=configs-v9.0.1,mods-v4.3.6
+GENERIC_PACKS_PREFIX=https://cdn.example.org/
+GENERIC_PACKS_SUFFIX=.zip
+```
+
+would expand to `https://cdn.example.org/configs-v9.0.1.zip,https://cdn.example.org/mods-v4.3.6.zip`.
+
+If applying large generic packs, the update can be time-consuming. To skip the update set `SKIP_GENERIC_PACK_UPDATE_CHECK` to "true". Conversely, the generic pack(s) can be forced to be applied by setting `FORCE_GENERIC_PACK_UPDATE` to "true".
+
+The most time-consuming portion of the generic pack update is generating and comparing the SHA1 checksum. To skip the checksum generation, set `SKIP_GENERIC_PACK_CHECKSUM` to "true".
+
+## Mods/plugins list
+
+You may also download or copy over individual mods/plugins using the `MODS` or `PLUGINS` environment variables. Both are a comma or newline delimited list of
+- URL of a jar file
+- container path to a jar file
+- container path to a directory containing jar files
+
+```shell
+docker run -d -e MODS=https://www.example.com/mods/mod1.jar,/plugins/common,/plugins/special/mod2.jar ...
+```
+
+The newline delimiting allows for compose file usage like:
+```yaml
+      PLUGINS: |
+        https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/spigot
+        https://download.geysermc.org/v2/projects/floodgate/versions/latest/builds/latest/downloads/spigot
+```
+
+## Mod/Plugin URL Listing File 
+
+As an alternative to `MODS`/`PLUGINS`, the variable `MODS_FILE` or `PLUGINS_FILE` can be set with the container path or URL of a text file listing a mod/plugin URLs on each line. For example, the following
+
+     -e MODS_FILE=/extras/mods.txt
+
+would load from a file mounted into the container at `/extras/mods.txt`. That file might look like:
+
+```text
+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
+# This and next line are ignored
+#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
+```
+
+!!! note
+
+    Blank lines and lines that start with a `#` will be ignored
+
+    [This compose file](https://github.com/itzg/docker-minecraft-server/blob/master/examples/mods-file/docker-compose.yml) shows another example of using this feature.
+
+## Remove old mods/plugins
+
+When the `MODPACK` option above is specified you can also instruct script to delete old mods/plugins prior to installing new ones. This behaviour is desirable in case you want to upgrade mods/plugins from downloaded zip file.
+
+To use this option pass the environment variable `REMOVE_OLD_MODS=TRUE`, such as
+
+```shell
+docker run -d -e REMOVE_OLD_MODS=TRUE -e MODPACK=http://www.example.com/mods/modpack.zip ...
+```
+
+!!! danger 
+
+    All content of the `mods` or `plugins` directory will be deleted before unpacking new content from the MODPACK or MODS.

docs/mods-and-plugins/modrinth.md

@@ -0,0 +1,30 @@
+# Auto-download from Modrinth
+
+[Modrinth](https://modrinth.com/) is an open source modding platform with a clean, easy to use website for finding [Fabric and Forge mods](https://modrinth.com/mods). At startup, the container will automatically locate and download the newest versions of mod/plugin files that correspond to the `TYPE` and `VERSION` in use. Older file versions downloaded previously will automatically be cleaned up.
+
+- **MODRINTH_PROJECTS** : comma or newline separated list of project slugs (short name) or IDs. The project ID is located in the "Technical information" section. The slug is the part of the page URL that follows `/mod/`:
+  ```
+    https://modrinth.com/mod/fabric-api
+                             ----------
+                              |
+                              +-- project slug
+  ```
+  Also, a specific version/type can be declared using colon symbol and version id/type after the project slug. The version id can be found in the 'Metadata' section. Valid version types are `release`, `beta`, `alpha`.
+
+!!! example
+        
+    | Description                     | Example               |
+    |---------------------------------|-----------------------|
+    | Select latest version           | `fabric-api`          |
+    | Select specific version         | `fabric-api:PbVeub96` |
+    | Select latest beta version      | `fabric-api:beta`     |
+    | Latest version using project ID | `P7dR8mSH`            |
+
+## Extra options
+
+`MODRINTH_DOWNLOAD_DEPENDENCIES`
+: Can be set to `none` (the default), `required`, or `optional` to download required and/or optional dependencies.
+
+`MODRINTH_ALLOWED_VERSION_TYPE`
+: The version type is used to determine the newest version to use from each project. The allowed values are `release` (default), `beta`, `alpha`.
+

docs/mods-and-plugins/packwiz.md

@@ -0,0 +1,17 @@
+# Packwiz Modpacks
+
+[packwiz](https://packwiz.infra.link/) is a CLI tool for maintaining and providing modpack definitions, with support for both CurseForge and Modrinth as sources. See the [packwiz tutorial](https://packwiz.infra.link/tutorials/getting-started/) for more information.
+
+To configure server mods using a packwiz modpack, set the `PACKWIZ_URL` environment variable to the location of your `pack.toml` modpack definition:
+
+```
+docker run -d -v /path/on/host:/data -e TYPE=FABRIC \
+    -e "PACKWIZ_URL=https://example.com/modpack/pack.toml" \
+    itzg/minecraft-server
+```
+
+packwiz modpack definitions are processed before other mod definitions (`MODPACK`, `MODS`, etc.) to allow for additional processing/overrides you may want to perform (in case of mods not available via Modrinth/CurseForge, or you do not maintain the pack).
+
+!!! note 
+
+    packwiz is pre-configured to only download server mods. If client-side mods are downloaded and cause issues, check your pack.toml configuration, and make sure any client-only mods are not set to `"both"`, but rather `"client"` for the side configuration item.

docs/mods-and-plugins/spiget.md

@@ -0,0 +1,19 @@
+# Auto-download using Spiget
+
+The `SPIGET_RESOURCES` variable can be set with a comma-separated list of SpigotMC resource IDs to automatically download [Spigot/Bukkit/Paper plugins](https://www.spigotmc.org/resources/) using [the spiget API](https://spiget.org/). Resources that are zip files will be expanded into the plugins directory and resources that are simply jar files will be moved there.
+
+!!! important "SPIGET not SPIGOT"
+    The variable is purposely spelled SPIG**E**T with an "E"
+
+The **resource ID** can be located from the numerical part of the URL after the shortname/slug and a dot. For example, the ID is **28140** from
+
+    https://www.spigotmc.org/resources/luckperms.28140/
+                                                 =====
+
+For example, the following will auto-download the [LuckPerms](https://www.spigotmc.org/resources/luckperms.28140/) and [Vault](https://www.spigotmc.org/resources/vault.34315/) plugins:
+
+    -e SPIGET_RESOURCES=28140,34315
+
+!!! note
+    Some plugins, such as EssentialsX (resource ID 9089), do not permit automated downloads via Spiget. Instead, you will need to pre-download the desired file and supply it to the container, such as using the `/plugins` mount point, described [in the main section](index.md).
+

docs/requirements.txt

@@ -0,0 +1,7 @@
+mkdocs-material == 9.5.27
+mkdocs-autorefs == 1.0.1
+mkdocstrings == 0.25.1
+mkdocs-literate-nav == 0.6.1
+mdx-gh-links == 0.4
+mkdocs-click == 0.8.1
+mkdocs-static-i18n == 1.2.3

docs/types-and-platforms/index.md

@@ -0,0 +1,14 @@
+# Server Types and Mod Platforms
+
+Server types can be selected by setting the `TYPE` environment variable to one of the types described in these sections.
+
+The default server type is [the official software provided by Mojang](https://www.minecraft.net/en-us/download/server), which can be explicitly selected by setting `TYPE` to "VANILLA".
+
+**From the sections to the left...**
+
+The **mod platforms** take a modpack identifier, file, etc and use that to select and download the appropriate version of a mod loader, such as Forge or Fabric, downloading declared mods/plugins, and apply any additional files. The mod platforms are selected by setting `MOD_PLATFORM`; however, for ease of use and compatibility, the selection can be set in `TYPE`.
+
+The individual **server types** allow for selecting the mod loader / server type and specific versions of those. 
+
+!!! important
+    For all the server types, the `VERSION` environment variable is used to declare the Minecraft version itself, such as 1.19.4. Each server type will have specific variables for qualifying their version in addition to the Minecraft version.

docs/types-and-platforms/mod-platforms/auto-curseforge.md

@@ -0,0 +1,242 @@
+# Auto CurseForge
+
+To manage a CurseForge modpack automatically with upgrade support, pinned or latest version tracking, set `MOD_PLATFORM` or `TYPE` to "AUTO_CURSEFORGE". The appropriate mod loader (Forge / Fabric) version will be automatically installed as declared by the modpack. This mode will also take care of cleaning up unused files installed by previous versions of the modpack, but world data is never auto-removed.
+
+## API Key
+
+!!! warning "CurseForge API key usage"
+
+    A CurseForge API key is **required** to use this feature. Go to their [developer console](https://console.curseforge.com/), generate an API key, and set the environment variable `CF_API_KEY`.
+    
+    When entering your API Key in a docker compose file you will need to escape any `$` character with a second `$`. Refer to [this compose file reference section](https://docs.docker.com/compose/compose-file/compose-file-v3/#variable-substitution) for more information.
+    
+    Example if your key is `$11$22$33aaaaaaaaaaaaaaaaaaaaaaaaaa`:
+    ```yaml
+    environment:
+      CF_API_KEY: '$$11$$22$$33aaaaaaaaaaaaaaaaaaaaaaaaaa'
+    ```
+    If you use `docker run` you will need to make sure to use single quotes:
+    
+    ```shell
+    docker run ... -e CF_API_KEY='$11$22$33aaaaaaaaaaaaaaaaaaaaaaaaaa'
+    ```
+    
+    To avoid exposing the API key, it is highly recommended to use a `.env` file, which is [loaded automatically by docker compose](https://docs.docker.com/compose/environment-variables/set-environment-variables/#substitute-with-an-env-file). `$`'s in the value still need to escaped with a second `$` and the variable needs to be referenced from the compose file, such as:
+    ```yaml
+    environment:
+      CF_API_KEY: ${CF_API_KEY}
+    ```
+    
+    To use the equivalent with `docker run` you need to specify the `.env` file explicitly:
+    ```
+    docker run --env-file=.env itzg/minecraft-server
+    ```
+
+!!! note
+    Be sure to use the appropriate [image tag for the Java version compatible with the modpack](../../versions/java.md).
+    
+    Most modpacks require a good amount of memory, so it best to set `MEMORY` to at least "4G" since the default is only 1 GB.
+
+## Usage
+
+Use one of the following to specify the modpack to install:
+
+Pass a page URL to the modpack or a specific file with `CF_PAGE_URL` such as the modpack page "https://www.curseforge.com/minecraft/modpacks/all-the-mods-8" or a specific file "https://www.curseforge.com/minecraft/modpacks/all-the-mods-8/files/4248390". For example:
+
+```
+-e TYPE=AUTO_CURSEFORGE -e CF_PAGE_URL=https://www.curseforge.com/minecraft/modpacks/all-the-mods-8
+```
+
+Instead of a URL, the modpack slug can be provided as `CF_SLUG`. The slug is the short identifier visible in the URL after "/modpacks/", such as
+
+![cf-slug](../../img/cf-slug.png)
+
+For example:
+```
+-e TYPE=AUTO_CURSEFORGE -e CF_SLUG=all-the-mods-8
+```
+
+The latest file will be located and used by default, but if a specific version is desired you can use one of the following options. With any of these options **do not select a server file** -- they lack the required manifest and defeat the ability to consistently automate startup.
+
+- Use `CF_PAGE_URL`, but include the full URL to a specific file
+- Set `CF_FILE_ID` to the numerical file ID
+- Specify a substring to match the desired filename with `CF_FILENAME_MATCHER`
+
+The following shows where to get the URL to the specific file and also shows where the file ID is located:
+
+![cf-file-id](../../img/cf-file-id.png)
+
+The following examples all refer to version 1.0.7 of ATM8:
+
+```yaml
+  CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-the-mods-8/files/4248390
+```
+
+```yaml
+  CF_SLUG: all-the-mods-8
+  CF_FILE_ID: "4248390"
+```
+
+```yaml
+  CF_SLUG: all-the-mods-8
+  CF_FILENAME_MATCHER: 1.0.7
+```
+
+## Manual Downloads
+
+For mod, modpacks, and world files that are not allowed for automated download, the container path `/downloads` can be attached and matching files will be retrieved from there. The subdirectories `mods`, `modpacks`, and `worlds` will also be checked accordingly. To change the source location of downloaded files, set `CF_DOWNLOADS_REPO` to an existing container path. To disable this feature, set `CF_DOWNLOADS_REPO` to an empty string.
+
+!!! warning "Download using a browser"
+
+    It's important to use a browser to download the files listed for manual download. If your Docker host is running without a graphical interface, then you can use `scp` or similar to transfer the files to it.
+
+!!! example
+
+    Assuming Docker compose is being used:
+    
+    1. Create a directory next to the `docker-compose.yml` file. The name doesn't matter, but "downloads" is the common convention
+    2. From the "Mods Need Download" output, visit the download page of each, click on the file download and save that file into the directory created in the previous step
+    3. Add a host directory mount to the volumes section where the container path **must be** `/downloads`. The snippet below shows how that will look
+    4. Re-run `docker compose up -d` to apply the changes
+    
+    ```yaml
+        volumes:
+          ./downloads:/downloads
+    ```
+
+## Unpublished Modpacks
+
+If you wish to use an unpublished modpack zip, set the container path to the file in `CF_MODPACK_ZIP`. Similarly, the container path to a modpack manifest JSON can be passed to `CF_MODPACK_MANIFEST`.  In either case, **the modpack slug or page URL must still be provided**.
+
+!!! example
+
+    ```yaml
+    services:
+      mc:
+        image: itzg/minecraft-server
+        environment:
+          EULA: true
+          MOD_PLATFORM: AUTO_CURSEFORGE
+          # allocate from https://console.curseforge.com/ and set in .env file
+          CF_API_KEY: ${CF_API_KEY}
+          CF_MODPACK_MANIFEST: /manifests/manifest.json
+          CF_SLUG: "custom"
+        volumes:
+          - ./manifests:/manifests:ro
+    ```
+
+    where an exported manifest file should look like:
+    
+    ```json
+    {
+      "minecraft": {
+        "version": "1.20.4",
+        "modLoaders": [
+          {
+            "id": "fabric-0.15.3",
+            "primary": true
+          }
+        ]
+      },
+      "manifestType": "minecraftModpack",
+      "manifestVersion": 1,
+      "name": "Custom",
+      "author": "",
+      "files": [
+        {
+          "projectID": 351725,
+          "fileID": 4973035,
+          "required": true
+        },
+        {
+          "projectID": 306612,
+          "fileID": 5010374,
+          "required": true
+        }
+      ],
+      "overrides": "overrides"
+    }
+    ```
+
+## Exclude client mods
+
+Quite often there are mods that need to be excluded, such as ones that did not properly declare as a client mod via the file's game versions. Similarly, there are some mods that are incorrectly tagged as client only. The following describes two options to exclude/include mods:
+
+Mods can be excluded by passing a comma or space delimited list of **project** slugs or IDs via `CF_EXCLUDE_MODS`. Similarly, there are some mods that are incorrectly tagged as client only. For those, pass the **project** slugs or IDs via `CF_FORCE_INCLUDE_MODS`. These lists will be combined with the content of the exclude/include file, if given.
+
+A mod's project ID can be obtained from the right hand side of the project page:
+![cf-project-id](../../img/cf-project-id.png)
+
+For more complex scenarios, global and per modpack exclusions can be declared in a container-accessible JSON file and referenced with `CF_EXCLUDE_INCLUDE_FILE`. By default, [the file bundled with the image](https://raw.githubusercontent.com/itzg/docker-minecraft-server/master/files/cf-exclude-include.json) will be used, but can be disabled by setting this to an empty string. The schema of this file [is documented here](https://github.com/itzg/mc-image-helper#excludeinclude-file-schema).
+
+If needing to iterate on the options above, set `CF_FORCE_SYNCHRONIZE` to "true" to ensure the exclude/includes are re-evaluated.
+
+!!! important
+    These options are provided to empower you to get your server up and running quickly. Please help out by reporting an issue with the respective mod project. Ideally mod developers should [use correct registrations for one-sided client mods](https://docs.minecraftforge.net/en/latest/concepts/sides/#writing-one-sided-mods). Understandably, those code changes may be non-trivial, so mod authors can also add "Client" to the game versions when publishing.
+
+## Excluding Overrides Files
+
+Modpack zip files typically include an `overrides` subdirectory that may contain config files, world data, and extra mod files. All of those files will be extracted into the `/data` path of the container. If any of those files, such as incompatible mods, need to be excluded from extraction, then the `CF_OVERRIDES_EXCLUSIONS` variable can be set with a comma or newline delimited list of ant-style paths ([see below](#ant-style-paths)) to exclude, relative to the overrides (or `/data`) directory. 
+
+### Ant-style paths
+
+Ant-style paths can include the following globbing/wildcard symbols:
+
+| Symbol | Behavior                                                |
+|--------|---------------------------------------------------------|
+| `*`    | Matches zero, one, or many characters except a slash    |
+| `**`   | Matches zero, one, or many characters including slashes |
+| `?`    | Matches one character                                   |
+
+!!! example
+    
+    The following compose `environment` entries show how to exclude Iris and Sodium mods from the overrides
+    
+    ```yaml
+      CF_OVERRIDES_EXCLUSIONS: mods/iris*.jar,mods/sodium*.jar
+    ```
+    
+    or using newline delimiter, which improves maintainability
+    
+    ```yaml
+      CF_OVERRIDES_EXCLUSIONS: |
+        mods/iris*.jar
+        mods/sodium*.jar
+    ```
+
+## World/Level Data
+
+Some modpacks come with world/save data via a worlds file and/or the overrides provided with the modpack. Either approach can be selected to set the `LEVEL` to the resulting saves directory by setting `CF_SET_LEVEL_FROM` to either:
+
+- `WORLD_FILE`
+- `OVERRIDES`
+
+## Ignore missing files
+
+Some mods use temporary files from the modpack and delete them when finished. Others will patch themselves and "disable" the original mod jar, such as gregtech. In order to avoid the installer from detecting the absent file(s) and re-installing, those files can be ignored by passing a comma or newline delimited list to `CF_IGNORE_MISSING_FILES`.
+
+!!! hint
+
+    A warning log will indicate what files were found to be missing from the previous installation run, such as
+
+    ```
+    Re-installing due to missing files from modpack: [mods/gregtech-2.6.2-beta.jar]
+    ```
+
+!!! example
+
+    In a Compose file
+    ```yaml
+      environment:
+        CF_IGNORE_MISSING_FILES: |
+          mods/gregtech-2.6.2-beta.jar
+    ```
+
+
+## Extra options
+
+Other configuration available:
+
+- `CF_PARALLEL_DOWNLOADS` (default is 4): specify how many parallel mod downloads to perform
+- `CF_OVERRIDES_SKIP_EXISTING` (default is false): if set, files in the overrides that already exist in the data directory are skipped. **NOTE** world data is always skipped, if present.
+- `CF_FORCE_REINSTALL_MODLOADER` (default is false): this can be set to `true` to force the modpack's declared modloader, such as Forge, to be reinstalled. This is useful if some of the modloader's files become corrupted.

docs/types-and-platforms/mod-platforms/curseforge.md

@@ -0,0 +1,46 @@
+# Manual CurseForge server packs
+
+!!! warning "Deprecated"
+
+    This mod platform type is deprecated. Please use [AUTO_CURSEFORGE](auto-curseforge.md) for new deployments.
+
+Enable this server mode by setting `MOD_PLATFORM` or `TYPE` to "CURSEFORGE" along with the following specific variables.
+
+You need to specify a modpack to run, using the `CF_SERVER_MOD` environment
+variable. A CurseForge server modpack is available together with its respective
+client modpack at <https://www.curseforge.com/minecraft/modpacks> .
+
+Now you can add a `-e CF_SERVER_MOD=name_of_modpack.zip` to your command-line.
+
+    docker run -d -v /path/on/host:/data -e TYPE=CURSEFORGE \
+        -e CF_SERVER_MOD=SkyFactory_4_Server_4.1.0.zip \
+        -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
+
+If you want to keep the pre-download modpacks separate from your data directory,
+then you can attach another volume at a path of your choosing and reference that.
+The following example uses `/modpacks` as the container path as the pre-download area:
+
+    docker run -d -v /path/on/host:/data -v /path/to/modpacks:/modpacks \
+        -e TYPE=CURSEFORGE \
+        -e CF_SERVER_MOD=/modpacks/SkyFactory_4_Server_4.1.0.zip \
+        -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
+
+### Modpack data directory
+
+By default, CurseForge modpacks are expanded into the sub-directory `/data/FeedTheBeast` and executed from there. (The default location was chosen for legacy reasons, when Curse and FTB were maintained together.)
+
+The directory can be changed by setting `CF_BASE_DIR`, such as `-e CF_BASE_DIR=/data`.
+
+### Buggy start scripts
+
+Some modpacks have buggy or overly complex start scripts. You can avoid using the bundled start script and use this image's standard server-starting logic by adding `-e USE_MODPACK_START_SCRIPT=false`.
+
+### Fixing "unable to launch forgemodloader"
+
+If your server's modpack fails to load with an error [like this](https://support.feed-the-beast.com/t/cant-start-crashlanding-server-unable-to-launch-forgemodloader/6028/2):
+
+    unable to launch forgemodloader
+
+then you apply a workaround by adding this to the run invocation:
+
+    -e FTB_LEGACYJAVAFIXER=true

docs/types-and-platforms/mod-platforms/ftb.md

@@ -0,0 +1,41 @@
+# Feed the Beast
+
+!!! note
+    Requires one of the Ubuntu with Hotspot images listed in [the Java versions section](../../versions/java.md).
+
+[Feed the Beast application](https://www.feed-the-beast.com/) modpacks are supported by setting `MOD_PLATFORM` or `TYPE` to "FTBA"
+
+!!! note
+    The "A" at the end of "FTBA" is important. The value "FTB" used to be an alias for "CURSEFORGE".
+
+This mod platform type will automatically take care of downloading and installing the modpack and appropriate version of Forge, so the `VERSION` does not need to be specified.
+
+### Environment Variables:
+- `FTB_MODPACK_ID`: **required**, the numerical ID of the modpack to install. The ID can be located by [finding the modpack](https://www.feed-the-beast.com/modpack) and locating the ID in this part of the URL:
+
+  ```
+  https://www.feed-the-beast.com/modpacks/23-ftb-infinity-evolved-17
+                                          ^^
+  ```
+- `FTB_MODPACK_VERSION_ID`: optional, the numerical ID of the version to install. If not specified, the latest version will be installed. The "Version ID" can be obtained by hovering over a server file entry and grabbing [this ID in the URL](../../img/ftba-version-id-popup.png).
+
+- `FTB_FORCE_REINSTALL`: if the files become inconsistent, such as when accidentally removing them, the FTB can be forced to re-run by setting this to "true"
+
+### Upgrading
+
+If a specific `FTB_MODPACK_VERSION_ID` was not specified, simply restart the container to pick up the newest modpack version. If using a specific version ID, recreate the container with the new version ID.
+
+### Example
+
+The following example runs the latest version of [FTB Presents Direwolf20 1.12](https://ftb.neptunepowered.org/pack/ftb-presents-direwolf20-1-12/):
+
+``` shell
+docker run -d --name mc-ftb -e EULA=TRUE \
+  -e TYPE=FTBA -e FTB_MODPACK_ID=31 \
+  -p 25565:25565 \
+  itzg/minecraft-server:java8-multiarch
+```
+
+!!! note
+
+    Normally you will also add `-v` volume for `/data` since the mods and config are installed there along with world data.

docs/types-and-platforms/mod-platforms/modrinth-modpacks.md

@@ -0,0 +1,105 @@
+# Modrinth Modpacks
+
+[Modrinth Modpacks](https://modrinth.com/modpacks) can automatically be installed along with the required mod loader (Forge or Fabric) by setting `MOD_PLATFORM` or `TYPE` to "MODRINTH". Upgrading (and downgrading) takes care of cleaning up old files and upgrading (and downgrading) the mod loader.
+
+## Modpack project
+
+The desired modpack project is specified with the `MODRINTH_MODPACK` environment variable and must be one of:
+
+- The project "slug", which is located in the URL shown here:
+
+  ![](../../img/modrinth-project-slug.drawio.png)
+
+- The project ID, which is located in the bottom of the left panel, shown here
+
+  ![](../../img/modrinth-project-id.drawio.png)
+
+- The project page URL, such as <https://modrinth.com/modpack/cobblemon-fabric>. As described below, this can further be the page URL of a modpack's version page.
+
+- A custom URL of a hosted [mrpack file](https://support.modrinth.com/en/articles/8802351-modrinth-modpack-format-mrpack)
+
+- The container path to a local [mrpack file](https://support.modrinth.com/en/articles/8802351-modrinth-modpack-format-mrpack)
+
+## Modpack version
+
+The automatic modpack version resolving can be narrowed in a few ways:
+
+The latest release or beta version, respectively, of the Modrinth modpack is selected when `VERSION` is "LATEST" or "SNAPSHOT". That can be overridden by setting `MODRINTH_DEFAULT_VERSION_TYPE` to "release", "beta", or "alpha".
+
+The resolved modpack version can be narrowed by setting `VERSION` to a specific Minecraft version, such as "1.19.2".
+
+The selected version can also be narrowed to a particular mod loader by setting `MODRINTH_LOADER` to either "forge", "fabric", or "quilt".
+
+Instead of auto resolving, a specific version of modpack file can be specified by passing the version's page URL to `MODRINTH_MODPACK`, such as <https://modrinth.com/modpack/cobblemon-fabric/version/1.3.2> or by setting `MODRINTH_VERSION` to the version ID or number located in the Metadata section, as shown here
+
+![](../../img/modrinth-version-id.drawio.png)
+
+## Ignore missing files
+
+Some mods, such as [MCInstance Loader](https://modrinth.com/mod/mcinstance-loader), use temporary files from the modpack and delete them when finished. In order to avoid the installer from detecting the absent file(s) and re-installing, those files can be ignored by passing a comma or newline delimited list to `MODRINTH_IGNORE_MISSING_FILES`.
+
+!!! example
+
+    In a Compose file
+    ```yaml
+      environment:
+        MODRINTH_IGNORE_MISSING_FILES: |
+          config/mcinstanceloader/pack.mcinstance
+    ```
+
+## Excluding files
+
+To exclude client mods that are incorrectly declared by the modpack as server-compatible, set `MODRINTH_EXCLUDE_FILES` to a comma or newline delimited list of partial file names to exclude. You may need to set `MODRINTH_FORCE_SYNCHRONIZE` to "true" while iterating on a compatible set of mods to use.
+
+!!! example
+
+    In a Compose file:
+    ```yaml
+      MODRINTH_EXCLUDE_FILES: |
+        notenoughanimations
+        lambdynamiclights
+        euphoriapatcher
+    ```
+
+## Force-include files
+
+To force include client mods, set `MODRINTH_FORCE_INCLUDE_FILES` to a comma or newline delimited list of partial file names. You may need to set `MODRINTH_FORCE_SYNCHRONIZE` to "true" while iterating on a compatible set of mods to use.
+
+!!! example
+
+    In a Compose file:
+    ```yaml
+      MODRINTH_FORCE_INCLUDE_FILES: |
+        yet-another-config-lib
+    ```
+
+## Excluding Overrides Files
+
+Modrinth mrpack/zip files may include an `overrides` subdirectory that contains config files, world data, and extra mod files. All of those files will be extracted into the `/data` path of the container. If any of those files, such as incompatible mods, need to be excluded from extraction, then the `MODRINTH_OVERRIDES_EXCLUSIONS` variable can be set with a comma or newline delimited list of ant-style paths ([see below](#ant-style-paths)) to exclude, relative to the overrides (or `/data`) directory.
+
+### Ant-style paths
+
+Ant-style paths can include the following globbing/wildcard symbols:
+
+| Symbol | Behavior                                                |
+|--------|---------------------------------------------------------|
+| `*`    | Matches zero, one, or many characters except a slash    |
+| `**`   | Matches zero, one, or many characters including slashes |
+| `?`    | Matches one character                                   |
+
+!!! example
+
+    The following compose `environment` entries show how to exclude Iris and Sodium mods from the overrides
+    
+    ```yaml
+      MODRINTH_OVERRIDES_EXCLUSIONS: mods/NekosEnchantedBooks-*.jar,mods/citresewn-*.jar
+    ```
+    
+    or using newline delimiter, which improves maintainability
+    
+    ```yaml
+      MODRINTH_OVERRIDES_EXCLUSIONS: |
+        mods/NekosEnchantedBooks-*.jar
+        mods/citresewn-*.jar
+    ```
+

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

@@ -0,0 +1,48 @@
+# Bukkit/Spigot
+
+Run a Bukkit/Spigot server type by setting the environment variable `TYPE` to "BUKKIT" or "SPIGOT".
+
+!!! example
+
+    Command-line
+    ```
+    docker run ... -e TYPE=SPIGOT ...
+    ```
+    
+    Compose
+    ```yaml
+        environment:
+          ...
+          TYPE: SPIGOT
+    ```
+
+If the downloaded server jar is corrupted, set `FORCE_REDOWNLOAD` to "true" to force a re-download during next container startup. After successfully re-downloading, you should remove that or set to "false".
+
+If you are hosting your own copy of Bukkit/Spigot you can override the download URLs with:
+
+- -e BUKKIT_DOWNLOAD_URL=<url>
+- -e SPIGOT_DOWNLOAD_URL=<url>
+
+!!! note
+
+    Some of the `VERSION` values are not as intuitive as you would think, so make sure to click into the version entry to find the **exact** version needed for the download. For example, "1.8" is not sufficient since their download naming expects `1.8-R0.1-SNAPSHOT-latest` exactly.
+
+## Build from source
+
+You can build spigot from source by setting the environment variable `BUILD_FROM_SOURCE` to "true".
+
+## Alternatives
+
+### Canyon
+
+[Canyon](https://github.com/canyonmodded/canyon) is a fork of CraftBukkit for Minecraft Beta 1.7.3. It includes multiple enhancements whilst also retaining compatibility with old Bukkit plugins and mods as much as possible.
+
+    -e VERSION=b1.7.3 -e TYPE=CANYON
+
+!!! important
+    Only `VERSION=b1.7.3` is supported. Since that version pre-dates the health check mechanism used by this image, that will need to be disabled by setting `DISABLE_HEALTHCHECK=true`.
+
+Canyon is on a temporary hiatus, so by default the final build from GitHub will be used; however, a specific build number can be selected in some instances by setting `CANYON_BUILD`, such as
+
+    -e CANYON_BUILD=6
+    -e CANYON_BUILD=26

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

@@ -0,0 +1,27 @@
+Enable [Fabric server](https://fabricmc.net/) mode by adding a `-e TYPE=FABRIC` to your command-line.
+
+```
+docker run -d -v /path/on/host:/data \
+    -e TYPE=FABRIC \
+    -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
+```
+
+By default, the container will install the latest [fabric server launcher](https://fabricmc.net/use/server/), using the latest [fabric-loader](https://fabricmc.net/wiki/documentation:fabric_loader) against the minecraft version you have defined with `VERSION` (defaulting to the latest vanilla release of the game).
+
+A specific loader or launcher version other than the latest can be requested using `FABRIC_LOADER_VERSION` and `FABRIC_LAUNCHER_VERSION` respectively, such as:
+
+```
+docker run -d -v /path/on/host:/data ... \
+    -e TYPE=FABRIC \
+    -e FABRIC_LAUNCHER_VERSION=0.10.2 \
+    -e FABRIC_LOADER_VERSION=0.13.1
+```
+
+!!! note
+
+    If you wish to use an alternative launcher you can:  
+
+    - Provide the path to a custom launcher jar available to the container with `FABRIC_LAUNCHER`, relative to `/data` (such as `-e FABRIC_LAUNCHER=fabric-server-custom.jar`)
+    - Provide the URL to a custom launcher jar with `FABRIC_LAUNCHER_URL` (such as `-e FABRIC_LAUNCHER_URL=http://HOST/fabric-server-custom.jar`)
+
+See the [Working with mods and plugins](../../mods-and-plugins/index.md) section to set up Fabric mods and configuration.

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

@@ -0,0 +1,57 @@
+A [Forge server](http://www.minecraftforge.net/) can be automatically downloaded, upgraded, and run by setting the environment variable `TYPE` to "FORGE".
+
+!!! example
+
+    ```
+    docker run -e TYPE=FORGE ...
+    ```
+    
+    or in a compose file
+    ```yaml
+        environment:
+          TYPE: FORGE
+    ```
+
+The overall version is specified by `VERSION`, [as described in the section above](../../versions/minecraft.md) and provides the same benefits of upgrading as new versions are released. By default, the recommended version of Forge for that Minecraft version will be selected. The latest version can be selected instead by setting the environment variable `FORGE_VERSION` to "latest". You can also choose a specific Forge version by setting `FORGE_VERSION` with that version, such as "14.23.5.2854".
+
+!!! example
+
+    ```
+    docker run -e TYPE=FORGE -e VERSION=1.12.2 -e FORGE_VERSION=14.23.5.2854 ...
+    ```
+    
+    or in a compose file
+    ```yaml
+        environment:
+          TYPE: FORGE
+          VERSION: "1.12.2"
+          FORGE_VERSION: "14.23.5.2854"
+    ```
+
+To use a pre-downloaded Forge installer, place it in a location mounted into the container and specify the container path with `FORGE_INSTALLER`. To download a Forge installer from a custom location, such as your own file repository, specify the URL with `FORGE_INSTALLER_URL`.
+
+In both of the cases above, there is no need for the `VERSION` or `FORGE_VERSION` variables.
+
+!!! note
+
+    If an error occurred while installing Forge, it might be possible to resolve by temporarily setting `FORGE_FORCE_REINSTALL` to "true". Be sure to remove that variable after successfully starting the server.
+
+## Alternatives
+
+### NeoForge
+
+Support for [NeoForge](https://neoforged.net/) is also provided. A NeoForge server can be automatically managed by setting `TYPE` to "NEOFORGE". `VERSION` specifies the Minecraft version and `NEOFORGE_VERSION` can be set to select a specific version, "latest", or "beta". By default, the latest, non-beta NeoForge version available for the requested Minecraft version will be used.
+
+!!! example
+
+    ```
+    docker run -e TYPE=NEOFORGE -e VERSION=1.20.1 -e NEOFORGE_VERSION=47.1.79 ...
+    ```
+    
+    or in a compose file
+    ```yaml
+        environment:
+          TYPE: NEOFORGE
+          VERSION: "1.20.4"
+          NEOFORGE_VERSION: "beta"
+    ```

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

@@ -0,0 +1,58 @@
+
+
+### Magma
+
+A [Magma](https://magmafoundation.org/) server, which is a combination of Forge and PaperMC, can be used with
+
+    -e TYPE=MAGMA
+
+!!! note
+
+    The Magma project has been terminated ([original link died](https://git.magmafoundation.org/magmafoundation/magma-1-20-x/-/commit/4e7abe37403c47d09b74b77bcfc26a19b18f5891), [alternate statement on their discord](https://discord.com/channels/612695539729039411/647287352833605662/1174412642962649198) ). Please use Magma Maintained for 1.12.2, 1.18.2 and 1.19.3, or Ketting for 1.20.1+.
+
+    There are limited base versions supported, so you will also need to  set `VERSION`, such as "1.12.2", "1.16.5", etc.
+
+### Magma Maintained
+A [Magma Maintained](https://github.com/magmamaintained/) server, which is a alternative project of Magma, can be used with
+
+    -e TYPE=MAGMA_MAINTAINED
+
+!!! note
+
+    There are limited base versions supported, so you will also need to set `VERSION`, such as "1.12.2", "1.18.2", "1.19.3", or "1.20.1".
+
+    In addition, `FORGE_VERSION` and `MAGMA_MAINTAINED_TAG` must be specified. You can find the supported `FORGE_VERSION` and `MAGMA_MAINTAINED_TAG` in a releases page for each repositories.
+
+### Ketting
+
+A [Ketting](https://github.com/kettingpowered/Ketting-1-20-x) server, which is an alternative project of Magma 1.20.1+, can be used with
+
+    -e TYPE=KETTING
+
+There are limited base versions supported, so you will also need to  set `VERSION`, such as "1.20.1" or later.
+
+`FORGE_VERSION` and `KETTING_VERSION` may be specified; however, they will be defaulted by the [Ketting launcher](https://github.com/kettingpowered/kettinglauncher) otherwise.
+Available Ketting Versions may be found at [https://github.com/kettingpowered/Ketting-1-20-x/packages/2041866/versions](https://github.com/kettingpowered/Ketting-1-20-x/packages/2041866/versions).
+The Version structure is `MinecraftVersion-ForgeVersion-KettingVersion` (e.g. `1.20.1-47.2.20-0.1.4` is for Minecraft `1.20.1`, Forge `47.2.20` and Ketting `0.1.4`).
+
+### Mohist
+
+A [Mohist](https://github.com/MohistMC/Mohist) server can be used with
+
+    -e TYPE=MOHIST
+
+!!! note
+
+    There are limited base versions supported, so you will also need to  set `VERSION`, such as "1.12.2"
+
+By default the latest build will be used; however, a specific build number can be selected by setting `MOHIST_BUILD`, such as
+
+    -e VERSION=1.16.5 -e MOHIST_BUILD=374
+
+### Catserver
+
+A [Catserver](http://catserver.moe/) type server can be used with
+
+    -e TYPE=CATSERVER
+
+> **NOTE** Catserver only provides a single release stream, so `VERSION` is ignored

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

@@ -0,0 +1,68 @@
+
+## SpongeVanilla
+
+Enable SpongeVanilla server mode by adding a `-e TYPE=SPONGEVANILLA` to your command-line.
+
+By default the container will run the latest `STABLE` version.
+If you want to run a specific version, you can add `-e SPONGEVERSION=1.11.2-6.1.0-BETA-19` to your command-line.
+
+Beware that current [Sponge](https://www.spongepowered.org) `STABLE` versions for Minecraft 1.12 require using [the Java 8 tag](../../versions/java.md):
+
+``` shell
+docker run -d -v /path/on/host:/data -e TYPE=SPONGEVANILLA \
+    -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server:java8-multiarch
+```
+
+You can also choose to use the `EXPERIMENTAL` branch.
+Just change it with `SPONGEBRANCH`, such as:
+
+``` shell
+$ docker run -d -v /path/on/host:/data ... \
+    -e TYPE=SPONGEVANILLA -e SPONGEBRANCH=EXPERIMENTAL ...
+```
+
+## Limbo
+
+A [Limbo](https://github.com/LOOHP/Limbo) server can be run by setting `TYPE` to `LIMBO`.
+
+Configuration options with defaults:
+
+- `LIMBO_BUILD`=LATEST
+
+  The `VERSION` will be ignored so locate the appropriate value from [here](https://ci.loohpjames.com/job/Limbo/) to match the version expected by clients.
+
+- `FORCE_REDOWNLOAD`=false
+- `LIMBO_SCHEMA_FILENAME`=default.schem
+- `LEVEL`="Default;${LIMBO_SCHEMA_NAME}"
+
+!!! note
+
+    Instead of using format codes in the MOTD, Limbo requires [JSON chat content](https://minecraft.wiki/w/Raw_JSON_text_format#Java_Edition). If a plain string is provided, which is the default, then it gets converted into the required JSON structure. 
+
+## Crucible
+
+A [Crucible](https://github.com/CrucibleMC/Crucible) server can be run by setting `TYPE` to `CRUCIBLE`.
+
+Configuration options with defaults:
+
+- `CRUCIBLE_RELEASE`=latest
+
+Crucible is only available for 1.7.10, so be sure to set `VERSION=1.7.10`.
+
+## Custom
+
+To use a custom server jar or class files, set `TYPE` to "CUSTOM" and continue with one of the following options:
+
+The custom jar to be used can be set with `CUSTOM_SERVER` as either a URL to download or the path to a file within the container.
+
+Alternatively, the final `-jar` invocation can be replaced by setting `CUSTOM_JAR_EXEC` to "`-cp <classpath> <classname>`" or "`-jar <jar file>`" form, such as
+
+```
+-cp worldedit.jar:Carpet-Server.jar net.minecraft.server.MinecraftServer
+```
+
+!!! note
+
+    When using `docker run` make sure to quote the entire value since it has spaces in it, such as
+
+        -e CUSTOM_JAR_EXEC="-cp worldedit.jar:Carpet-Server.jar net.minecraft.server.MinecraftServer"

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

@@ -0,0 +1,75 @@
+A [PaperMC server](https://papermc.io/) can be automatically downloaded, upgraded, and run by setting the environment variable TYPE to "PAPER".
+
+By default, the container will find and download the latest build for the `VERSION` chosen. If `VERSION` is not specified, then the latest Minecraft version released by PaperMC is selected. Along with a specific `VERSION`, a specific Paper build can be selected by setting the environment variable `PAPER_BUILD`. 
+
+To allow for the selection of experimental builds, set `PAPER_CHANNEL` to "experimental", otherwise only release/default channel builds are selected.
+
+!!! example
+
+    ```
+    docker run ... -e TYPE=PAPER ... 
+    
+    docker run ... -e TYPE=PAPER -e VERSION=1.20.6 ... 
+    
+    docker run ... -e TYPE=PAPER -e VERSION=1.20.6 -e PAPER_BUILD=140 ... 
+    
+    docker run ... -e TYPE=PAPER -e PAPER_CHANNEL=experimental ... 
+    ```
+
+If you are hosting your own copy of Paper you can override the download URL with `PAPER_DOWNLOAD_URL=<url>`.
+
+If you have attached a host directory to the `/data` volume, then you can install plugins via the `plugins` subdirectory. You can also [attach a `/plugins` volume](../../mods-and-plugins/index.md#optional-plugins-mods-and-config-attach-points). If you add plugins while the container is running, you'll need to restart it to pick those up.
+
+[You can also auto-download plugins using `SPIGET_RESOURCES`.](../../mods-and-plugins/spiget.md)
+
+## Alternatives
+
+### Pufferfish
+
+A [Pufferfish](https://github.com/pufferfish-gg/Pufferfish) server, which is "a highly optimized Paper fork designed for large servers requiring both maximum performance, stability, and "enterprise" features."
+
+    -e TYPE=PUFFERFISH
+
+!!! note
+
+    The `VERSION` variable is used to select branch latest, 1.18, or 1.17. Use PUFFERFISH_BUILD to really select the SERVER VERSION number.
+
+Extra variables:
+- `PUFFERFISH_BUILD=lastSuccessfulBuild` : set a specific Pufferfish build to use. Example: selecting build 47 => 1.18.1, or build 50 => 1.18.2 etc
+- `FORCE_REDOWNLOAD=false` : set to true to force the located server jar to be re-downloaded
+- `USE_FLARE_FLAGS=false` : set to true to add appropriate flags for the built-in [Flare](https://blog.airplane.gg/flare) profiler
+
+### Purpur
+
+A [Purpur](https://purpurmc.org/) server, which is "a drop-in replacement for Paper servers designed for configurability and new, fun, exciting gameplay features."
+
+    -e TYPE=PURPUR
+
+!!! note
+
+    The `VERSION` variable is used to lookup a build of Purpur to download
+
+Extra variables:
+- `PURPUR_BUILD=LATEST` : set a specific Purpur build to use
+- `FORCE_REDOWNLOAD=false` : set to true to force the located server jar to be re-downloaded
+- `USE_FLARE_FLAGS=false` : set to true to add appropriate flags for the built-in [Flare](https://blog.airplane.gg/flare) profiler
+- `PURPUR_DOWNLOAD_URL=<url>` : set URL to download Purpur from custom URL.
+
+### Folia
+
+Enable Folia server mode by adding a `-e TYPE=FOLIA` to your command-line.
+
+By default, the container will run the latest build of [Folia server](https://papermc.io/downloads), but you can also choose to run a specific build with `-e FOLIABUILD=26`.
+
+    docker run -d -v /path/on/host:/data \
+        -e TYPE=FOLIA \
+        -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
+
+If you are hosting your own copy of Folia you can override the download URL with `FOLIA_DOWNLOAD_URL=<url>`.
+
+If you have attached a host directory to the `/data` volume, then you can install plugins via the `plugins` subdirectory. You can also [attach a `/plugins` volume](../../mods-and-plugins/index.md#optional-plugins-mods-and-config-attach-points). If you add plugins while the container is running, you'll need to restart it to pick those up.
+
+[You can also auto-download plugins using `SPIGET_RESOURCES`.](../../mods-and-plugins/spiget.md)
+
+!!! note
+    The Folia type inherits from the Paper type. Paper's variables will override the Folia ones.

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

@@ -0,0 +1,27 @@
+Enable [Quilt server](https://quiltmc.org/) mode by adding a `-e TYPE=QUILT` to your command-line.
+
+```
+docker run -d -v /path/on/host:/data \
+    -e TYPE=QUILT \
+    -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
+```
+
+By default, the container will install the latest [quilt server launcher](https://quiltmc.org/install/server/), using the latest [quilt-installer](https://github.com/QuiltMC/quilt-installer) against the minecraft version you have defined with `VERSION` (defaulting to the latest vanilla release of the game).
+
+A specific loader or installer version other than the latest can be requested using `QUILT_LOADER_VERSION` and `QUILT_INSTALLER_VERSION` respectively, such as:
+
+```
+docker run -d -v /path/on/host:/data ... \
+    -e TYPE=QUILT \
+    -e QUILT_LOADER_VERSION=0.16.0 \
+    -e QUILT_INSTALLER_VERSION=0.4.1
+```
+
+!!! note
+
+    If you wish to use an alternative launcher you can: 
+
+    - Provide the path to a custom launcher jar available to the container with `QUILT_LAUNCHER`, relative to `/data` (such as `-e QUILT_LAUNCHER=quilt-server-custom.jar`)
+    - Provide the URL to a custom launcher jar with `QUILT_LAUNCHER_URL` (such as `-e QUILT_LAUNCHER_URL=http://HOST/quilt-server-custom.jar`)
+
+See the [Working with mods and plugins](../../mods-and-plugins/index.md) section to set up Quilt mods and configuration.

docs/variables.md

@@ -0,0 +1,812 @@
+
+!!! warning
+
+    The variables listed on this page are manually documented and may be out-of-date or inaccurate. 
+
+    All other documentation pages are actively maintained, so please use the search box above to find the desired topic.
+
+### General options
+<table>
+    <thead>
+        <tr>
+            <th>NAME</th>
+            <th>DESCRIPTION</th>
+            <th>DEFAULT</th>
+            <th>REQUIRED</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td><code>UID</code></td>
+            <td>The linux user id to run as</td>
+            <td><code>1000</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>GID</code></td>
+            <td>The linux group id to run as</td>
+            <td><code>1000</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>MEMORY</code></td>
+            <td>The image declares an initial and maximum Java memory-heap limit of 1 GB.</td>
+            <td><code>1G</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>INIT_MEMORY</code></td>
+            <td>Independently sets the initial heap size</td>
+            <td><code>1G</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>MAX_MEMORY</code></td>
+            <td>independently sets the max heap size</td>
+            <td><code>1G</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>TZ</code></td>
+            <td>You can configure the timezone to match yours by setting the TZ environment variable.  
+
+alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
+
+/etc/timezone:/etc/timezone:ro</code>
+            </td>
+            <td><code>UTC</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>ENABLE_ROLLING_LOGS</code></td>
+            <td>By default the vanilla log file will grow without limit. The logger can be reconfigured to use a rolling log files strategy by setting this to <code>true</code></td>
+            <td><code>false</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>ENABLE_JMX</code></td>
+            <td>To enable remote JMX, such as for profiling with VisualVM or JMC, add the environment variable ENABLE_JMX=true</td>
+            <td><code>false</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>JMX_HOST</code></td>
+            <td>If JMX is enabled, set JMX_HOST to the IP/host running the Docker container, and add a port forwarding of TCP port 7091</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>USE_AIKAR_FLAGS</code></td>
+            <td><a href="https://aikar.co/2018/07/02/tuning-the-jvm-g1gc-garbage-collector-flags-for-minecraft/">Aikar has done some research</a> into finding the optimal JVM flags for GC tuning, which becomes more important as more users are connected concurrently</td>
+            <td><code>false</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>JVM_OPTS</code></td>
+            <td>General JVM options can be passed to the Minecraft Server invocation by passing a <code>JVM_OPTS</code> environment variable. The JVM requires -XX options to precede -X options, so those can be declared in <code>JVM_XX_OPTS</code>. Both variables are space-delimited, raw JVM arguments</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>JVM_XX_OPTS</code></td>
+            <td>General JVM options can be passed to the Minecraft Server invocation by passing a <code>JVM_OPTS</code> environment variable. The JVM requires -XX options to precede -X options, so those can be declared in <code>JVM_XX_OPTS</code>. Both variables are space-delimited, raw JVM arguments</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>JVM_DD_OPTS</code></td>
+            <td>As a shorthand for passing several system properties as -D arguments, you can instead pass a comma separated list of name=value or name:value pairs with JVM_DD_OPTS. (The colon syntax is provided for management platforms like Plesk that don't allow = inside a value.)</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>EXTRA_ARGS</code></td>
+            <td>Arguments that would usually be passed to the jar file (those which are written after the filename)</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>LOG_TIMESTAMP </code></td>
+            <td>To include the timestamp with each log set to <code>true</code></td>
+            <td><code>false</code></td>
+            <td>⬜️</td>
+        </tr>
+    </tbody>
+</table>
+
+### Server
+
+<table>
+    <thead>
+        <tr>
+            <th>NAME</th>
+            <th>DESCRIPTION</th>
+            <th>DEFAULT</th>
+            <th>REQUIRED</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td><code>TYPE</code></td>
+            <td>The server <a href="../types-and-platforms/">type</a></td>
+            <td><code>VANILLA</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>EULA</code></td>
+            <td>You <strong>MUST</strong> set this to <code>true</code></td>
+            <td><code>&nbsp;</code></td>
+            <td>✅</td>
+        </tr>
+        <tr>
+            <td><code>VERSION</code></td>
+            <td>The minecraft version</td>
+            <td><code>LATEST</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>MOTD</code></td>
+            <td>Set the server log in message.</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>DIFFICULTY</code></td>
+            <td>The difficulty level. Available values: <code>peaceful</code>,<code>easy</code>,<code>normal</code>,<code>hard</code></td>
+            <td><code>easy</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>ICON</code></td>
+            <td>The url or file path for the icon image to use for the server. It will be downloaded, scaled, and converted to the proper format.</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>OVERRIDE_ICON</code></td>
+            <td>The server icon which has been set doesn't get overridden by default. Set this to <code>TRUE</code> to override the icon</td>
+            <td><code>FALSE</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>MAX_PLAYERS</code></td>
+            <td>The maximum number of players that can join the server.</td>
+            <td><code>20</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>MAX_WORLD_SIZE</code></td>
+            <td>The maximum possible size in blocks, expressed as a radius.</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>ALLOW_NETHER</code></td>
+            <td>Allows players to travel to the Nether</td>
+            <td><code>true</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>ANNOUNCE_PLAYER_ACHIEVEMENTS</code></td>
+            <td>Allows server to announce when a player gets an achievement.</td>
+            <td><code>true</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>ENABLE_COMMAND_BLOCK</code></td>
+            <td>Enables the command blocks.</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>FORCE_GAMEMODE</code></td>
+            <td>Force players to join in the default game mode.</td>
+            <td><code>false</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>GENERATE_STRUCTURES</code></td>
+            <td>Defines whether structures (such as villages) will be generated.</td>
+            <td><code>true</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>HARDCORE</code></td>
+            <td>If set to <code>true</code>, players will be set to spectator mode if they die.</td>
+            <td><code>false</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>SNOOPER_ENABLED</code></td>
+            <td>If set to false, the server will not send data to snoop.minecraft.net server.</td>
+            <td><code>true</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>MAX_BUILD_HEIGHT</code></td>
+            <td>The maximum height in which building is allowed. Terrain may still naturally generate above a low height limit.</td>
+            <td><code>256</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>SPAWN_ANIMALS</code></td>
+            <td>Determines if animals will be able to spawn.</td>
+            <td><code>true</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>SPAWN_MONSTERS</code></td>
+            <td>Determines if monsters will be spawned.</td>
+            <td><code>true</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>SPAWN_NPCS</code></td>
+            <td>Determines if villagers will be spawned.</td>
+            <td><code>true</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>SPAWN_PROTECTION</code></td>
+            <td>Sets the area that non-ops can not edit (0 to disable)</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>VIEW_DISTANCE</code></td>
+            <td>Sets the amount of world data the server sends the client, measured in chunks in each direction of the player (radius, not diameter). It determines the server-side viewing distance.</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>SEED</code></td>
+            <td>Sets the seed to create the Minecraft world. If you use a negative number, make sure that it is in quotes.</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>MODE</code></td>
+            <td>Minecraft servers are configured to run in Survival mode by default. You can change the mode using MODE where you can either provide the <a href="http://minecraft.wiki/Game_mode#Game_modes">standard numerical values</a> or the shortcut values:<br />
+            <ul>
+                <li>creative</li>
+                <li>survival</li>
+                <li>adventure</li>
+                <li>spectator(minecraft 1.8 or later)</li>
+            </ul></td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>PVP</code></td>
+            <td>By default, servers are created with player-vs-player (PVP) mode enabled.</td>
+            <td><code>true</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>LEVEL_TYPE</code></td>
+            <td>By default, a standard world is generated with hills, valleys, water, etc. A different level type can be configured by setting LEVEL_TYPE to <a href="https://minecraft.wiki/w/Server.properties#level-type">an expected type listed here</a>.
+            </td>
+            <td><code>minecraft:default</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>GENERATOR_SETTINGS</code></td>
+            <td>For some of the level types, <code>GENERATOR_SETTINGS</code> can be used to further customize the world generation <a href="https://minecraft.wiki/w/Server.properties#generator-settings">as described here</a>.</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>LEVEL</code></td>
+            <td>You can either switch between world saves or run multiple containers with different saves by using the LEVEL option</td>
+            <td><code>world</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>ONLINE_MODE</code></td>
+            <td>By default, server checks connecting players against Minecraft's account database. If you want to create an offline server or your server is not connected to the internet, you can disable the server to try connecting to minecraft.net to authenticate players</td>
+            <td><code>true</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>ALLOW_FLIGHT</code></td>
+            <td>Allows users to use flight on your server while in Survival mode, if they have a mod that provides flight installed.</td>
+            <td><code>FALSE</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>SERVER_NAME</code></td>
+            <td>The server name</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>SERVER_PORT</code></td>
+            <td>Only change this value if you know what you're doing. It is only needed when using host networking and it is rare that host networking should be used.</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>PLAYER_IDLE_TIMEOUT</code></td>
+            <td>player-idle-timeout</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>ENABLE_JMX</code></td>
+            <td>enable-jmx-monitoring</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>SYNC_CHUNK_WRITES</code></td>
+            <td>sync-chunk-writes</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>ENABLE_STATUS</code></td>
+            <td>enable-status</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>ENTITY_BROADCAST_RANGE_PERCENTAGE</code></td>
+            <td>entity-broadcast-range-percentage</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>FUNCTION_PERMISSION_LEVEL</code></td>
+            <td>function-permission-level</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>NETWORK_COMPRESSION_THRESHOLD</code></td>
+            <td>network-compression-threshold</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>OP_PERMISSION_LEVEL</code></td>
+            <td>op-permission-level</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>PREVENT_PROXY_CONNECTIONS</code></td>
+            <td>prevent-proxy-connections</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>USE_NATIVE_TRANSPORT</code></td>
+            <td>use-native-transport</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>SIMULATION_DISTANCE</code></td>
+            <td>simulation-distance</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>EXEC_DIRECTLY</code></td>
+            <td>If you would like to docker attach to the Minecraft server console with color and interactive capabilities, then set to <code>true</code></td>
+            <td><code>false</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>STOP_SERVER_ANNOUNCE_DELAY</code></td>
+            <td>To allow time for players to finish what they're doing during a graceful server shutdown, set <code>STOP_SERVER_ANNOUNCE_DELAY</code> to a number of seconds to delay after an announcement is posted by the server.</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>PROXY</code></td>
+            <td>You may configure the use of an HTTP/HTTPS proxy by passing the proxy's URL</td>
+            <td><code>false</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>CONSOLE</code></td>
+            <td>Some older versions (pre-1.14) of Spigot required <code>--noconsole</code> to be passed when detaching stdin</td>
+            <td><code>TRUE</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>GUI</code></td>
+            <td>Some older servers get confused and think that the GUI interface is enabled.</td>
+            <td><code>TRUE</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>STOP_DURATION</code></td>
+            <td>When the container is signalled to stop, the Minecraft process wrapper will attempt to send a "stop" command via RCON or console and waits for the process to gracefully finish.</td>
+            <td><code>60</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>SETUP_ONLY</code></td>
+            <td>If you are using a host-attached data directory, then you can have the image setup the Minecraft server files and stop prior to launching the server process by setting this to <code>true</code></td>
+            <td><code>false</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>USE_FLARE_FLAGS</code></td>
+            <td>To enable the JVM flags required to fully support the <a href="https://blog.airplane.gg/flare">Flare profiling suite</a>.</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>USE_SIMD_FLAGS</code></td>
+            <td>Support for optimized SIMD operation</td>
+            <td><code>false</code></td>
+            <td>⬜️</td>
+        </tr>
+        <!-- <tr>
+            <td><code></code></td>
+            <td></td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr> -->
+    </tbody>
+</table>
+
+### Custom resource pack
+
+<table>
+    <thead>
+        <tr>
+            <th>NAME</th>
+            <th>DESCRIPTION</th>
+            <th>DEFAULT</th>
+            <th>REQUIRED</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td><code>RESOURCE_PACK</code></td>
+            <td>A link to a custom resource pack</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>RESOURCE_PACK_SHA1</code></td>
+            <td>The checksum for the custom resource pack</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>RESOURCE_PACK_ENFORCE</code></td>
+            <td>Enforce the resource pack on clients</td>
+            <td><code>FALSE</code></td>
+            <td>⬜️</td>
+        </tr>
+    </tbody>
+</table>
+
+### Whitelist
+
+<table>
+    <thead>
+        <tr>
+            <th>NAME</th>
+            <th>DESCRIPTION</th>
+            <th>DEFAULT</th>
+            <th>REQUIRED</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td><code>ENABLE_WHITELIST</code></td>
+            <td>Enable the whitelist to manually manage the whitelist</td>
+            <td><code>false</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>WHITELIST</code></td>
+            <td>A list of usernames and/or UUIDs separated by comma</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>WHITELIST_FILE</code></td>
+            <td>A url or file path to a whitelist <code>json</code> formatted file.</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>OVERRIDE_WHITELIST</code></td>
+            <td>Enforce regeneration of the whitelist on each server startup.</td>
+            <td><code>false</code></td>
+            <td>⬜️</td>
+        </tr>
+    </tbody>
+</table>
+
+### RCON
+
+<table>
+    <thead>
+        <tr>
+            <th>NAME</th>
+            <th>DESCRIPTION</th>
+            <th>DEFAULT</th>
+            <th>REQUIRED</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td><code>ENABLE_RCON</code></td>
+            <td>Enable/disable RCON support; however, be aware that disabling RCON will remove and limit some features, such as interactive and color console support.</td>
+            <td><code>true</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>RCON_PASSWORD</code></td>
+            <td>You <strong>MUST</strong> change this value</td>
+            <td><code>Randomly generated</code></td>
+            <td>✅</td>
+        </tr>
+        <tr>
+            <td><code>RCON_PORT</code></td>
+            <td>The port for RCON</td>
+            <td><code>25575</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>BROADCAST_RCON_TO_OPS</code></td>
+            <td>Sets broadcast-rcon-to-ops server property</td>
+            <td><code>false</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>RCON_CMDS_STARTUP</code></td>
+            <td>RCON commands can be configured to execute when the server starts, a client connects, or a client disconnects</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>RCON_CMDS_ON_CONNECT</code></td>
+            <td>RCON commands can be configured to execute when the server starts, a client connects, or a client disconnects</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>RCON_CMDS_ON_DISCONNECT</code></td>
+            <td>RCON commands can be configured to execute when the server starts, a client connects, or a client disconnects</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>RCON_CMDS_LAST_DISCONNECT</code></td>
+            <td>RCON commands can be configured to execute when the server starts, a client connects, or a client disconnects</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>RCON_CMDS_STARTUP</code></td>
+            <td>RCON commands can be configured to execute when the server starts, a client connects, or a client disconnects</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+    </tbody>
+</table>
+
+### Auto-Pause
+
+!!! note
+
+    Autopause is not compatible with `EXEC_DIRECTLY=true` and the two cannot be set together.
+
+<table>
+    <thead>
+        <tr>
+            <th>NAME</th>
+            <th>DESCRIPTION</th>
+            <th>DEFAULT</th>
+            <th>REQUIRED</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td><code>ENABLE_AUTOPAUSE</code></td>
+            <td>Enable the Autopause functionality</td>
+            <td><code>FALSE</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>AUTOPAUSE_TIMEOUT_EST</code></td>
+            <td>describes the time between the last client disconnect and the pausing of the process</td>
+            <td><code>3600</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>AUTOPAUSE_TIMEOUT_INIT</code></td>
+            <td>describes the time between server start and the pausing of the process, when no client connects in-between</td>
+            <td><code>600</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>AUTOPAUSE_TIMEOUT_KN</code></td>
+            <td>describes the time between knocking of the port (e.g. by the main menu ping) and the pausing of the process, when no client connects in-between</td>
+            <td><code>120</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>AUTOPAUSE_PERIOD</code></td>
+            <td>describes period of the daemonized state machine, that handles the pausing of the process</td>
+            <td><code>10</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>AUTOPAUSE_KNOCK_INTERFACE</code></td>
+            <td>Describes the interface passed to the knockd daemon. If the default interface does not work, run the ifconfig command inside the container and derive the interface receiving the incoming connection from its output. The passed interface must exist inside the container. Using the loopback interface (lo) does likely not yield the desired results.</td>
+            <td><code>eth0</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>DEBUG_AUTOPAUSE</code></td>
+            <td>Adds additional debugging output for AutoPause</td>
+            <td><code>false</code></td>
+            <td>⬜️</td>
+        </tr>
+    </tbody>
+</table>
+
+
+
+### Auto-Stop
+
+!!! note
+
+    AutoStop function is incompatible with the Autopause functionality, as they basically cancel out each other.
+
+<table>
+    <thead>
+        <tr>
+            <th>NAME</th>
+            <th>DESCRIPTION</th>
+            <th>DEFAULT</th>
+            <th>REQUIRED</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td><code>ENABLE_AUTOSTOP</code></td>
+            <td>Enable the AutoStop functionality</td>
+            <td><code>FALSE</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>AUTOSTOP_TIMEOUT_EST</code></td>
+            <td>describes the time between the last client disconnect and the stopping of the server</td>
+            <td><code>3600</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>AUTOSTOP_TIMEOUT_INIT</code></td>
+            <td>describes the time between server start and the stopping of the server, when no client connects in-between</td>
+            <td><code>1800</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>AUTOSTOP_PERIOD</code></td>
+            <td>describes period of the daemonized state machine, that handles the stopping of the serve</td>
+            <td><code>10</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>DEBUG_AUTOSTOP</code></td>
+            <td>Adds additional logging for AutoStop</td>
+            <td><code>false</code></td>
+            <td>⬜️</td>
+        </tr>
+    </tbody>
+</table>
+
+
+### CurseForge
+
+!!! tip
+    
+    Refer to the [main documentation page](types-and-platforms/mod-platforms/auto-curseforge.md) for more details and up-to-date information.
+
+<table>
+    <thead>
+        <tr>
+            <th>NAME</th>
+            <th>DESCRIPTION</th>
+            <th>DEFAULT</th>
+            <th>REQUIRED</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td><code>CF_API_KEY</code></td>
+            <td><strong>YOUR</strong> CurseForge (Eternal) API Key.</td>
+            <td><code></code></td>
+            <td>✅</td>
+        </tr>
+        <tr>
+            <td><code>CF_PAGE_URL</code></td>
+            <td>Pass a page URL to the modpack or a specific file</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>CF_SLUG</code></td>
+            <td>Instead of a URL, the modpack slug can be provided.</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>CF_FILE_ID</code></td>
+            <td>The mod curseforge numerical ID.</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>CF_FILENAME_MATCHER</code></td>
+            <td>Specify a substring to match the desired filename</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>CF_EXCLUDE_INCLUDE_FILE</code></td>
+            <td>Global and per modpack exclusions can be declared in a JSON file and referenced with this variable. <br /><br />By default, the <a href="https://github.com/itzg/docker-minecraft-server/blob/master/files/cf-exclude-include.json">file bundled with the image</a> will be used, but can be disabled by setting this to an empty string. The schema of this file is <a href="https://github.com/itzg/mc-image-helper#excludeinclude-file-schema">documented here</a>.</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>CF_EXCLUDE_MODS</code></td>
+            <td>Mods can be excluded by passing a comma or space delimited list of project slugs or IDs</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>CF_FORCE_INCLUDE_MODS</code></td>
+            <td>Mods can be included by passing a comma or space delimited list of project slugs or IDs</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>CF_FORCE_SYNCHRONIZE</code></td>
+            <td>Forces the excludes/includes to be re-evaluated</td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>CF_SET_LEVEL_FROM</code></td>
+            <td>Some modpacks come with world/save data via a worlds file and/or the overrides provided with the modpack. Either approach can be selected to set the LEVEL to the resulting saves directory by setting this to either:
+            <ul>
+                <li>WORLD_FILE</li>
+                <li>OVERRIDES</li>
+            </ul></td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>CF_PARALLEL_DOWNLOADS</code></td>
+            <td>specify how many parallel mod downloads to perform</td>
+            <td><code>4</code></td>
+            <td>⬜️</td>
+        </tr>
+        <tr>
+            <td><code>CF_OVERRIDES_SKIP_EXISTING</code></td>
+            <td>if set, files in the overrides that already exist in the data directory are skipped. world data is always skipped, if present.</td>
+            <td><code>false</code></td>
+            <td>⬜️</td>
+        </tr>
+    </tbody>
+</table>
+
+<!-- ✅ ⬜️ -->
+<!-- <tr>
+            <td><code></code></td>
+            <td></td>
+            <td><code></code></td>
+            <td>⬜️</td>
+        </tr> -->

docs/versions/java.md

@@ -0,0 +1,137 @@
+## Image tags
+
+Image references can either omit the tag, which implies the tag `latest`, such as
+
+    itzg/minecraft-server
+
+or explicitly include the tag, such as
+
+    itzg/minecraft-server:<tag>
+
+where `<tag>` refers to the first column of this table:
+
+| Tag              | Java version | Linux  | JVM Type           | Architecture        |
+|------------------|--------------|--------|--------------------|---------------------|
+| latest           | 21           | Ubuntu | Hotspot            | amd64, arm64        |
+| stable           | 21           | Ubuntu | Hotspot            | amd64, arm64        |
+| java21           | 21           | Ubuntu | Hotspot            | amd64, arm64        |
+| java21-jdk       | 21           | Ubuntu | Hotspot+JDK        | amd64, arm64        |
+| java21-alpine    | 21           | Alpine | Hotspot            | amd64, arm64        |
+| java21-graalvm   | 21           | Oracle | Oracle GraalVM[^1] | amd64, arm64        |   
+| java17           | 17           | Ubuntu | Hotspot            | amd64, arm64, armv7 |
+| java17-graalvm   | 17           | Oracle | Oracle GraalVM[^1] | amd64, arm64        |   
+| java17-alpine    | 17           | Alpine | Hotspot            | amd64  (1)          |
+| java11           | 11           | Ubuntu | Hotspot            | amd64, arm64, armv7 |
+| java8            | 8            | Ubuntu | Hotspot            | amd64, arm64, armv7 |
+| java8-alpine     | 8            | Alpine | Hotspot            | amd64  (1)          |
+| java8-jdk        | 8            | Ubuntu | Hotspot+JDK        | amd64               |
+| java8-openj9     | 8            | Debian | OpenJ9             | amd64               |
+| java8-graalvm-ce | 8            | Oracle | GraalVM CE         | amd64               |
+
+1. Why no arm64 for Java 17 Alpine? That is because the base images, such as [elipse-temurin](https://hub.docker.com/_/eclipse-temurin/tags?page=&page_size=&ordering=&name=17-jre-alpine) do not provide support for that. Use the Ubuntu based images instead.
+
+!!! example "Example using java8"
+
+    With docker run command-line
+    
+    ```
+    docker run -it -e EULA=true itzg/minecraft-server:java8
+    ```
+    
+    or in a compose file
+    
+    ```yaml
+    services:
+      mc:
+        image: itzg/minecraft-server:java8
+    ```
+
+!!! note "Latest"
+
+    The "latest" tag shifts to include not only the latest features and bug fixes, but also the latest Java version that Mojang requires for the latest Minecraft version.
+
+!!! tip "Class File Version"
+
+    If the Minecraft startup is logging an error about a "class file version", then refer [to this table](https://javaalmanac.io/bytecode/versions/) to identify the JDK/Java version corresponding to each class file version.
+
+### Release versions
+
+Since the tags referenced above will shift as the newest image build brings in new features and bug fixes, released variants of those can also be used to pin a specific build of the image.
+
+The syntax of released image tags is:
+
+    itzg/minecraft-server:<release>-<java tag>
+
+where `java tag` still refers to the first column of the table above and `release` refers to [one of the image releases](https://github.com/itzg/docker-minecraft-server/releases).
+
+!!! example
+
+    For example, the 2024.4.0 release of the Java 17 image would be
+    
+    ```
+    itzg/minecraft-server:2024.4.0-java17
+    ```
+
+### Stable image tag
+
+The `stable` image tag combines the benefits of `latest` and [release versions](#release-versions) since it shifts to refer to the most recently released version.
+
+## Version compatibilities
+
+[This section in the Minecraft wiki](https://minecraft.wiki/w/Tutorials/Update_Java#Why_update?) lists out versions of **vanilla** Minecraft versions and the corresponding Java version that is required.
+
+### Class file version 65.0
+
+If encountering a startup failure similar to the following examples, then ensure that the latest image has been re-pulled to use a Java 21. Alternatively, set the image tag specifically to `itzg/minecraft-server:java21`.
+
+> Exception in thread "ServerMain" java.lang.UnsupportedClassVersionError: org/bukkit/craftbukkit/Main has been compiled by a more recent version of the Java Runtime (class file version 65.0), this version of the Java Runtime only recognizes class file versions up to 61.0
+
+or
+
+> Error: LinkageError occurred while loading main class net.minecraft.bundler.Main
+java.lang.UnsupportedClassVersionError: net/minecraft/bundler/Main has been compiled by a more recent version of the Java Runtime (class file version 65.0), this version of the Java Runtime only recognizes class file versions up to 61.0
+
+
+### Forge versions
+
+Forge and its mods sometimes utilize non-public APIs of the JVM and as such are suspceptible to becoming broken with newer Java versions.
+
+#### Java 21
+
+Some mods even up to Minecraft 1.21 require Java 17 and will not run on the latest Java version. If you see an error like the following then be sure to explicitly use a Java 17 tagged image:
+
+```
+Caused by: org.spongepowered.asm.mixin.throwables.ClassMetadataNotFoundException: java.util.List
+	at MC-BOOTSTRAP/org.spongepowered.mixin/org.spongepowered.asm.mixin.transformer.MixinPreProcessorStandard.transformMethod(MixinPreProcessorStandard.java:754)
+```
+
+#### Java 8
+
+For Forge versions less than 1.18, you _must_ use the `java8-multiarch` (or other java8) image tag.
+
+In general, if you see the following line in a server startup failure, then it means you need to be using Java 8 instead of the latest image Java version:
+
+```
+Caused by: java.lang.ClassCastException: class jdk.internal.loader.ClassLoaders$AppClassLoader 
+   cannot be cast to class java.net.URLClassLoader
+```
+
+Forge also doesn't support openj9 JVM implementation.
+
+## Deprecated Image Tags
+
+The following image tags have been deprecated and are no longer receiving updates:
+
+- java19
+- adopt13
+- adopt14
+- adopt15
+- openj9-nightly
+- multiarch-latest
+- java16/java16-openj9
+- java17-graalvm-ce
+- java17-openj9
+- java20-graalvm, java20, java20-alpine
+- java8-multiarch is still built and pushed, but please move to java8 instead
+
+[^1]: Based on the [Oracle GraalMV images](https://blogs.oracle.com/java/post/new-oracle-graalvm-container-images), which as of JDK 17, are now under the [GraalVM Free License](https://blogs.oracle.com/java/post/graalvm-free-license) incorporating what used to be known as the GraalVM Enterprise. 

docs/versions/minecraft.md

@@ -0,0 +1,26 @@
+To use a different Minecraft version, pass the `VERSION` environment variable (case sensitive), which can have the value
+
+- LATEST (the default)
+- SNAPSHOT
+- a specific version, such as "1.7.9"
+- or an alpha and beta version, such as "b1.7.3" (server download might not exist)
+
+For example, to use the latest snapshot:
+
+```
+docker run -d -e VERSION=SNAPSHOT ...
+```
+
+or a specific version:
+
+```
+docker run -d -e VERSION=1.7.9 ...
+```
+
+When using "LATEST" or "SNAPSHOT" an upgrade can be performed by simply restarting the container.
+During the next startup, if a newer version is available from the respective release channel, then
+the new server jar file is downloaded and used. 
+
+!!! note
+
+    Over time you might see older versions of the server jar remain in the `/data` directory. It is safe to remove those.

examples/.gitignore

@@ -0,0 +1,4 @@
+data/
+modpacks/
+.env
+downloads/

examples/aof7/docker-compose.yml

@@ -0,0 +1,37 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: true
+      MOD_PLATFORM: AUTO_CURSEFORGE
+      # from .env
+      CF_API_KEY: ${CF_API_KEY}
+      CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-of-fabric-7
+#      CF_FILENAME_MATCHER: 1.2.2
+      CF_OVERRIDES_EXCLUSIONS: |
+        mods/iris*.jar
+        mods/sodium*.jar
+      MEMORY: 4G
+    ports:
+      - "25565:25565"
+    volumes:
+      - mc-data:/data
+      - ./downloads:/downloads
+      # Manually download the following and put into the 'downloads' directory next to this compose file
+      #
+      #  Mod                          Filename                                   Download page
+      #  ===========================  =========================================  ====================================================================================
+      #  Fish of Thieves              [Fabric 1.20.1] Fish of Thieves v3.0.3     https://www.curseforge.com/minecraft/mc-mods/fish-of-thieves/files/4958329
+      #  Only Hammers [FORGE/FABRIC]  OnlyHammers-1.20.1-0.6-Fabric              https://www.curseforge.com/minecraft/mc-mods/only-hammers-forge-fabric/files/4832068
+      #  Sprinklerz                   sprinklerz-0.5_fabric.jar                  https://www.curseforge.com/minecraft/mc-mods/sprinklerz/files/4835664
+      #  Frog Legs (Fabric/Forge)     FrogLegs-v2.0.0-1.20.1-Fabric.jar          https://www.curseforge.com/minecraft/mc-mods/froglegs/files/4917818
+      #  TrimsEffects                 [FABRIC] TrimsEffects - MC 1.20.X - 1.1.0  https://www.curseforge.com/minecraft/mc-mods/trimseffects/files/4954156
+      #  Display Case                 Display Case-fabric-1.20-1.0.8.jar         https://www.curseforge.com/minecraft/mc-mods/displaycase/files/4921333
+      #  Structory: Towers            Structory Towers 1.20.4 v1.0.6             https://www.curseforge.com/minecraft/mc-mods/structory-towers/files/4937875
+      #  Packet Fixer                 Packet Fixer Fabric 1.2.1                  https://www.curseforge.com/minecraft/mc-mods/packet-fixer/files/4884316
+      #  Perfect Plushies             Perfect Plushies 1.9.0 [Fabric]            https://www.curseforge.com/minecraft/mc-mods/perfect-plushies/files/4985767
+      #  Structory                    Structory 1.20.2 v1.3.4                    https://www.curseforge.com/minecraft/mc-mods/structory/files/4937872
+
+volumes:
+  mc-data: {}
+

examples/atm8/docker-compose.yml

@@ -0,0 +1,45 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: "true"
+      MOD_PLATFORM: AUTO_CURSEFORGE
+      # allocate from https://console.curseforge.com/ and set in .env file
+      CF_API_KEY: ${CF_API_KEY}
+      CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-the-mods-8
+      CF_FILENAME_MATCHER: "1.0.6"
+      MEMORY: 4G
+    volumes:
+      - mc-data:/data
+      - ../downloads:/downloads
+  # Since Docker's default volume driver creates volumes owned by root, this
+  # init container will change ownership to match final UID of mc service, above
+  init-filebrowser:
+    image: filebrowser/filebrowser
+    entrypoint: sh -c
+    command:
+      - "chown -R 1000: /database"
+    restart: no
+    volumes:
+      - filebrowser-db:/database
+  filebrowser:
+    image: filebrowser/filebrowser
+    depends_on:
+      init-filebrowser:
+        condition: service_completed_successfully
+    user: "1000:1000"
+    environment:
+      FB_DATABASE: /database/filebrowser.db
+    volumes:
+      # Default FB_ROOT is /srv
+      # In this example, the left-side needs to be the same as /data volume of mc service
+      - mc-data:/srv
+      - filebrowser-db:/database
+    ports:
+      - "25580:80"
+
+volumes:
+  mc-data: {}
+  filebrowser-db: {}