build(deps): bump the updates group with 2 updates (#3085)

.github/workflows/build-multiarch.yml

@@ -98,7 +98,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v4.1.7
+        uses: actions/checkout@v4.2.0
         with:
           # for build-files step
           fetch-depth: 0
@@ -139,7 +139,7 @@ jobs:
         uses: docker/setup-qemu-action@v3.2.0
 
       - name: Build for test
-        uses: docker/build-push-action@v6.7.0
+        uses: docker/build-push-action@v6.8.0
         with:
           platforms: linux/amd64
           tags: ${{ env.IMAGE_TO_TEST }}
@@ -177,7 +177,7 @@ jobs:
           password: ${{ github.token }}
 
       - name: Build and push
-        uses: docker/build-push-action@v6.7.0
+        uses: docker/build-push-action@v6.8.0
         if: github.actor == github.repository_owner
         with:
           platforms: ${{ matrix.platforms }}

.github/workflows/verify-pr.yml

@@ -47,7 +47,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v4.1.7
+        uses: actions/checkout@v4.2.0
         with:
           # for build-files step
           fetch-depth: 0
@@ -56,7 +56,7 @@ jobs:
         uses: docker/setup-buildx-action@v3.6.1
 
       - name: Confirm multi-arch build
-        uses: docker/build-push-action@v6.7.0
+        uses: docker/build-push-action@v6.8.0
         with:
           platforms: ${{ matrix.platforms }}
           # ensure latest base image is used
@@ -66,7 +66,7 @@ jobs:
           cache-from: type=gha,scope=${{ matrix.variant }}
 
       - name: Build for test
-        uses: docker/build-push-action@v6.7.0
+        uses: docker/build-push-action@v6.8.0
         with:
           # Only build single platform since loading multi-arch image into daemon fails with
           # "docker exporter does not currently support exporting manifest lists"

Dockerfile

@@ -7,9 +7,14 @@ ARG TARGETOS
 ARG TARGETARCH
 ARG TARGETVARIANT
 
+# The following three arg/env vars get used by the platform specific "install-packages" script
+ARG EXTRA_DEB_PACKAGES=""
+ARG EXTRA_DNF_PACKAGES=""
+ARG EXTRA_ALPINE_PACKAGES=""
 ARG FORCE_INSTALL_PACKAGES=1
 RUN --mount=target=/build,source=build \
-    TARGET=${TARGETARCH}${TARGETVARIANT} /build/run.sh install-packages
+    TARGET=${TARGETARCH}${TARGETVARIANT} \
+    /build/run.sh install-packages
 
 RUN --mount=target=/build,source=build \
     /build/run.sh setup-user
@@ -21,31 +26,31 @@ EXPOSE 25565
 ARG APPS_REV=1
 ARG GITHUB_BASEURL=https://github.com
 
-ARG EASY_ADD_VERSION=0.8.7
+ARG EASY_ADD_VERSION=0.8.8
 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.4
+ARG RESTIFY_VERSION=1.7.5
 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.8
+ARG RCON_CLI_VERSION=1.6.9
 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.13
+ARG MC_MONITOR_VERSION=0.14.1
 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
+ARG MC_SERVER_RUNNER_VERSION=1.12.3
 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.11
+ARG MC_HELPER_VERSION=1.39.12
 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

build/alpine/install-packages.sh

@@ -4,6 +4,7 @@ set -e
 set -o pipefail
 
 # Install necessary packages
+# shellcheck disable=SC2086
 apk add --no-cache -U \
     openssl \
     imagemagick \
@@ -29,7 +30,8 @@ apk add --no-cache -U \
     nfs-utils \
     libpcap \
     libwebp \
-    libcap
+    libcap \
+    ${EXTRA_ALPINE_PACKAGES}
 
 # Download and install 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

build/ol/install-packages.sh

@@ -23,6 +23,7 @@ EOF
 dnf update -y
 
 # Install necessary packages
+# shellcheck disable=SC2086
 dnf install -y \
   ImageMagick \
   file \
@@ -44,7 +45,8 @@ dnf install -y \
   libpcap \
   libwebp \
   findutils \
-  which
+  which \
+  ${EXTRA_DNF_PACKAGES}
 
 # Install Git LFS
 curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.rpm.sh | sudo bash

build/ubuntu/install-packages.sh

@@ -6,6 +6,7 @@ set -euo pipefail
 
 # Update and install packages
 apt-get update
+# shellcheck disable=SC2086
 DEBIAN_FRONTEND=noninteractive \
 apt-get install -y \
   imagemagick \
@@ -26,7 +27,8 @@ apt-get install -y \
   zstd \
   lbzip2 \
   nfs-common \
-  libpcap0.8
+  libpcap0.8 \
+  ${EXTRA_DEB_PACKAGES}
 
 # Install Git LFS
 curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh | sudo bash

docs/misc/contributing/building.md

@@ -26,3 +26,11 @@ or just a plain build
 ```shell
 docker build -t IMG_PREFIX/minecraft-server .
 ```
+
+## Installing extra packages
+
+The following build args can be set to install additional packages for the respective base image distro:
+
+- `EXTRA_DEB_PACKAGES`
+- `EXTRA_DNF_PACKAGES`
+- `EXTRA_ALPINE_PACKAGES`

docs/requirements.txt

@@ -1,6 +1,6 @@
-mkdocs-material == 9.5.34
+mkdocs-material == 9.5.39
 mkdocs-autorefs == 1.2.0
-mkdocstrings == 0.26.0
+mkdocstrings == 0.26.1
 mkdocs-literate-nav == 0.6.1
 mdx-gh-links == 0.4
 mkdocs-click == 0.8.1

docs/variables.md

@@ -563,35 +563,35 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
             <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>
+			<td><code>RCON_CMDS_STARTUP</code></td>
+			<td>RCON commands to execute when the server starts.</td>
+			<td><code></code></td>
+			<td>⬜️</td>
+		</tr>
+		<tr>
+			<td><code>RCON_CMDS_ON_CONNECT</code></td>
+			<td>RCON commands to execute whenever a client connects to the server.</td>
+			<td><code></code></td>
+			<td>⬜️</td>
+		</tr>
+		<tr>
+			<td><code>RCON_CMDS_FIRST_CONNECT</code></td>
+			<td>RCON commands to execute on the first client connection to the server.</td>
+			<td><code></code></td>
+			<td>⬜️</td>
+		</tr>
+		<tr>
+			<td><code>RCON_CMDS_ON_DISCONNECT</code></td>
+			<td>RCON commands to execute whenever a client disconnects from the server.</td>
+			<td><code></code></td>
+			<td>⬜️</td>
+		</tr>
+		<tr>
+			<td><code>RCON_CMDS_LAST_DISCONNECT</code></td>
+			<td>RCON commands to execute when the last client disconnects from the server.</td>
+			<td><code></code></td>
+			<td>⬜️</td>
+		</tr>
     </tbody>
 </table>
 

examples/optimized-paper-config/README.md

@@ -0,0 +1,60 @@
+# A Form to Load New Config Files to Paper MC
+
+In this example, we illustrate how to efficiently load and manage different configuration files to optimize a Paper Minecraft server. To implement this, it is necessary to create a dedicated repository where the configuration files can be stored and later retrieved. The repository should adhere to a specific structure to facilitate seamless integration with your Docker setup. Notably, the configurations must be organized into a folder named after the version of Minecraft you are using.
+
+For reference, I have provided this [repository](https://github.com/Alpha018/paper-config-optimized), which contains optimized configuration files for the latest version of Minecraft. You can use this repository by linking directly to the configuration files in your Docker file, as demonstrated in the example below.
+
+## Usage
+
+You can directly use the optimized configuration files from this repository by accessing them through the GitHub raw URLs. Simply replace the env var like the docker compose with any other repo with different configurations.
+
+To use the raw files, you can download or link to them using the following pattern:
+
+```yaml
+services:
+  mc:
+    image: itzg/minecraft-server
+    container_name: paper
+    environment:
+      EULA: "true"
+      TYPE: "PAPER"
+      VIEW_DISTANCE: 10
+      MEMORY: 2G
+      PAPER_CONFIG_REPO: "https://raw.githubusercontent.com/[your-username]/[your-repository]/main/[file-path]"
+    ports:
+      - "25565:25565"
+    volumes:
+      - mc-paper:/data
+    restart: unless-stopped
+volumes:
+  mc-paper: {}
+```
+
+For example:
+
+```yaml
+services:
+  mc:
+    image: itzg/minecraft-server
+    container_name: paper
+    environment:
+      EULA: "true"
+      TYPE: "PAPER"
+      VIEW_DISTANCE: 10
+      MEMORY: 2G
+      PAPER_CONFIG_REPO: "https://raw.githubusercontent.com/Alpha018/paper-config-optimized/main"
+    ports:
+      - "25565:25565"
+    volumes:
+      - mc-paper:/data
+    restart: unless-stopped
+volumes:
+  mc-paper: {}
+```
+
+Feel free to explore and use the configurations in this repo to enhance your Minecraft server's performance.
+
+## Contribution
+
+If you'd like to improve or suggest changes to these configurations, feel free to submit a pull request in this [repository](https://github.com/Alpha018/paper-config-optimized). We welcome contributions from the community!
+

examples/optimized-paper-config/docker-compose.yml

@@ -0,0 +1,17 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    container_name: paper
+    environment:
+      EULA: "true"
+      TYPE: "PAPER"
+      VIEW_DISTANCE: 10
+      MEMORY: 2G
+      PAPER_CONFIG_REPO: "https://raw.githubusercontent.com/Alpha018/paper-config-optimized/main"
+    ports:
+      - "25565:25565"
+    volumes:
+      - mc-paper:/data
+    restart: unless-stopped
+volumes:
+  mc-paper: {}

scripts/start-deployPaper

@@ -10,7 +10,7 @@ handleDebugMode
 : "${PAPER_CHANNEL:=default}"
 : "${PAPER_DOWNLOAD_URL:=}"
 : "${PAPER_CUSTOM_JAR:=}"
-: "${PAPER_CONFIG_DEFAULTS_REPO:=https://raw.githubusercontent.com/dayyeeet/minecraft-default-configs/main}"
+: "${PAPER_CONFIG_DEFAULTS_REPO:=${PAPER_CONFIG_REPO:=https://raw.githubusercontent.com/dayyeeet/minecraft-default-configs/main}}"
 
 resultsFile=/data/.paper.env
 if [[ $PAPER_CUSTOM_JAR ]]; then