mikenye/minecraft_bedrock_server repository overview

⁠mikenye/minecraft_bedrock_server

This container provides a Minecraft Bedrock server!

• Automatic bedrock_server restarting after crash (thanks to s6-overlay⁠)
• Container health monitoring! (thanks to mc-monitor⁠)
• Ability to send server commands via docker exec (without attaching), useful for scripting.
• Automated and regular online worldfile backups (using save hold, save query & save resume), with backup rotation.
• Clean shutdown of bedrock_server on container stop.
• All server.properties variables exposed via environment variables.
• bedrock_server binary runs as an unprivileged user.

⁠Quick Start - Example with docker run

⁠Create docker volumes

docker volume create minecraft_worlds
docker volume create minecraft_backups
docker volume create minecraft_whitelist
docker volume create minecraft_permissions

⁠Create container

docker run \
    -d \
    -it \
    --name=mc \
    --restart=always \
    -e TZ="Australia/Perth" \
    -e MINECRAFT_SERVER_NAME="Distant Lands Server" \
    -e MINECRAFT_GAMEMODE="survival" \
    -e MINECRAFT_DIFFICULTY="easy" \
    -e MINECRAFT_LEVEL_NAME="Distant Lands" \
    -e MINECRAFT_WHITE_LIST="true" \
    -v minecraft_worlds:/opt/minecraft/worlds \
    -v minecraft_backups:/opt/minecraft/worlds_backup \
    -v minecraft_whitelist:/opt/minecraft/whitelist \
    -v minecraft_permissions:/opt/minecraft/permissions \
    -p 19132:19132/udp \
    mikenye/minecraft_bedrock_server

⁠Whitelist yourself

docker exec mc sendcmd whitelist add "yourself"

⁠Op yourself

docker exec mc sendcmd op "yourself"

⁠Watch container logs

docker logs -f mc

⁠Quick Start - Example with docker-compose

⁠Contents of docker-compose.yml

version: '3.8'

volumes:
  minecraft_worlds:
    driver: local
  minecraft_backups:
    driver: local
  minecraft_whitelist:
    driver: local
  minecraft_permissions:
    driver: local

services:
  minecraft:
    image: mikenye/minecraft_bedrock_server
    container_name: mc
    tty: true
    restart: always
    ports:
      - "19132:19132/udp"
    environment:
      TZ: "Australia/Perth"
      MINECRAFT_SERVER_NAME: "Distant Lands Server"
      MINECRAFT_GAMEMODE: "survival"
      MINECRAFT_DIFFICULTY: "easy"
      MINECRAFT_LEVEL_NAME: "Distant Lands"
      MINECRAFT_WHITE_LIST: "true"
    volumes:
      - "minecraft_worlds:/opt/minecraft/worlds"
      - "minecraft_backups:/opt/minecraft/worlds_backup"
      - "minecraft_whitelist:/opt/minecraft/whitelist"
      - "minecraft_permissions:/opt/minecraft/permissions"

After you've issued the docker-compose up -d to bring the environment online, you can then whitelist & op yourself as-per the above commands.

⁠Environment Variables

⁠Container Configuration

⁠Minecraft Server Configuration (server.properties)

All of the variables below are optional. If not set, the default value from server.properties is used.

⁠Paths

The following paths should be mapped to external volumes to prevent losing your worlds and so your whitelist.json & permissions.json persist.

You shouldn't map server.properties, as this file is created on container start using the environment variables MINECRAFT_* (see above).

⁠Ports

The container exposes UDP ports 19132 for IPv4 and 19133 for IPv6.

When publishing the container's ports to the host, you should add /udp to your publish argument. For example:

• docker run -p 19132:19132/udp ...
• For docker-compose.yml:

...
  ports:
    - "19132:19132/udp"
...

⁠Backups

World file backups are taken every BACKUP_FREQUENCY, and the most recent BACKUP_RETENTION backups are kept.

For example, if you leave these two variables at their default of 1 and 24 respectively, you will have a maximum of 24 hourly backups.

Manual backups can be triggered via the manual_backup command, see below. Manual backups are automatically cleaned up after they exceed the BACKUP_RETENTION age.

The backup process is as follows:

1. bedrock_server is placed into save hold mode to allow a backup to take place while the server is running.
2. Wait intil save query reports that the server is ready for an online backup to take place.
3. The files returned in save query are copied to temporary directory /opt/minecraft/worlds_backup/<world name>/<current datetime>.
4. The files copied are truncated to the sizes returned in save query.
5. The files copied are compressed into a /opt/minecraft/worlds_backup/<world name>/<current datetime>.tar.xz.
6. The temporary directory /opt/minecraft/worlds_backup/<world name>/<current datetime> is removed.
7. Any backups files in /opt/minecraft/worlds_backup older than BACKUP_RETENTION hours are removed.
8. Any empty directories in /opt/minecraft/worlds_backup are removed.

Backups are owned by root. This is by design so that in the event the server becomes compromised, your worldfile backups should not be able to be removed (as the server binary runs as an unprivileged user).

To restore from backup, you can uncompress the backup file (tar -xJvf <.tar.xz file>) and copy the files into the /opt/minecraft/worlds/<world name>, and start up the server. You may need xz-tools for your tar to be able to understand .xz files.

⁠Management Commands

There are several helper commands built into the container to help with the management of your Minecraft server.

These can be triggered by using the command docker exec <container> <command>, where:

• <container> is the name of your Minecraft server container (in the examples below, this is mc).
• <command> is one of the commands below.

⁠Server Commands

The following server commands can be used with docker exec <container> sendcmd <command>:

⁠Whitelist Management

Adding/removing gamertags to/from server's whitelist can be done by either:

• Editing the whitelist.json file and issuing the server commend whitelist reload (eg: docker exec <container> sendcmd whitelist reload); or
• Using server commands, eg:
  • Adding: docker exec <container> sendcmd whitelist add <Gamertag>.
  • Removing: docker exec <container> sendcmd whitelist remove <Gamertag>.
  • Note: If there is a white-space in the Gamertag you need to enclose it with double quates: docker exec <container> sendcmd whitelist add "Example Name".

⁠Permissions Management

Adding/removing server permissions can be done by either:

• Editing the permissions.json file and issuing the server commend permission reload (eg: docker exec <container> sendcmd permission reload); or
• Using server commands, eg:
  • Opping: docker exec <container> sendcmd op <player>.
  • Deopping: docker exec <container> sendcmd deop <player>.
  • Note: If there is a white-space in the player name you need to enclose it with double quates: docker exec <container> sendcmd op "Example Name".

⁠Getting help

Please feel free to open an issue on the project's GitHub⁠.

⁠Changelog

See a list of merged pull requests here⁠