mirror of
https://github.com/itzg/docker-minecraft-server.git
synced 2026-05-21 19:25:25 +00:00
Compare commits
56 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 214002370e | |||
| 1e8aecd06e | |||
| 21920f3fe7 | |||
| 9352c45d6e | |||
| 3d4555557b | |||
| c95b638faa | |||
| fd823d6040 | |||
| 7656abeaa6 | |||
| a708715a9f | |||
| 5febc1ab5d | |||
| 6878ad6e01 | |||
| 889b607606 | |||
| f3b1d7ee93 | |||
| cdc2c7977e | |||
| 14d0be9430 | |||
| ffbd905ec4 | |||
| b35db38cd3 | |||
| 32696ae457 | |||
| 50155230bd | |||
| 14c8509bee | |||
| a44c717041 | |||
| 60ab277060 | |||
| 3393e65d6f | |||
| 4caed18ead | |||
| de5e99cfa1 | |||
| ff280ecf48 | |||
| d34111c3e3 | |||
| c660ac5e8f | |||
| a383184e92 | |||
| eb63433d35 | |||
| 5e1d166ba6 | |||
| 8745b36b89 | |||
| 97407c672f | |||
| e25de5dc05 | |||
| 59a2126192 | |||
| 5e2e26831e | |||
| 18d57981f5 | |||
| a5cd3a57fa | |||
| c692e99523 | |||
| 5f9bc3a414 | |||
| df7f067782 | |||
| 7b1cb53cda | |||
| dcfedaa10f | |||
| a9a27df4a6 | |||
| a2fbd4ce9a | |||
| eb4fe3c7bf | |||
| 8c9e2c653f | |||
| bd98fe57ba | |||
| 23205471db | |||
| f8618a5360 | |||
| acc90757a6 | |||
| 589872049f | |||
| 18403e7db8 | |||
| 2625ca2b3c | |||
| 5b9c09b7b2 | |||
| b37c2cc3ef |
@@ -13,9 +13,15 @@ updates:
|
||||
- minor
|
||||
- package-ecosystem: pip
|
||||
directory: "/docs"
|
||||
labels:
|
||||
- dependencies
|
||||
- documentation
|
||||
schedule:
|
||||
interval: weekly
|
||||
groups:
|
||||
docker:
|
||||
patterns:
|
||||
- "docker/*"
|
||||
patches:
|
||||
patterns:
|
||||
- "*"
|
||||
|
||||
+14
-14
@@ -55,15 +55,15 @@ jobs:
|
||||
- variant: java21
|
||||
baseImage: eclipse-temurin:21-jre
|
||||
platforms: linux/amd64,linux/arm64
|
||||
mcVersion: latest
|
||||
mcVersion: 1.21.11
|
||||
- variant: java21-jdk
|
||||
baseImage: eclipse-temurin:21
|
||||
platforms: linux/amd64,linux/arm64
|
||||
mcVersion: latest
|
||||
mcVersion: 1.21.11
|
||||
- variant: java21-alpine
|
||||
baseImage: eclipse-temurin:21-jre-alpine
|
||||
platforms: linux/amd64,linux/arm64
|
||||
mcVersion: latest
|
||||
mcVersion: 1.21.11
|
||||
# JAVA 17:
|
||||
- variant: java17
|
||||
# jammy doesn't work until minecraft updates to https://github.com/netty/netty/issues/12343
|
||||
@@ -85,14 +85,14 @@ jobs:
|
||||
baseImage: eclipse-temurin:8u312-b07-jre-focal
|
||||
platforms: linux/amd64,linux/arm/v7,linux/arm64
|
||||
mcVersion: 1.12.2
|
||||
# Pin version for Java 8
|
||||
mcHelperVersion: 1.51.1
|
||||
# Pin version for Java 8, also be sure to set in verify-pr.yml
|
||||
mcHelperVersion: 1.51.3-java8
|
||||
- variant: java8-jdk
|
||||
baseImage: eclipse-temurin:8u312-b07-jdk-focal
|
||||
platforms: linux/amd64,linux/arm64
|
||||
mcVersion: 1.12.2
|
||||
# Pin version for Java 8
|
||||
mcHelperVersion: 1.51.1
|
||||
# Pin version for Java 8, also be sure to set in verify-pr.yml
|
||||
mcHelperVersion: 1.51.3-java8
|
||||
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 != '' }}
|
||||
@@ -107,7 +107,7 @@ jobs:
|
||||
|
||||
- name: Docker meta
|
||||
id: meta
|
||||
uses: docker/metadata-action@v5.10.0
|
||||
uses: docker/metadata-action@v6.0.0
|
||||
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.
|
||||
@@ -137,13 +137,13 @@ jobs:
|
||||
org.opencontainers.image.authors=Geoff Bourne <itzgeoff@gmail.com>
|
||||
|
||||
- name: Setup Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3.12.0
|
||||
uses: docker/setup-buildx-action@v4.0.0
|
||||
|
||||
- name: Set up QEMU
|
||||
uses: docker/setup-qemu-action@v3.7.0
|
||||
uses: docker/setup-qemu-action@v4.0.0
|
||||
|
||||
- name: Build for test
|
||||
uses: docker/build-push-action@v6.19.2
|
||||
uses: docker/build-push-action@v7.1.0
|
||||
with:
|
||||
platforms: linux/amd64
|
||||
tags: ${{ env.IMAGE_TO_TEST }}
|
||||
@@ -168,14 +168,14 @@ jobs:
|
||||
tests/test.sh
|
||||
|
||||
- name: Login to DockerHub
|
||||
uses: docker/login-action@v3.7.0
|
||||
uses: docker/login-action@v4.1.0
|
||||
if: env.HAS_IMAGE_REPO_ACCESS
|
||||
with:
|
||||
username: ${{ secrets.DOCKER_USER }}
|
||||
password: ${{ secrets.DOCKER_PASSWORD }}
|
||||
|
||||
- name: Login to GHCR
|
||||
uses: docker/login-action@v3.7.0
|
||||
uses: docker/login-action@v4.1.0
|
||||
if: env.HAS_IMAGE_REPO_ACCESS
|
||||
with:
|
||||
registry: ghcr.io
|
||||
@@ -183,7 +183,7 @@ jobs:
|
||||
password: ${{ github.token }}
|
||||
|
||||
- name: Build and push
|
||||
uses: docker/build-push-action@v6.19.2
|
||||
uses: docker/build-push-action@v7.1.0
|
||||
if: github.actor == github.repository_owner
|
||||
with:
|
||||
platforms: ${{ matrix.platforms }}
|
||||
|
||||
@@ -19,7 +19,7 @@ jobs:
|
||||
steps:
|
||||
- name: on-publish
|
||||
if: github.event_name == 'release' && github.event.action == 'published'
|
||||
uses: SethCohen/github-releases-to-discord@v1.19.0
|
||||
uses: SethCohen/github-releases-to-discord@v1.20.0
|
||||
with:
|
||||
webhook_url: ${{ secrets.DISCORD_WEBHOOK }}
|
||||
- name: on-success
|
||||
|
||||
@@ -46,8 +46,8 @@ jobs:
|
||||
baseImage: eclipse-temurin:8u312-b07-jre-focal
|
||||
platforms: linux/amd64
|
||||
mcVersion: 1.12.2
|
||||
# Pin version for Java 8
|
||||
mcHelperVersion: 1.51.1
|
||||
# Pin version for Java 8, be sure to also set in build.yml
|
||||
mcHelperVersion: 1.51.3-java8
|
||||
env:
|
||||
IMAGE_TO_TEST: ${{ github.repository_owner }}/minecraft-server:test-${{ matrix.variant }}-${{ github.run_id }}
|
||||
runs-on: ubuntu-22.04
|
||||
@@ -59,10 +59,10 @@ jobs:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Setup Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3.12.0
|
||||
uses: docker/setup-buildx-action@v4.0.0
|
||||
|
||||
- name: Confirm multi-arch build
|
||||
uses: docker/build-push-action@v6.19.2
|
||||
uses: docker/build-push-action@v7.1.0
|
||||
with:
|
||||
platforms: ${{ matrix.platforms }}
|
||||
# ensure latest base image is used
|
||||
@@ -73,7 +73,7 @@ jobs:
|
||||
cache-from: type=gha,scope=${{ matrix.variant }}
|
||||
|
||||
- name: Build for test
|
||||
uses: docker/build-push-action@v6.19.2
|
||||
uses: docker/build-push-action@v7.1.0
|
||||
with:
|
||||
# Only build single platform since loading multi-arch image into daemon fails with
|
||||
# "docker exporter does not currently support exporting manifest lists"
|
||||
|
||||
+6
-6
@@ -26,36 +26,36 @@ ARG APPS_REV=1
|
||||
ARG GITHUB_BASEURL=https://github.com
|
||||
|
||||
# renovate: datasource=github-releases packageName=itzg/easy-add
|
||||
ARG EASY_ADD_VERSION=0.8.11
|
||||
ARG EASY_ADD_VERSION=0.8.13
|
||||
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
|
||||
|
||||
# renovate: datasource=github-releases packageName=itzg/restify
|
||||
ARG RESTIFY_VERSION=1.7.12
|
||||
ARG RESTIFY_VERSION=1.7.14
|
||||
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
|
||||
|
||||
# renovate: datasource=github-releases packageName=itzg/rcon-cli
|
||||
ARG RCON_CLI_VERSION=1.7.4
|
||||
ARG RCON_CLI_VERSION=1.7.5
|
||||
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
|
||||
|
||||
# renovate: datasource=github-releases packageName=itzg/mc-monitor
|
||||
ARG MC_MONITOR_VERSION=0.16.1
|
||||
ARG MC_MONITOR_VERSION=0.16.4
|
||||
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
|
||||
|
||||
# renovate: datasource=github-releases packageName=itzg/mc-server-runner
|
||||
ARG MC_SERVER_RUNNER_VERSION=1.14.3
|
||||
ARG MC_SERVER_RUNNER_VERSION=1.14.7
|
||||
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
|
||||
|
||||
# renovate: datasource=github-releases packageName=itzg/mc-image-helper versioning=loose
|
||||
ARG MC_HELPER_VERSION=1.55.4
|
||||
ARG MC_HELPER_VERSION=1.58.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
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
[](https://www.buymeacoffee.com/itzg)
|
||||
[](https://docker-minecraft-server.readthedocs.io/en/latest/?badge=latest)
|
||||
|
||||
[](https://docker-minecraft-server.readthedocs.io/)
|
||||
[](https://docker-minecraft-server.readthedocs.io/)
|
||||
|
||||
There you will find things like
|
||||
- [Quick start with Docker Compose](https://docker-minecraft-server.readthedocs.io/en/latest/#using-docker-compose)
|
||||
@@ -19,3 +19,26 @@ There you will find things like
|
||||
There are also many examples located in [the examples directory](examples) of this repo.
|
||||
|
||||
This image only supports Java edition natively; however, if looking for a server that is compatible with Bedrock edition, then use [itzg/minecraft-bedrock-server](https://github.com/itzg/docker-minecraft-bedrock-server) or [refer to this section](https://docker-minecraft-server.readthedocs.io/en/latest/misc/examples/#bedrock-compatible-server) to add Bedrock compatibility to a Java edition server.
|
||||
|
||||
[](#sponsors)
|
||||
|
||||
<a name="sponsors"></a>
|
||||
|
||||
<a href="https://spawnbox.app"><img src="https://spawnbox.app/favicon-48x48.png" alt="SpawnBox logo" width="48" align="left" /></a>
|
||||
|
||||
<a href="https://spawnbox.app"><b>SpawnBox</b></a> - Powered by <code>itzg/minecraft-server</code>, it's a Windows desktop app for parents, teens, and friend groups who want a Minecraft server on their own PC without learning Docker, WSL2, or networking.
|
||||
|
||||
<br clear="left" />
|
||||
|
||||
<a href="https://server.pro"><img src="https://server.pro/s/img/logo-short-192.png" alt="Server.pro logo" width="48" align="left" /></a>
|
||||
|
||||
<a href="https://server.pro"><b>Server.pro</b></a> - A game server hosting platform offering one-click Minecraft server deployment powered by <code>itzg/minecraft-server</code>, with global locations and an easy-to-use control panel.
|
||||
|
||||
<br clear="left" />
|
||||
|
||||
<!-- additional sponsors repeat the pattern above: floated logo + blurb + clear-left break -->
|
||||
<!-- logo image preferrably hosted on an external, stable site at a size of 48x48px -->
|
||||
<!-- link to sponsor site -->
|
||||
<!-- one or two line summary ideally with a mention of image integration -->
|
||||
|
||||
[and more...](https://github.com/sponsors/itzg)
|
||||
|
||||
@@ -18,6 +18,7 @@ apk add --no-cache -U \
|
||||
curl \
|
||||
iputils \
|
||||
git \
|
||||
git-lfs \
|
||||
jq \
|
||||
mysql-client \
|
||||
tzdata \
|
||||
@@ -45,4 +46,5 @@ cat <<EOF >> /etc/gitconfig
|
||||
[user]
|
||||
name = Minecraft Server on Docker
|
||||
email = server@example.com
|
||||
EOF
|
||||
EOF
|
||||
git lfs install
|
||||
@@ -46,6 +46,7 @@ dnf install -y \
|
||||
zstd \
|
||||
$([ "$os_major_version" -ge 10 ] && echo 'bzip2' || echo 'lbzip2') \
|
||||
libpcap \
|
||||
libcap \
|
||||
libwebp \
|
||||
findutils \
|
||||
which \
|
||||
@@ -81,3 +82,4 @@ cat <<EOF >> /etc/gitconfig
|
||||
name = Minecraft Server on Docker
|
||||
email = server@example.com
|
||||
EOF
|
||||
git lfs install
|
||||
|
||||
@@ -16,6 +16,7 @@ apt-get install -y \
|
||||
iputils-ping \
|
||||
curl \
|
||||
git \
|
||||
git-lfs \
|
||||
jq \
|
||||
dos2unix \
|
||||
mysql-client \
|
||||
@@ -28,13 +29,9 @@ apt-get install -y \
|
||||
nfs-common \
|
||||
libpcap0.8 \
|
||||
libnuma1 \
|
||||
libcap2-bin \
|
||||
${EXTRA_DEB_PACKAGES}
|
||||
|
||||
# Install Git LFS
|
||||
curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh | sudo bash
|
||||
apt-get update
|
||||
apt-get install -y git-lfs
|
||||
|
||||
# Clean up APT when done
|
||||
apt-get clean
|
||||
|
||||
@@ -51,3 +48,4 @@ cat <<EOF >> /etc/gitconfig
|
||||
name = Minecraft Server on Docker
|
||||
email = server@example.com
|
||||
EOF
|
||||
git lfs install
|
||||
|
||||
@@ -22,6 +22,12 @@ docker run -d --pull=always \
|
||||
-p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
|
||||
```
|
||||
|
||||
## Clean server libraries
|
||||
|
||||
By default, supported server types remove stale server libraries during installation by setting `CLEAN_SERVER_LIBRARIES` to `true`. Set `CLEAN_SERVER_LIBRARIES` to `false` to disable this cleanup if it causes unexpected behavior.
|
||||
|
||||
Currently, library cleanup is supported by `TYPE=PAPER`. Other server jar types are not yet supported.
|
||||
|
||||
## Running as alternate user/group ID
|
||||
|
||||
By default, the container will switch to and run the Minecraft server as user ID 1000 and group ID 1000; however, that can be changed by setting the environment variables `UID` and `GID`.
|
||||
|
||||
|
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 29 KiB |
@@ -6,7 +6,7 @@ Small, none, Minecraftia
|
||||
|
||||
Line 2:
|
||||
"Documentation"
|
||||
Large, non, Minecrafter
|
||||
Large, none, Minecrafter
|
||||
|
||||
Overall settings:
|
||||
- drop shadow
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
@@ -0,0 +1,9 @@
|
||||
Generated at https://textcraft.net/
|
||||
|
||||
Line 1:
|
||||
"Sponsors"
|
||||
Mid
|
||||
None
|
||||
Minecrafter
|
||||
Drop shadow
|
||||
3d-style view
|
||||
@@ -8,7 +8,7 @@ An option to stop the server after a specified time has been added for niche app
|
||||
|
||||
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).
|
||||
A starting, example compose file has been provided in [examples/autostop/compose.yml](https://github.com/itzg/docker-minecraft-server/blob/master/examples/autostop/compose.yml).
|
||||
|
||||
Enable the Autostop functionality by setting:
|
||||
|
||||
|
||||
@@ -21,6 +21,30 @@ docker compose -f compose-dev.yml run --rm -it [-e key=value] mc-dev
|
||||
|
||||
To speed up the development cycle, it is recommended to set `SETUP_ONLY` to `true` as part of the run command above.
|
||||
|
||||
## Building the image with a new release of a tool
|
||||
|
||||
In this exapmle, let's say that [mc-image-helper](https://github.com/itzg/mc-image-helper) has been [released](https://github.com/itzg/mc-image-helper/releases) at 1.56.0, but the corresponding changes in the image [scripts](https://github.com/itzg/docker-minecraft-server/tree/23205471db9814cff9c6602361dbc6cdd6c4230a/scripts) need to be tested against that version while updating [the Dockerfile](https://github.com/itzg/docker-minecraft-server/blob/23205471db9814cff9c6602361dbc6cdd6c4230a/Dockerfile#L58).
|
||||
|
||||
```yaml title="tests/manual/optional-projects/compose.yml" hl_lines="7"
|
||||
services:
|
||||
mc:
|
||||
build:
|
||||
# ...or wherever you cloned the docker-minecraft-server repo
|
||||
context: ../../..
|
||||
args:
|
||||
MC_HELPER_VERSION: 1.56.0
|
||||
environment:
|
||||
EULA: true
|
||||
TYPE: "FABRIC"
|
||||
MODRINTH_PROJECTS: |
|
||||
fabric-api
|
||||
pl3xmap?:beta
|
||||
ports:
|
||||
- "25565:25565/tcp"
|
||||
volumes:
|
||||
- ./data:/data
|
||||
```
|
||||
|
||||
## Using development copy of tools
|
||||
|
||||
In the cloned repo, such as [`mc-image-helper`](https://github.com/itzg/mc-image-helper), install the distribution locally by running:
|
||||
|
||||
@@ -81,7 +81,13 @@ These paths work well if you want to have a common set of modules in a separate
|
||||
|
||||
You can download/copy additional configuration files or other resources before the server starts by using the `APPLY_EXTRA_FILES` environment variable. This is useful for downloading configs that you want to patch or modify during the startup process.
|
||||
|
||||
The format uses a `<` separator between the destination path and the source URL/path. The destination path is relative to the `/data` directory. If specifying a source path, it needs to be path mounted within the container.
|
||||
The format uses a `<` separator between the destination path and the source URL/path.
|
||||
|
||||
The destination path is relative to the `/data` directory.
|
||||
|
||||
If specifying a source path, rather than URL, it needs to reference a path mounted into the container as a volume.
|
||||
|
||||
A source path can refer to a directory, in which case the files within that directory will be copied into the destination directory. At startup, it will take care of synchronizing the removal of files it copied when they are removed from the source.
|
||||
|
||||
!!! example
|
||||
|
||||
@@ -150,6 +156,54 @@ Disabling mods within docker compose files:
|
||||
mod2.jar
|
||||
```
|
||||
|
||||
### Loading container configuration from a pack
|
||||
|
||||
A pack can ship its own container configuration so that the server type, version,
|
||||
and other variables travel with the pack rather than being declared by the user.
|
||||
At startup, before `TYPE` is dispatched, the container can load environment
|
||||
variables from a file on disk, a URL, an entry inside an archive, or from the
|
||||
`.env` of each `GENERIC_PACK(S)` entry.
|
||||
|
||||
- `LOAD_ENV_FROM_GENERIC_PACK`: when `true`, each entry in `GENERIC_PACKS` (after
|
||||
`GENERIC_PACKS_PREFIX`/`SUFFIX` expansion) is probed for a top-level `.env`
|
||||
and each one found is sourced in the same order the packs are applied (later
|
||||
packs override earlier ones, matching the layering of the unpack itself). Packs
|
||||
without a `.env` are skipped without error. URLs are downloaded into
|
||||
`/data/packs/` and reused by the regular generic-pack unpack step, so they are
|
||||
not fetched twice.
|
||||
- `LOAD_ENV_FROM_FILE`: container path or URL of a shell-style env file (one
|
||||
`KEY=VALUE` per line). Comments and blank lines are allowed.
|
||||
- `LOAD_ENV_FROM_ARCHIVE`: container path or URL of a zip/tar archive containing
|
||||
an env file. The entry is sourced into the environment.
|
||||
- `LOAD_ENV_FROM_ARCHIVE_ENTRY`: relative path of the env file inside the archive.
|
||||
Defaults to `.env`.
|
||||
|
||||
These can be combined. Load order is: generic packs first, then
|
||||
`LOAD_ENV_FROM_FILE`, then `LOAD_ENV_FROM_ARCHIVE` — later loads override
|
||||
earlier ones, and all of them **override** values passed via `docker run -e` (or
|
||||
compose `environment:`), so the pack's declared values win.
|
||||
|
||||
```shell
|
||||
docker run -d \
|
||||
-e EULA=TRUE \
|
||||
-e GENERIC_PACK=https://cdn.example.org/my-pack.zip \
|
||||
-e LOAD_ENV_FROM_GENERIC_PACK=true \
|
||||
itzg/minecraft-server
|
||||
```
|
||||
|
||||
Where `my-pack.zip` contains a `.env` at its root such as:
|
||||
|
||||
```env
|
||||
TYPE=FABRIC
|
||||
VERSION=1.21.1
|
||||
FABRIC_LOADER_VERSION=0.16.0
|
||||
```
|
||||
|
||||
!!! warning
|
||||
The env file is sourced by `bash`, so any shell syntax it contains will be
|
||||
evaluated. Only point these variables at sources you trust. `EULA` cannot be
|
||||
set this way — it is checked before the env file is loaded.
|
||||
|
||||
## 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
|
||||
|
||||
@@ -86,6 +86,54 @@ Where:
|
||||
|
||||
To temporarily disable processing of the `MODRINTH_PROJECTS` list, then comment out the `MODRINTH_PROJECTS` environment variable.
|
||||
|
||||
## Optional projects
|
||||
|
||||
Projects that are not critical for the server to function can be marked as **optional** by appending a `?` to the project slug or ID. When a compatible version cannot be found for an optional project, the server logs a warning and continues startup instead of failing.
|
||||
|
||||
This is particularly useful for server-side mods that tend to lag behind on Minecraft updates, such as map renderers (Pl3xmap, BlueMap), performance mods (Lithium, C2ME), or admin tools (Spark, LuckPerms).
|
||||
|
||||
```yaml
|
||||
MODRINTH_PROJECTS: |
|
||||
fabric-api
|
||||
lithium
|
||||
pl3xmap?
|
||||
bluemap?:beta
|
||||
```
|
||||
|
||||
The `?` marker can be combined with all existing format options:
|
||||
|
||||
| Format | Example |
|
||||
|----------------------------|---------------------------|
|
||||
| Slug only | `pl3xmap?` |
|
||||
| With version | `pl3xmap?:Oa9ZDzZq` |
|
||||
| With release type | `pl3xmap?:beta` |
|
||||
| With loader prefix | `fabric:pl3xmap?` |
|
||||
| Full combination | `fabric:pl3xmap?:beta` |
|
||||
| In listing files | `pl3xmap?` *(one per line)* |
|
||||
|
||||
When combined with [`VERSION_FROM_MODRINTH_PROJECTS`](#version-from-projects), optional projects are **excluded** from the version calculation. This means an optional mod that hasn't been updated yet will never block a Minecraft version upgrade.
|
||||
|
||||
!!! example "Automatic upgrades without optional-mod breakage"
|
||||
|
||||
```yaml
|
||||
MODRINTH_PROJECTS: |
|
||||
fabric-api
|
||||
lithium
|
||||
pl3xmap?
|
||||
VERSION_FROM_MODRINTH_PROJECTS: true
|
||||
```
|
||||
|
||||
If a new Minecraft version is released and `fabric-api` + `lithium` support it but `pl3xmap` does not:
|
||||
|
||||
1. The resolved `VERSION` is set to the new version (pl3xmap is not considered)
|
||||
2. `fabric-api` and `lithium` are installed normally
|
||||
3. `pl3xmap` is skipped with a warning in the logs
|
||||
4. On a future restart, once pl3xmap publishes a compatible build, it is picked up automatically
|
||||
|
||||
!!! note
|
||||
|
||||
Optional projects marked with `?` in listing files (`@/path/to/file.txt`) are supported ; the `?` is parsed from each line the same way as inline entries.
|
||||
|
||||
## Version from Projects
|
||||
|
||||
When the environment variable `VERSION_FROM_MODRINTH_PROJECTS` is set to "true" the Minecraft [`VERSION`](../versions/minecraft.md) will be automatically determined by looking at the most recent version of Minecraft that is supported by all the projects provided in `MODRINTH_PROJECTS`.
|
||||
@@ -115,4 +163,3 @@ When the environment variable `VERSION_FROM_MODRINTH_PROJECTS` is set to "true"
|
||||
|
||||
`MODRINTH_LOADER`
|
||||
: When using a custom server, set this to specify which loader type will be requested during lookups
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
click==8.3.1
|
||||
click==8.4.0
|
||||
colorama==0.4.6
|
||||
deepmerge==2.0
|
||||
ghp-import==2.1.0
|
||||
griffe==2.0.0
|
||||
griffe==2.0.2
|
||||
Jinja2==3.1.6
|
||||
Markdown==3.10.2
|
||||
MarkupSafe==3.0.3
|
||||
@@ -10,16 +10,16 @@ mergedeep==1.3.4
|
||||
mkdocs==1.6.1
|
||||
mkdocs-autorefs==1.4.4
|
||||
mkdocs-get-deps==0.2.2
|
||||
mkdocstrings==1.0.3
|
||||
mkdocstrings==1.0.4
|
||||
mkdocstrings-python==2.0.3
|
||||
packaging==26.0
|
||||
pathspec==1.0.4
|
||||
platformdirs==4.9.4
|
||||
Pygments==2.19.2
|
||||
pymdown-extensions==10.21
|
||||
packaging==26.2
|
||||
pathspec==1.1.1
|
||||
platformdirs==4.9.6
|
||||
Pygments==2.20.0
|
||||
pymdown-extensions==10.21.3
|
||||
python-dateutil==2.9.0.post0
|
||||
PyYAML==6.0.3
|
||||
pyyaml_env_tag==1.1
|
||||
six==1.17.0
|
||||
watchdog==6.0.0
|
||||
zensical==0.0.27
|
||||
zensical==0.0.43
|
||||
|
||||
@@ -397,6 +397,12 @@ This image maps known server properties as described in [this section](configura
|
||||
<td><code>Randomly generated</code></td>
|
||||
<td>✅</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>RCON_PASSWORD_FILE</code></td>
|
||||
<td>Can be set to read the RCON password from a file. Overrides <code>RCON_PASSWORD</code> if both are set.</td>
|
||||
<td><code></code></td>
|
||||
<td>⬜️</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>RCON_PORT</code></td>
|
||||
<td>The port for RCON</td>
|
||||
|
||||
@@ -2,7 +2,8 @@ To use a different Minecraft version, pass the `VERSION` environment variable (c
|
||||
|
||||
- `LATEST` for latest release (the default)
|
||||
- `SNAPSHOT` for latest snapshot
|
||||
- a specific version, such as `1.7.9`, `25w35a`, `26.1`, or `26.1-snapshot-1`
|
||||
- a specific legacy version, such as `1.7.9`, `25w35a`, `1.15.2-pre2` or `1.21.11-rc1`
|
||||
- a specific [new version numbering system](https://www.minecraft.net/en-us/article/minecraft-new-version-numbering-system) version like `26.1`, `26.1-snapshot-1`, `26.1-pre-1`, or `26.1-rc-1`
|
||||
- or an alpha and beta version, such as "b1.7.3" (server download might not exist)
|
||||
|
||||
For example, to use the latest snapshot:
|
||||
|
||||
@@ -10,7 +10,6 @@ services:
|
||||
VANILLATWEAKS_FILE: /config/vanillatweaks-datapacks.json
|
||||
REMOVE_OLD_VANILLATWEAKS: "TRUE"
|
||||
volumes:
|
||||
- data:/data
|
||||
- ./vanillatweaks-datapacks.json:/config/vanillatweaks-datapacks.json:ro
|
||||
vanillatweaks_sharecode:
|
||||
# port is set to 25566 to not conflict with vanillatweaks_file example
|
||||
@@ -35,7 +34,6 @@ services:
|
||||
VANILLATWEAKS_FILE: /config/vanillatweaks-datapacks.json,/config/vanillatweaks-resourcepacks.json,/config/vanillatweaks-craftingtweaks.json
|
||||
REMOVE_OLD_VANILLATWEAKS: "TRUE"
|
||||
volumes:
|
||||
- data:/data
|
||||
- ./vanillatweaks-datapacks.json:/config/vanillatweaks-datapacks.json:ro
|
||||
- ./vanillatweaks-resourcepacks.json:/config/vanillatweaks-resourcepacks.json:ro
|
||||
- ./vanillatweaks-craftingtweaks.json:/config/vanillatweaks-craftingtweaks.json:ro
|
||||
- ./vanillatweaks-craftingtweaks.json:/config/vanillatweaks-craftingtweaks.json:ro
|
||||
@@ -144,6 +144,7 @@
|
||||
"smart-hud",
|
||||
"smithing-template-viewer",
|
||||
"smooth-font",
|
||||
"smooth-swapping",
|
||||
"smoothwater",
|
||||
"sodium",
|
||||
"sodium-extra",
|
||||
@@ -211,6 +212,11 @@
|
||||
},
|
||||
"valhelsia-5": {
|
||||
"excludes": ["modernfix"]
|
||||
},
|
||||
"wolds-vaults": {
|
||||
"forceIncludes": [
|
||||
"just-enough-resources-jer"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -5,7 +5,6 @@
|
||||
"AmbientSounds",
|
||||
"amecs",
|
||||
"Animation_Overhaul",
|
||||
"appleskin",
|
||||
"auudio",
|
||||
"axolotlbuckets",
|
||||
"BadOptimizations",
|
||||
@@ -28,7 +27,6 @@
|
||||
"compass-coords",
|
||||
"colorwheel",
|
||||
"connectedness",
|
||||
"connector",
|
||||
"continuity",
|
||||
"controlling",
|
||||
"craftpresence",
|
||||
@@ -39,8 +37,6 @@
|
||||
"distraction_free_recipes",
|
||||
"drippyloadingscreen",
|
||||
"eating-animation",
|
||||
"emi",
|
||||
"emi_loot",
|
||||
"emi_trade",
|
||||
"emiffect",
|
||||
"emitrades",
|
||||
@@ -94,6 +90,7 @@
|
||||
"seasonhud",
|
||||
"ShoulderSurfing",
|
||||
"skinlayers3d",
|
||||
"smoothswapping",
|
||||
"sodium",
|
||||
"sorted_enchantments",
|
||||
"tooltipfix",
|
||||
|
||||
@@ -152,6 +152,31 @@ fi
|
||||
|
||||
cd /data || exit 1
|
||||
|
||||
##########################################
|
||||
# Optionally load environment variables from a file or archive entry,
|
||||
# allowing packs/artifacts to declare TYPE, VERSION and other settings
|
||||
# inside-out. Loaded values override anything passed in through docker -e.
|
||||
# Generic packs are processed first so that LOAD_ENV_FROM_FILE and
|
||||
# LOAD_ENV_FROM_ARCHIVE can override any values they set.
|
||||
|
||||
if isTrue "${LOAD_ENV_FROM_GENERIC_PACK:-false}"; then
|
||||
if ! loadEnvFromGenericPack; then
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
if [[ ${LOAD_ENV_FROM_FILE:-} ]]; then
|
||||
if ! loadEnvFromFile "${LOAD_ENV_FROM_FILE}"; then
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
if [[ ${LOAD_ENV_FROM_ARCHIVE:-} ]]; then
|
||||
if ! loadEnvFromArchive "${LOAD_ENV_FROM_ARCHIVE}" "${LOAD_ENV_FROM_ARCHIVE_ENTRY:-.env}"; then
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
export DECLARED_TYPE=${TYPE^^}
|
||||
export DECLARED_VERSION="$VERSION"
|
||||
|
||||
|
||||
@@ -11,17 +11,26 @@ handleDebugMode
|
||||
: "${PAPER_DOWNLOAD_URL:=}"
|
||||
: "${PAPER_CUSTOM_JAR:=}"
|
||||
: "${PAPER_CONFIG_DEFAULTS_REPO:=${PAPER_CONFIG_REPO:=https://raw.githubusercontent.com/Shonz1/minecraft-default-configs/main}}"
|
||||
: "${CLEAN_SERVER_LIBRARIES:=true}"
|
||||
|
||||
resultsFile=/data/.paper.env
|
||||
if [[ $PAPER_CUSTOM_JAR ]]; then
|
||||
export SERVER="$PAPER_CUSTOM_JAR"
|
||||
elif [[ $PAPER_DOWNLOAD_URL ]]; then
|
||||
if ! mc-image-helper install-paper \
|
||||
--output-directory=/data \
|
||||
--results-file="$resultsFile" \
|
||||
--url="$PAPER_DOWNLOAD_URL"; then
|
||||
logError "Failed to download from custom PaperMC URL"
|
||||
exit 1
|
||||
|
||||
args=(
|
||||
--output-directory=/data
|
||||
--results-file="$resultsFile"
|
||||
--url="$PAPER_DOWNLOAD_URL"
|
||||
)
|
||||
|
||||
if [[ $CLEAN_SERVER_LIBRARIES ]]; then
|
||||
args+=(--clean-libraries)
|
||||
fi
|
||||
|
||||
if ! mc-image-helper install-paper "${args[@]}"; then
|
||||
logError "Failed to download from custom PaperMC URL"
|
||||
exit 1
|
||||
fi
|
||||
applyResultsFile ${resultsFile}
|
||||
else
|
||||
@@ -35,6 +44,11 @@ else
|
||||
if [[ $PAPER_BUILD ]]; then
|
||||
args+=(--build="$PAPER_BUILD")
|
||||
fi
|
||||
|
||||
if [[ $CLEAN_SERVER_LIBRARIES ]]; then
|
||||
args+=(--clean-libraries)
|
||||
fi
|
||||
|
||||
if ! mc-image-helper install-paper "${args[@]}"; then
|
||||
logError "Failed to download $PAPER_PROJECT"
|
||||
exit 1
|
||||
|
||||
+116
-3
@@ -26,6 +26,117 @@ function applyResultsFile() {
|
||||
set +a
|
||||
}
|
||||
|
||||
function loadEnvFromFile() {
|
||||
local source=${1?Missing required source argument}
|
||||
local downloaded=
|
||||
|
||||
if isURL "$source"; then
|
||||
mkdir -p /data/.tmp
|
||||
downloaded=$(mktemp -p /data/.tmp)
|
||||
log "Downloading env file from $source"
|
||||
if ! get -o "$downloaded" "$source"; then
|
||||
logError "Failed to download env file from $source"
|
||||
rm -f "$downloaded"
|
||||
return 1
|
||||
fi
|
||||
log "Loading env vars from $source"
|
||||
applyResultsFile "$downloaded"
|
||||
rm -f "$downloaded"
|
||||
elif [ -f "$source" ]; then
|
||||
log "Loading env vars from $source"
|
||||
applyResultsFile "$source"
|
||||
else
|
||||
logError "Env file not found: $source"
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
function loadEnvFromArchive() {
|
||||
local source=${1?Missing required source argument}
|
||||
local entry=${2:-.env}
|
||||
local archive=
|
||||
local downloaded=
|
||||
local tmpdir
|
||||
local rc=0
|
||||
|
||||
mkdir -p /data/.tmp
|
||||
|
||||
if isURL "$source"; then
|
||||
downloaded=$(mktemp -p /data/.tmp)
|
||||
log "Downloading archive from $source"
|
||||
if ! get -o "$downloaded" "$source"; then
|
||||
logError "Failed to download archive from $source"
|
||||
rm -f "$downloaded"
|
||||
return 1
|
||||
fi
|
||||
archive=$downloaded
|
||||
elif [ -f "$source" ]; then
|
||||
archive=$source
|
||||
else
|
||||
logError "Archive not found: $source"
|
||||
return 1
|
||||
fi
|
||||
|
||||
tmpdir=$(mktemp -d -p /data/.tmp)
|
||||
if extract "$archive" "$tmpdir" "$entry" && [ -f "$tmpdir/$entry" ]; then
|
||||
log "Loading env vars from '$entry' in $source"
|
||||
applyResultsFile "$tmpdir/$entry"
|
||||
else
|
||||
logError "Failed to load env entry '$entry' from $source"
|
||||
rc=1
|
||||
fi
|
||||
|
||||
rm -rf "$tmpdir"
|
||||
[[ -n "$downloaded" ]] && rm -f "$downloaded"
|
||||
return $rc
|
||||
}
|
||||
|
||||
function loadEnvFromGenericPack() {
|
||||
: "${GENERIC_PACKS:=${GENERIC_PACK:-}}"
|
||||
: "${GENERIC_PACKS_PREFIX:=}"
|
||||
: "${GENERIC_PACKS_SUFFIX:=}"
|
||||
|
||||
if [[ -z "${GENERIC_PACKS}" ]]; then
|
||||
logWarning "LOAD_ENV_FROM_GENERIC_PACK is set but GENERIC_PACK(S) is empty"
|
||||
return 0
|
||||
fi
|
||||
|
||||
mkdir -p /data/.tmp
|
||||
IFS=',' read -ra packs <<< "${GENERIC_PACKS}"
|
||||
local loaded=0
|
||||
local pack packEntry packFile tmpdir
|
||||
for packEntry in "${packs[@]}"; do
|
||||
pack="${GENERIC_PACKS_PREFIX}${packEntry}${GENERIC_PACKS_SUFFIX}"
|
||||
if isURL "$pack"; then
|
||||
mkdir -p /data/packs
|
||||
if ! packFile=$(get -o /data/packs --output-filename --skip-up-to-date "$pack"); then
|
||||
logError "Failed to download generic pack $pack"
|
||||
return 1
|
||||
fi
|
||||
else
|
||||
packFile=$pack
|
||||
fi
|
||||
|
||||
if [[ ! -f "$packFile" ]]; then
|
||||
logError "Generic pack not found: $packFile"
|
||||
return 1
|
||||
fi
|
||||
|
||||
tmpdir=$(mktemp -d -p /data/.tmp)
|
||||
# Packs without a .env are valid — silently skip; the unpack step still applies them.
|
||||
if extract "$packFile" "$tmpdir" .env 2>/dev/null && [ -f "$tmpdir/.env" ]; then
|
||||
log "Loading env vars from .env in $pack"
|
||||
applyResultsFile "$tmpdir/.env"
|
||||
loaded=$((loaded + 1))
|
||||
fi
|
||||
rm -rf "$tmpdir"
|
||||
done
|
||||
|
||||
if (( loaded == 0 )); then
|
||||
logWarning "LOAD_ENV_FROM_GENERIC_PACK is set but no pack in GENERIC_PACK(S) contained a .env"
|
||||
fi
|
||||
}
|
||||
|
||||
function join_by() {
|
||||
local d=$1
|
||||
shift
|
||||
@@ -445,17 +556,19 @@ function isType() {
|
||||
function extract() {
|
||||
src=${1?}
|
||||
destDir=${2?}
|
||||
shift 2
|
||||
# remaining args are paths within the archive to extract; if none, extract everything
|
||||
|
||||
type=$(file -b --mime-type "${src}")
|
||||
case "${type}" in
|
||||
application/zip)
|
||||
unzip -o -q -d "${destDir}" "${src}"
|
||||
unzip -o -q -d "${destDir}" "${src}" "$@"
|
||||
;;
|
||||
application/x-tar | application/gzip | application/x-gzip | application/x-bzip2)
|
||||
tar -C "${destDir}" -xf "${src}"
|
||||
tar -C "${destDir}" -xf "${src}" "$@"
|
||||
;;
|
||||
application/zstd | application/x-zstd)
|
||||
tar -C "${destDir}" --use-compress-program=unzstd -xf "${src}"
|
||||
tar -C "${destDir}" --use-compress-program=unzstd -xf "${src}" "$@"
|
||||
;;
|
||||
*)
|
||||
logError "Unsupported archive type: $type"
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
services:
|
||||
mc:
|
||||
build:
|
||||
# ...or wherever you cloned the docker-minecraft-server repo
|
||||
context: ../../..
|
||||
args:
|
||||
MC_HELPER_VERSION: 1.56.0
|
||||
environment:
|
||||
EULA: true
|
||||
TYPE: "FABRIC"
|
||||
MODRINTH_PROJECTS: |
|
||||
fabric-api
|
||||
pl3xmap?:beta
|
||||
ports:
|
||||
- "25565:25565/tcp"
|
||||
volumes:
|
||||
- ./data:/data
|
||||
@@ -0,0 +1,18 @@
|
||||
services:
|
||||
mc:
|
||||
image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
|
||||
environment:
|
||||
EULA: "true"
|
||||
SETUP_ONLY: "true"
|
||||
LOAD_ENV_FROM_ARCHIVE: /test/load-env.zip
|
||||
MOTD: from-compose
|
||||
LOG_TIMESTAMP: "true"
|
||||
DEBUG: "true"
|
||||
# the following are only used to speed up test execution
|
||||
TYPE: CUSTOM
|
||||
CUSTOM_SERVER: /servers/fake.jar
|
||||
VERSION: 1.18.1
|
||||
volumes:
|
||||
- ./data:/data
|
||||
- ./load-env.zip:/test/load-env.zip
|
||||
- ./fake.jar:/servers/fake.jar
|
||||
Binary file not shown.
@@ -0,0 +1 @@
|
||||
mc-image-helper assert propertyEquals --file=server.properties --property=motd --expect=from-archive
|
||||
@@ -0,0 +1,18 @@
|
||||
services:
|
||||
mc:
|
||||
image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
|
||||
environment:
|
||||
EULA: "true"
|
||||
SETUP_ONLY: "true"
|
||||
LOAD_ENV_FROM_FILE: /test/load-env.env
|
||||
MOTD: from-compose
|
||||
LOG_TIMESTAMP: "true"
|
||||
DEBUG: "true"
|
||||
# the following are only used to speed up test execution
|
||||
TYPE: CUSTOM
|
||||
CUSTOM_SERVER: /servers/fake.jar
|
||||
VERSION: 1.18.1
|
||||
volumes:
|
||||
- ./data:/data
|
||||
- ./load-env.env:/test/load-env.env
|
||||
- ./fake.jar:/servers/fake.jar
|
||||
@@ -0,0 +1,2 @@
|
||||
# Loaded by LOAD_ENV_FROM_FILE during start-configuration
|
||||
MOTD=from-env-file
|
||||
@@ -0,0 +1 @@
|
||||
mc-image-helper assert propertyEquals --file=server.properties --property=motd --expect=from-env-file
|
||||
@@ -0,0 +1,19 @@
|
||||
services:
|
||||
mc:
|
||||
image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
|
||||
environment:
|
||||
EULA: "true"
|
||||
SETUP_ONLY: "true"
|
||||
GENERIC_PACK: /packs/pack.zip
|
||||
LOAD_ENV_FROM_GENERIC_PACK: "true"
|
||||
MOTD: from-compose
|
||||
LOG_TIMESTAMP: "true"
|
||||
DEBUG: "true"
|
||||
# the following are only used to speed up test execution
|
||||
TYPE: CUSTOM
|
||||
CUSTOM_SERVER: /servers/fake.jar
|
||||
VERSION: 1.18.1
|
||||
volumes:
|
||||
- ./data:/data
|
||||
- ./pack.zip:/packs/pack.zip
|
||||
- ./fake.jar:/servers/fake.jar
|
||||
Binary file not shown.
@@ -0,0 +1,2 @@
|
||||
mc-image-helper assert propertyEquals --file=server.properties --property=motd --expect=from-generic-pack
|
||||
mc-image-helper assert fileExists config/dummy.yml
|
||||
Reference in New Issue
Block a user