Minecraft Bedrock¶

Description / name	Input element
Your domain name

Overview¶

Minecraft Bedrock is a server for the multi-platform version of Minecraft.

Manual

Releases

Community

Note

📢 This server will expose the port UDP 19132

Deployment¶

sb install sandbox-minecraft-bedrock

Usage¶

The server will be accessible at minecraft-bedrock.yourdomain.tld or _yourserverip_:19132

Cloudflare CDN

If you are using Cloudflare, you will need to disable the proxy for the subdomain(s) to work correctly. This can be done by clicking the orange cloud next to the subdomain in the DNS settings. Or specify it in the inventory using minecraft-bedrock_dns_proxy: false if you have the global toggle on. Otherwise you won't be able to reach the minecraft server at all.

Role Defaults¶

Use the Inventory to customize variables. (1)

Example override
```
minecraft_bedrock_name: "custom_value"
```
Avoid overriding variables ending in _default

When overriding variables that end in _default (like minecraft_bedrock_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

Instead, use the corresponding _custom variable (like minecraft_bedrock_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsSettingsWebDNSDockerDocker+Global Override Options

minecraft_bedrock_name

# Type: string
minecraft_bedrock_name: minecraft-bedrock

minecraft_bedrock_role_version

# Type: string
minecraft_bedrock_role_version: "LATEST"

minecraft_bedrock_role_web_subdomain

# Type: string
minecraft_bedrock_role_web_subdomain: "{{ minecraft_bedrock_name }}"

minecraft_bedrock_role_web_domain

# Type: string
minecraft_bedrock_role_web_domain: "{{ user.domain }}"

minecraft_bedrock_role_dns_record

# Type: string
minecraft_bedrock_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='minecraft_bedrock') }}"

minecraft_bedrock_role_dns_zone

# Type: string
minecraft_bedrock_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='minecraft_bedrock') }}"

minecraft_bedrock_role_dns_proxy

# Type: bool (true/false)
minecraft_bedrock_role_dns_proxy: false

Container

minecraft_bedrock_role_docker_container

# Type: string
minecraft_bedrock_role_docker_container: "{{ minecraft_bedrock_name }}"

Image

minecraft_bedrock_role_docker_image_pull

# Type: bool (true/false)
minecraft_bedrock_role_docker_image_pull: true

minecraft_bedrock_role_docker_image_tag

# Type: string
minecraft_bedrock_role_docker_image_tag: "latest"

minecraft_bedrock_role_docker_image_repo

# Type: string
minecraft_bedrock_role_docker_image_repo: "itzg/minecraft-bedrock-server"

minecraft_bedrock_role_docker_image

# Type: string
minecraft_bedrock_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='minecraft_bedrock') }}:{{ lookup('role_var', '_docker_image_tag', role='minecraft_bedrock') }}"

Ports

minecraft_bedrock_role_docker_ports_default

# Type: list
minecraft_bedrock_role_docker_ports_default:
  - "19132:19132/udp"

minecraft_bedrock_role_docker_ports_custom

# Type: list
minecraft_bedrock_role_docker_ports_custom: []

Envs

minecraft_bedrock_role_docker_envs_default

# Type: dict
minecraft_bedrock_role_docker_envs_default:
  TZ: "{{ tz }}"
  UID: "{{ uid }}"
  GID: "{{ gid }}"
  EULA: "TRUE"
  VERSION: "{{ lookup('role_var', '_version', role='minecraft_bedrock') }}"

minecraft_bedrock_role_docker_envs_custom

# Type: dict
minecraft_bedrock_role_docker_envs_custom: {}

Volumes

minecraft_bedrock_role_docker_volumes_default

# Type: list
minecraft_bedrock_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='minecraft_bedrock') }}:/data"

minecraft_bedrock_role_docker_volumes_custom

# Type: list
minecraft_bedrock_role_docker_volumes_custom: []

Hostname

minecraft_bedrock_role_docker_hostname

# Type: string
minecraft_bedrock_role_docker_hostname: "{{ minecraft_bedrock_name }}"

Networks

minecraft_bedrock_role_docker_networks_alias

# Type: string
minecraft_bedrock_role_docker_networks_alias: "{{ minecraft_bedrock_name }}"

minecraft_bedrock_role_docker_networks_default

# Type: list
minecraft_bedrock_role_docker_networks_default: []

minecraft_bedrock_role_docker_networks_custom

# Type: list
minecraft_bedrock_role_docker_networks_custom: []

Restart Policy

minecraft_bedrock_role_docker_restart_policy

# Type: string
minecraft_bedrock_role_docker_restart_policy: unless-stopped

State

minecraft_bedrock_role_docker_state

# Type: string
minecraft_bedrock_role_docker_state: started

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

minecraft_bedrock_role_docker_blkio_weight

# Type: int
minecraft_bedrock_role_docker_blkio_weight:

minecraft_bedrock_role_docker_cpu_period

# Type: int
minecraft_bedrock_role_docker_cpu_period:

minecraft_bedrock_role_docker_cpu_quota

# Type: int
minecraft_bedrock_role_docker_cpu_quota:

minecraft_bedrock_role_docker_cpu_shares

# Type: int
minecraft_bedrock_role_docker_cpu_shares:

minecraft_bedrock_role_docker_cpus

# Type: string
minecraft_bedrock_role_docker_cpus:

minecraft_bedrock_role_docker_cpuset_cpus

# Type: string
minecraft_bedrock_role_docker_cpuset_cpus:

minecraft_bedrock_role_docker_cpuset_mems

# Type: string
minecraft_bedrock_role_docker_cpuset_mems:

minecraft_bedrock_role_docker_kernel_memory

# Type: string
minecraft_bedrock_role_docker_kernel_memory:

minecraft_bedrock_role_docker_memory

# Type: string
minecraft_bedrock_role_docker_memory:

minecraft_bedrock_role_docker_memory_reservation

# Type: string
minecraft_bedrock_role_docker_memory_reservation:

minecraft_bedrock_role_docker_memory_swap

# Type: string
minecraft_bedrock_role_docker_memory_swap:

minecraft_bedrock_role_docker_memory_swappiness

# Type: int
minecraft_bedrock_role_docker_memory_swappiness:

minecraft_bedrock_role_docker_shm_size

# Type: string
minecraft_bedrock_role_docker_shm_size:

Security & Devices

minecraft_bedrock_role_docker_cap_drop

# Type: list
minecraft_bedrock_role_docker_cap_drop:

minecraft_bedrock_role_docker_cgroupns_mode

# Type: string
minecraft_bedrock_role_docker_cgroupns_mode:

minecraft_bedrock_role_docker_device_cgroup_rules

# Type: list
minecraft_bedrock_role_docker_device_cgroup_rules:

minecraft_bedrock_role_docker_device_read_bps

# Type: list
minecraft_bedrock_role_docker_device_read_bps:

minecraft_bedrock_role_docker_device_read_iops

# Type: list
minecraft_bedrock_role_docker_device_read_iops:

minecraft_bedrock_role_docker_device_requests

# Type: list
minecraft_bedrock_role_docker_device_requests:

minecraft_bedrock_role_docker_device_write_bps

# Type: list
minecraft_bedrock_role_docker_device_write_bps:

minecraft_bedrock_role_docker_device_write_iops

# Type: list
minecraft_bedrock_role_docker_device_write_iops:

minecraft_bedrock_role_docker_devices

# Type: list
minecraft_bedrock_role_docker_devices:

minecraft_bedrock_role_docker_devices_default

# Type: string
minecraft_bedrock_role_docker_devices_default:

minecraft_bedrock_role_docker_groups

# Type: list
minecraft_bedrock_role_docker_groups:

minecraft_bedrock_role_docker_privileged

# Type: bool (true/false)
minecraft_bedrock_role_docker_privileged:

minecraft_bedrock_role_docker_security_opts

# Type: list
minecraft_bedrock_role_docker_security_opts:

minecraft_bedrock_role_docker_user

# Type: string
minecraft_bedrock_role_docker_user:

minecraft_bedrock_role_docker_userns_mode

# Type: string
minecraft_bedrock_role_docker_userns_mode:

Networking

minecraft_bedrock_role_docker_dns_opts

# Type: list
minecraft_bedrock_role_docker_dns_opts:

minecraft_bedrock_role_docker_dns_search_domains

# Type: list
minecraft_bedrock_role_docker_dns_search_domains:

minecraft_bedrock_role_docker_dns_servers

# Type: list
minecraft_bedrock_role_docker_dns_servers:

minecraft_bedrock_role_docker_domainname

# Type: string
minecraft_bedrock_role_docker_domainname:

minecraft_bedrock_role_docker_exposed_ports

# Type: list
minecraft_bedrock_role_docker_exposed_ports:

minecraft_bedrock_role_docker_hosts

# Type: dict
minecraft_bedrock_role_docker_hosts:

minecraft_bedrock_role_docker_hosts_use_common

# Type: bool (true/false)
minecraft_bedrock_role_docker_hosts_use_common:

minecraft_bedrock_role_docker_ipc_mode

# Type: string
minecraft_bedrock_role_docker_ipc_mode:

minecraft_bedrock_role_docker_links

# Type: list
minecraft_bedrock_role_docker_links:

minecraft_bedrock_role_docker_network_mode

# Type: string
minecraft_bedrock_role_docker_network_mode:

minecraft_bedrock_role_docker_pid_mode

# Type: string
minecraft_bedrock_role_docker_pid_mode:

minecraft_bedrock_role_docker_uts

# Type: string
minecraft_bedrock_role_docker_uts:

Storage

minecraft_bedrock_role_docker_keep_volumes

# Type: bool (true/false)
minecraft_bedrock_role_docker_keep_volumes:

minecraft_bedrock_role_docker_mounts

# Type: list
minecraft_bedrock_role_docker_mounts:

minecraft_bedrock_role_docker_storage_opts

# Type: dict
minecraft_bedrock_role_docker_storage_opts:

minecraft_bedrock_role_docker_tmpfs

# Type: list
minecraft_bedrock_role_docker_tmpfs:

minecraft_bedrock_role_docker_volume_driver

# Type: string
minecraft_bedrock_role_docker_volume_driver:

minecraft_bedrock_role_docker_volumes_from

# Type: list
minecraft_bedrock_role_docker_volumes_from:

minecraft_bedrock_role_docker_volumes_global

# Type: bool (true/false)
minecraft_bedrock_role_docker_volumes_global:

minecraft_bedrock_role_docker_working_dir

# Type: string
minecraft_bedrock_role_docker_working_dir:

Monitoring & Lifecycle

minecraft_bedrock_role_docker_auto_remove

# Type: bool (true/false)
minecraft_bedrock_role_docker_auto_remove:

minecraft_bedrock_role_docker_cleanup

# Type: bool (true/false)
minecraft_bedrock_role_docker_cleanup:

minecraft_bedrock_role_docker_force_kill

# Type: string
minecraft_bedrock_role_docker_force_kill:

minecraft_bedrock_role_docker_healthcheck

# Type: dict
minecraft_bedrock_role_docker_healthcheck:

minecraft_bedrock_role_docker_healthy_wait_timeout

# Type: int
minecraft_bedrock_role_docker_healthy_wait_timeout:

minecraft_bedrock_role_docker_init

# Type: bool (true/false)
minecraft_bedrock_role_docker_init:

minecraft_bedrock_role_docker_kill_signal

# Type: string
minecraft_bedrock_role_docker_kill_signal:

minecraft_bedrock_role_docker_log_driver

# Type: string
minecraft_bedrock_role_docker_log_driver:

minecraft_bedrock_role_docker_log_options

# Type: dict
minecraft_bedrock_role_docker_log_options:

minecraft_bedrock_role_docker_oom_killer

# Type: bool (true/false)
minecraft_bedrock_role_docker_oom_killer:

minecraft_bedrock_role_docker_oom_score_adj

# Type: int
minecraft_bedrock_role_docker_oom_score_adj:

minecraft_bedrock_role_docker_output_logs

# Type: bool (true/false)
minecraft_bedrock_role_docker_output_logs:

minecraft_bedrock_role_docker_paused

# Type: bool (true/false)
minecraft_bedrock_role_docker_paused:

minecraft_bedrock_role_docker_recreate

# Type: bool (true/false)
minecraft_bedrock_role_docker_recreate:

minecraft_bedrock_role_docker_restart_retries

# Type: int
minecraft_bedrock_role_docker_restart_retries:

minecraft_bedrock_role_docker_stop_timeout

# Type: int
minecraft_bedrock_role_docker_stop_timeout:

Other Options

minecraft_bedrock_role_docker_capabilities

# Type: list
minecraft_bedrock_role_docker_capabilities:

minecraft_bedrock_role_docker_cgroup_parent

# Type: string
minecraft_bedrock_role_docker_cgroup_parent:

minecraft_bedrock_role_docker_commands

# Type: list
minecraft_bedrock_role_docker_commands:

minecraft_bedrock_role_docker_create_timeout

# Type: int
minecraft_bedrock_role_docker_create_timeout:

minecraft_bedrock_role_docker_entrypoint

# Type: string
minecraft_bedrock_role_docker_entrypoint:

minecraft_bedrock_role_docker_env_file

# Type: string
minecraft_bedrock_role_docker_env_file:

minecraft_bedrock_role_docker_labels

# Type: dict
minecraft_bedrock_role_docker_labels:

minecraft_bedrock_role_docker_labels_use_common

# Type: bool (true/false)
minecraft_bedrock_role_docker_labels_use_common:

minecraft_bedrock_role_docker_read_only

# Type: bool (true/false)
minecraft_bedrock_role_docker_read_only:

minecraft_bedrock_role_docker_runtime

# Type: string
minecraft_bedrock_role_docker_runtime:

minecraft_bedrock_role_docker_sysctls

# Type: list
minecraft_bedrock_role_docker_sysctls:

minecraft_bedrock_role_docker_ulimits

# Type: list
minecraft_bedrock_role_docker_ulimits:

minecraft_bedrock_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
minecraft_bedrock_role_autoheal_enabled: true

minecraft_bedrock_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
minecraft_bedrock_role_depends_on: ""

minecraft_bedrock_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
minecraft_bedrock_role_depends_on_delay: "0"

minecraft_bedrock_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
minecraft_bedrock_role_depends_on_healthchecks:

minecraft_bedrock_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
minecraft_bedrock_role_diun_enabled: true

minecraft_bedrock_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
minecraft_bedrock_role_dns_enabled: true

minecraft_bedrock_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
minecraft_bedrock_role_docker_controller: true

minecraft_bedrock_role_docker_image_repo

# Type: string
minecraft_bedrock_role_docker_image_repo:

minecraft_bedrock_role_docker_image_tag

# Type: string
minecraft_bedrock_role_docker_image_tag:

minecraft_bedrock_role_docker_volumes_download

# Type: bool (true/false)
minecraft_bedrock_role_docker_volumes_download:

minecraft_bedrock_role_paths_location

# Type: string
minecraft_bedrock_role_paths_location:

minecraft_bedrock_role_version

# Type: string
minecraft_bedrock_role_version:

minecraft_bedrock_role_web_domain

# Type: string
minecraft_bedrock_role_web_domain:

minecraft_bedrock_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
minecraft_bedrock_role_web_fqdn_override:

Example Override

minecraft_bedrock_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "minecraft_bedrock2.{{ user.domain }}"
  - "minecraft_bedrock.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

minecraft_bedrock_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
minecraft_bedrock_role_web_host_override:

Example Override

minecraft_bedrock_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'minecraft_bedrock2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

minecraft_bedrock_role_web_http_port

# Type: string (quoted number)
minecraft_bedrock_role_web_http_port:

minecraft_bedrock_role_web_http_scheme

# Type: string ("http"/"https")
minecraft_bedrock_role_web_http_scheme:

minecraft_bedrock_role_web_http_serverstransport

# Type: dict/omit
minecraft_bedrock_role_web_http_serverstransport:

minecraft_bedrock_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
minecraft_bedrock_role_web_scheme:

minecraft_bedrock_role_web_serverstransport

# Type: dict/omit
minecraft_bedrock_role_web_serverstransport:

minecraft_bedrock_role_web_subdomain

# Type: string
minecraft_bedrock_role_web_subdomain: