Skip to content

Minecraft (Bedrock / Console Edition) Server in Container Manager on a Synology NAS

Important or Recent Updates
Historic UpdatesDate
Guide refreshed and updated for Container Manager22/07/2023
Fixed the folder name in the compose09/08/2023
Due to an upstream issue/change the method to add people to the allow list has changed – guide updated to reflect this (See the compose and notes below)
Also added a new section on how to open up Remote Play using your own address.
12/08/2023
Added additional security option to the compose to restrict the container from gaining new privileges25/10/2023
Fixed a typo of GAMDEMODE which should be GAMEMODE in the compose. Thanks Nikos14/01/2024
Historic updates

In this guide I am going to take you through the steps to get a Minecraft Bedrock server up and running in Container Manager on a Synology NAS.

As Container Manager now supports using Docker Compose in the UI we will be using it as it will save you lots of time and steps!

What on earth is a Docker Compose?
Docker Compose allows us to define how Docker should set up one or more containers within a single configuration file. This file is yaml formatted and Container Manager uses the Projects feature to manage them.

What is the Bedrock Edition?

The Bedrock edition is the version used by all consoles such as the Nintendo Switch, Android, iPhone, and the Windows store edition. If you are looking for a JAVA edition see my other guide.

Let’s Begin

In order for you to successfully use this guide please complete the two additional steps below

Folder Setup

First we need to set up a couple of folders to store our World and config files.

Using File Station create the following folders.

/docker/minecraftbedrock

/docker/projects/minecraftbedrock-compose

Container Set Up

Next we are going to set up a ‘Project’ in Container Manager. Open up Container Manager and click on Project, then on the right-hand side click ‘Create’.

In the next screen we will set up our General Settings.

Project Name’ will be ‘minecraft-bedrock’

Path’ click the button and select the folder we created earlier in ‘/docker/projects/minecraftbedrock-compose’.

Source:’ change the drop-down to ‘Create docker-compose.yml’.

Next we are going to drop in our docker compose configuration, copy all the code in the box below and paste it into line ‘1’ just like the screenshot.

YAML
services:
  minecraft-bedrock-server:
    image: itzg/minecraft-bedrock-server:latest
    container_name: minecraftbedrock
    tty: true
    stdin_open: true
    environment:
      - UID=1234 #CHANGE_TO_YOUR_UID
      - GID=65432 #CHANGE_TO_YOUR_GID
      - EULA=TRUE
      - VERSION=latest
      - SERVER_NAME=NAMEYOURSERVER
      - SERVER_PORT=19132
      - GAMEMODE=survival
      - DIFFICULTY=normal
      - ONLINE_MODE=true
      - OPS=SEE BELOW
      - ALLOW_LIST=true
    volumes:
      - /volume1/docker/minecraftbedrock:/data
    ports:
      - 19132:19132/udp
    network_mode: synobridge
    security_opt:
      - no-new-privileges:true
    restart: unless-stopped

Editing the Config and Environment Variables

Let’s make some edits to the compose in order to customise the server. I am covering the basics here, ITZG has great information over on the documentation which covers the additional variables you can change including how to give permissions to your users.

Take note that some items are UPPERCASE and some are lowercase. This is how they should be set.

Variable (Line)ValueComment/options
UID (6)YOURUIDUID you obtained earlier
GID (7)YOURGIDGID you obtained earlier
EULA (8)trueThis accepts the Minecraft EULA, without this the server will not run
VERSIONlatestThis keeps the server updated to the latest release.
You can also change this to a specific version such as 1.18.10 which is useful if Microsoft updates the server version before releasing new clients!
SERVER_NAMEGive your server a name
SERVER_PORT19132don’t change this
GAMEMODEcreative, survival, adventure
DIFFICULTYpeaceful, easy, normal, hard
ONLINE_MODEtrue or false (true will require you to be signed in to Xbox Live when playing)
OPSyourxuidIn order to get your xuid you will need to visit this site enter your xbox/microsoft gamertag and select decimal (DEC) in the options
WHITE_LISTtrue / falsesee the section further on in the guide for the steps to add people to the White List

Once you have made all your required edits click ‘Next’

Nothing to change on the next screen click ‘Next’ again..

On the final screen just click ‘Done’ and you will see a new window appear which will kick of downloading of the required container image and configure your server.

Adding People to the White List

We can now add additional people to the White List otherwise you will get errors when they attempt to connect

Open up container manager and within the Container list select the Bedrock Server and click Details.

On the next screen click ‘Action’ then ‘Open terminal’

On the Terminal that appears type allowlist add then the exact name of the Friend you want to add including any Capital letters and press Enter.

You can repeat this step for each player you want to add including you.

Connecting to the Server

There are two ways to connect to the server, either via the Friends tab or by adding it manually to the Servers tab in Minecraft. Using your NAS IP:19132

(Optional Extra for Remote Play)

So your friends have an easy way to play remotely lets set up an address for them to connect to!

Before we start, make sure you have registered for a Synology Account as we are going to be using their DDNS service. https://account.synology.com/en-uk/register/

DDNS (Dynamic Domain Name System)

A DDNS address allows you to get external access to Minecraft via an address provided by Synology, this is useful on home internet connections where your ISP will change your IP address on a regular basis.

In the DSM Control panel go to ‘External Access’ and then to the ‘DDNS’ tab

Click on ‘Add’, then fill out the following sections.

SectionValue
Service ProviderSynology
HostnameThis will be the address used to identify your NAS so make it personal to you not specific to this guide.
minecraft.synology.me = BAD
myawesomenas.synology,me =GOOD
Email:Log into your Synology account
External Address (IPv4)This should be filled in automatically
External Address (IPv6)This should be filled in automatically if your ISP is using IPv6
Get a Cert from Let’s EncryptTick this box
Enable HeartbeatTick this box

Now press OK, DSM will apply your settings. It can take a few moments to set up and the DSM interface will refresh. You will likely receive a certificate error which you will need to accept to get back into DSM.

The final step will be to forward port 19132 on your Router to your NAS IP. You will need to refer to your Routers manual on how to do this. As we are using the default Minecraft Bedrock port other players just need to use the address you set up to connect.

You are now all setup and ready to play…




Looking for some help, join our Discord community

If you are struggling with any steps in the guides or looking to branch out into other containers join our Discord community!

Buy me a beverage!

If you have found my site useful please consider pinging me a tip as it helps cover the cost of running things or just lets me stay hydrated. Plus 10% goes to the devs of the apps I do guides for every year.

Published inGaming 7.2

14 Comments

  1. Conifer_IO Conifer_IO

    Hey Dr Frankenstein, your guides are fantastic! Thank you for your efforts on behalf of all kids, big and small.

    If you want to run multiple Bedrock or Java servers on the Synology NAS, do you have any recommendations on how to structure the directories?

    I’m about to unleash my 14 year old on your tutorials and allow her to start spinning up different Minecraft servers but suddenly thought I should ask you if there were any best practices I can pass to her when it comes to organizing multiple servers? Thanks!

    • Dr_Frankenstein Dr_Frankenstein

      Hey!
      So the key parts will be to create separate folders for each server e.g

      /docker/minecraft-server1
      /docker/minecraft-server2
      etc

      Then from a ports’ perspective they will need to have separate ‘external’ ports to avoid clashes this is the port on the left-hand side don’t change the right hand one..

      – 19132:19132/udp
      – 19133:19132/udp
      – 19134:19132/udp

      This can be all part of a single Project by layering in each servers yaml details.

      If either of you get stuck feel free to drop me a message via my Help Me! page.

  2. Nikos Kakouros Nikos Kakouros

    Dear Dr,
    Thank you for the detailed tutorial. Just followed the steps and it the server was up in minutes!
    One minor typo that I noted — GAMDEMODE should be GAMEMODE (in the compose yml)
    Also, I have not been able to pass any more environmental variables over (wanted to add a motd, and allow cheats so I can TP the kids out of trouble). Looking at itzg documentation, I thought this was due to minor difference between spelling of environmental variables and server properties (e.g. ALLOW_CHEATS vs allow-cheats) but that didn’t help. I resorted to editing the server.preferences file directly. Any ideas of why it didn’t work? If one changes the environmental variables, does the server.preferences file get rebuilt upon starting the container?

    • Dr_Frankenstein Dr_Frankenstein

      Hey, yeah odd it wouldn’t accept them as the docs/wiki should be pretty accurate. The server properties should be persistent between upgrades etc so you are safe customising it there.

      Fixed the typo 🙂

    • Dr_Frankenstein Dr_Frankenstein

      Yes – it says it’s temporary by the looks of thing.

      Can you try adding the username instead for the moment

  3. Cha Cha Cha Cha

    Thank you for all the amazing instructions.

    I realized that your instructions state to create a folder in docker called minecraftbedrock but the docker compose calls for:

    volumes:
    – /volume1/docker/bedrock:/data

    In order for me to get it to work I had to change the docker folder to bedrock.

    I have the server running but for the life of me cannot get my child’s account to be recognized. It keeps saying they have not been invited to the server even though I have looked up their Xbox live name and got the HEX number (I also tried DEC number) for both ops and WHITE_LIST_USERS.

    I tried to read more by ITZG in the GitHub but still am unsuccessful. Any advice would be greatly appreciated!

    • Dr_Frankenstein Dr_Frankenstein

      Hey, let me get that path fixed I amended them to no clash with the java version of the guide and must of missed the compose line.

      I will fire up a server tonight and try it my end in case something has changed in relation to the xbox ID! I will reply again later on.

    • Dr_Frankenstein Dr_Frankenstein

      In case you get time to test before I do. Try these options as the ‘ops’ may have changed to ‘OPS’.

      – OPS=”XUID,XUID,XUID”
      you can now also have members and visitors
      – MEMBERS=”XUID,XUID,XUID”
      – VISITORS=”XUID,XUID”

      Then for Whitelists it’s actually a username name, I don’t think this is required unless you specifically want to only allow specific users on the server. Whereas the above is permissions.
      – WHITE_LIST_USERS=”player1,player2,player3″

      I will try on my personal setup again a little later.

      • Cha Cha Cha Cha

        Thank you for looking into it, I have been going crazy trying to get it to work. My child also has not let up on the question: “Have you figured it out yet?”

        Much appreciate all your help!

        • Dr_Frankenstein Dr_Frankenstein

          Hey so just trying out the solution posted on Github – if it works I will be updating the guide shortly.

        • Dr_Frankenstein Dr_Frankenstein

          Hey guide updated with the new steps – you may need to delete the allowed-users.json file that is located in /docker/minecraftbedrock (or what you named it) folder before starting the server after the edits.

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.

drfrankenstein.co.uk – writing Synology Docker Guides since 2016 – Join My Discord!