qumine/minecraft-server repository overview

⁠QuMine - Server - Java

Docker Image for running minecraft servers.

⁠Status

• Basic download of server JAR.
• Basic updating of server JAR.
• Basic wrapping of JVM process.
• Basic API health endpoints.
• Basic download of server plugins.
• Basic updating of server plugins.
• GRPC API for controlling the server remotely(start, stop, ).
• GRPC API for log streaming.
• GRPC API for console streaming(in, out).
• Cryo, stop server if no client is connected.

⁠Usage

⁠Quick Start

docker run -it --rm -p 8080:8080 -p 25565:25565 -e EULA=true -e SERVER_TYPE=VANILLA qumine/minecraft-server:latest

⁠Accessing the server console

You can access the server console by executing console inside of the container. This will stream logs and allow you to send commands to the server.

⁠Configuration

⁠eula.txt

To use the server you will need to accept the eula of mojang.

EULA=true

⁠server.properties

Server properties can be set via the encironment variables prefixed with SERVER_PROPERTIES_*.

For example to confiugre the max-players property you would set the environemt like this:

SERVER_PROPERTIES_MAX_PLAYERS=10

⁠whitelist.json

whitelist.json will only be populated on the first start

If the whitelist is turned on via SERVER_PROPERTIES_WHITE_LIST=true you can add initial players to the whitelist via the SERVER_WHITE_LIST environment variable.

For example to add the users Notch and Herobrine to the initial whitelist you would set:

SERVER_WHITE_LIST=Notch,Herobrine

You can force the whitelist.json to be overriden every time the container starts up by settings the SERVER_WHITE_LIST_OVERRIDE environment variable.

SERVER_WHITE_LIST_OVERRIDE=true

⁠ops.json

ops.json will only be populated on the first start

You can add initial players to the operators via the SERVER_OPS environment variable.

For example to add the users Notch and Herobrine to the initial operators you would set:

SERVER_OPS=Notch,Herobrine

You can force the ops.json to be overriden every time the container starts up by settings the SERVER_OPS_OVERRIDE environment variable.

SERVER_OPS_OVERRIDE=true

⁠Server Types

⁠Custom

In custom mode by default the provided url will be downloaded and later executed with the java -jar command.

docker run -it --rm -p 8080:8080 -p 25565:25565 -e EULA=true -e SERVER_TYPE=CUSTOM -e SERVER_CUSTOM_URL=https://papermc.io/api/v1/paper/1.16.4/296/download qumine/minecraft-server:latest

If you need to customize the startup command of your server you can use the SERVER_CUSTOM_COMMAND and SERVER_CUSTOM_ARGS environment variables.

docker run -it --rm -p 8080:8080 -p 25565:25565 -e EULA=true -e SERVER_TYPE=CUSTOM -e SERVER_CUSTOM_URL=https://papermc.io/api/v1/paper/1.16.4/296/download -e SERVER_CUSTOM_COMMAND=java -e SERVER_CUSTOM_ARGS="-XX:+UseG1GC,-jar,download,nogui" qumine/minecraft-server:latest

⁠PaperMC

docker run -it --rm -p 8080:8080 -p 25565:25565 -e EULA=true -e SERVER_TYPE=PAPERMC -e SERVER_VERSION=latest qumine/minecraft-server:latest

⁠ServerStarter

This will configure the server using ServerStarter⁠.

docker run -it --rm -p 8080:8080 -p 25565:25565 -e EULA=true -e SERVER_TYPE=PAPERMC -e SERVER_VERSION=latest qumine/minecraft-server:latest

NOTE: The amount of memory must fit the minRam and maxRam options of the server-setup-config.yaml.

⁠Travertine

docker run -it --rm -p 8080:8080 -p 25565:25577 -e SERVER_TYPE=TRAVERTINE -e SERVER_VERSION=latest qumine/minecraft-server:latest

⁠Vanilla

docker run -it --rm -p 8080:8080 -p 25565:25565 -e EULA=true -e SERVER_TYPE=VANILLA -e SERVER_VERSION=1.16.4 qumine/minecraft-server:latest

⁠Waterfall

docker run -it --rm -p 8080:8080 -p 25565:25577 -e SERVER_TYPE=WATERFALL -e SERVER_VERSION=latest qumine/minecraft-server:latest

⁠Yatopia

docker run -it --rm -p 8080:8080 -p 25565:25565 -e EULA=true -e SERVER_TYPE=YATOPIA -e SERVER_VERSION=latest qumine/minecraft-server:latest

⁠Plugins

To automatically download plugins and keep them updated you can use the SERVER_PLUGINS environment variable.

Currently only HTTP and HTTP/S plugins sources are supported

docker run -it --rm -p 8080:8080 -p 25565:25565 -e EULA=true -e SERVER_TYPE=PAPERMC -e SERVER_VERSION=latest -e SERVER_PLUGINS="https://github.com/BlueMap-Minecraft/BlueMap/releases/download/v1.3.0-snap/BlueMap-1.3.0-snap-spigot.jar,https://ci.opencollab.dev/job/GeyserMC/job/Floodgate/job/master/lastSuccessfulBuild/artifact/bukkit/target/floodgate-bukkit.jar" qumine/minecraft-server:latest

⁠Deployment

⁠Operator

TODO

⁠Docker

TODO

⁠Kubernetes

TODO

⁠Helm

HELM Charts can be found here: qumine/charts⁠

⁠Development

⁠Perfrom a Snapshot release locally

docker run -it --rm \
  -v ${PWD}:/build -w /build \
  -v /var/run/docker.sock:/var/run/docker.sock \
  goreleaser/goreleaser \
  release --snapshot --rm-dist