Files
fex-bedrock-vanilla/README.md
T

144 lines
4.8 KiB
Markdown

[![Docker Pulls](https://img.shields.io/docker/pulls/itzg/minecraft-bedrock-server.svg)](https://hub.docker.com/r/itzg/minecraft-bedrock-server/)
[![GitHub Issues](https://img.shields.io/github/issues-raw/itzg/docker-minecraft-bedrock-server.svg)](https://github.com/itzg/docker-minecraft-bedrock-server/issues)
[![Discord](https://img.shields.io/discord/660567679458869252)](https://discord.gg/ScbTrAw)
[![](https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-orange.svg)](https://www.buymeacoffee.com/itzg)
## Quickstart
The following starts a Bedrock Dedicated Server running a default version and
exposing the default UDP port:
```bash
docker run -d -it -e EULA=TRUE -p 19132:19132/udp itzg/minecraft-bedrock-server
```
## Looking for a Java Edition Server
For Minecraft Java Edition you'll need to use this image instead:
[itzg/minecraft-server](https://hub.docker.com/r/itzg/minecraft-server)
## Environment Variables
### Container Specific
- `EULA` (no default) : must be set to `TRUE` to
accept the [Minecraft End User License Agreement](https://minecraft.net/terms)
- `VERSION` (`LATEST`) : can be set to a specific server version or the following special values can be used:
- `LATEST` : determines the latest version and can be used to auto-upgrade on container start
- `PREVIOUS` : uses the previously maintained major version. Useful when the mobile app is gradually being upgraded across devices
- `1.11` : the latest version of 1.11
- `1.12` : the latest version of 1.12
- `1.13` : the latest version of 1.13
- `1.14` : the latest version of 1.14
- `1.16` : the latest version of 1.16
- `UID` (default derived from `/data` owner) : can be set to a specific user ID to run the
bedrock server process
- `GID` (default derived from `/data` owner) : can be set to a specific group ID to run the
bedrock server process
### Server Properties
The following environment variables will set the equivalent property in `server.properties`, where each [is described here](https://minecraft.gamepedia.com/Server.properties#Bedrock_Edition_3).
- `SERVER_NAME`
- `SERVER_PORT`
- `GAMEMODE`
- `DIFFICULTY`
- `LEVEL_TYPE`
- `ALLOW_CHEATS`
- `MAX_PLAYERS`
- `ONLINE_MODE`
- `WHITE_LIST`
- `VIEW_DISTANCE`
- `TICK_DISTANCE`
- `PLAYER_IDLE_TIMEOUT`
- `MAX_THREADS`
- `LEVEL_NAME`
- `LEVEL_SEED`
- `DEFAULT_PLAYER_PERMISSION_LEVEL`
- `TEXTUREPACK_REQUIRED`
For example, to configure a flat, creative server instead of the default use:
```bash
docker run -d -it --name bds-flat-creative \
-e EULA=TRUE -e LEVEL_TYPE=flat -e GAMEMODE=creative \
-p 19132:19132/udp itzg/minecraft-bedrock-server
```
## Exposed Ports
- **UDP** 19132 : the Bedrock server port.
**NOTE** that you must append `/udp` when exposing the port, such as `-p 19132:19132/udp`
## Volumes
- `/data` : the location where the downloaded server is expanded and ran. Also contains the
configuration properties file `server.properties`
## Connecting
When running the container on your LAN, you can find and connect to the dedicated server
in the "LAN Games" part of the "Friends" tab, such as:
![](docs/example-client.jpg)
## More information
For more information about managing Bedrock Dedicated Servers in general, [check out this Reddit post](https://old.reddit.com/user/ProfessorValko/comments/9f438p/bedrock_dedicated_server_tutorial/).
## Deploying with Docker Compose
The [examples](examples) directory contains [an example Docker compose file](examples/docker-compose.yml) that declares:
- a service running the bedrock server container and exposing UDP port 19132
- a volume to be attached to the service
The service configuration includes some examples of configuring the server properties via environment variables:
```yaml
environment:
EULA: "TRUE"
GAMEMODE: survival
DIFFICULTY: normal
```
From with in the `examples` directory, you can deploy the composition by using:
```bash
docker-compose up -d
```
You can follow the logs using:
```bash
docker-compose logs -f bds
```
## Deploying with Kubernetes
The [examples](examples) directory contains [an example Kubernetes manifest file](examples/kubernetes.yml) that declares:
- a peristent volume claim (using default storage class)
- a pod deployment that uses the declared PVC
- a service of type LoadBalancer
The pod deployment includes some examples of configuring the server properties via environment variables:
```yaml
env:
- name: EULA
value: "TRUE"
- name: GAMEMODE
value: survival
- name: DIFFICULTY
value: normal
```
The file is deploy-able as-is on most clusters, but has been confirmed on [Docker for Desktop](https://docs.docker.com/docker-for-windows/kubernetes/) and [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine/docs/):
```bash
kubectl apply -f examples/kubernetes.yml
```
You can follow the logs of the deployment using:
```bash
kubectl logs -f deployment/bds
```