Minecraft Server on Docker

Description / name	Input element
Your domain name

Overview

Minecraft Server on Docker is a containerized solution that allows users to run a Minecraft server.

Manual

Releases

Community

---

Configuration

• Set inventory variables for single or multi-server setups:
• minecraft_instances: List of server instances.
• minecraft_docker_image_tag: Docker image tag for all servers.
• instanceName_docker_image_tag: Override tag per instance.
• Cloudflare users: Disable proxy for subdomains or set minecraft_dns_proxy: false in inventory.
• Resource limits and advanced Docker options can be set via inventory variables.

For multiple servers, list instance names in your inventory:

minecraft_instances: ["mcserver1", "mcserver2"]

Deployment

Install the Minecraft server and MC-Router:

sb install sandbox-minecraft

Usage

• Join the server using the Minecraft client:
• Single server: minecraft.yourdomain.tld
• Multiple servers: instanceName.yourdomain.tld
• Change server settings by updating inventory variables and redeploying.

Basics

• No in-app preferences; all setup is handled via inventory configuration.
• Default settings run a single server.
• For multi-server, add instance names to minecraft_instances.

Role Defaults

Variables can be customized using the Inventory. (1)

1. This role supports multiple instances via minecraft_instances.

   Example override

   Role-scopedInstance-scoped

   minecraft_role_web_subdomain: "custom"
   

   Applies to all instances of minecraft

   minecraft2_web_subdomain: "custom2"
   

   Applies to the instance named minecraft2

   Avoid overriding variables ending in _default

   When overriding variables that end in _default (like minecraft_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_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsSettingsWebDNSTraefikPortsDockerDocker+Global Override Options

minecraft_instances

# Type: list
minecraft_instances: ["minecraft"]

Example Override

# Type: list
minecraft_instances: ["minecraft", "minecraft2"]

minecraft_role_dynmap_router_enabledminecraft2_dynmap_router_enabled

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

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

minecraft_role_web_subdomainminecraft2_web_subdomain

# Type: string
minecraft_role_web_subdomain: "{{ minecraft_name }}"

# Type: string
minecraft2_web_subdomain: "{{ minecraft_name }}"

minecraft_role_web_domainminecraft2_web_domain

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

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

minecraft_role_web_portminecraft2_web_port

# Dynmap
# Type: string
minecraft_role_web_port: "8123"

# Dynmap
# Type: string
minecraft2_web_port: "8123"

minecraft_role_dns_recordminecraft2_dns_record

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

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

minecraft_role_dns_zoneminecraft2_dns_zone

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

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

minecraft_role_dns_proxyminecraft2_dns_proxy

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

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

minecraft_role_traefik_sso_middlewareminecraft2_traefik_sso_middleware

# Type: string
minecraft_role_traefik_sso_middleware: ""

# Type: string
minecraft2_traefik_sso_middleware: ""

minecraft_role_traefik_middleware_defaultminecraft2_traefik_middleware_default

# Type: string
minecraft_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

# Type: string
minecraft2_traefik_middleware_default: "{{ traefik_default_middleware }}"

minecraft_role_traefik_middleware_customminecraft2_traefik_middleware_custom

# Type: string
minecraft_role_traefik_middleware_custom: ""

# Type: string
minecraft2_traefik_middleware_custom: ""

minecraft_role_traefik_certresolverminecraft2_traefik_certresolver

# Type: string
minecraft_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

# Type: string
minecraft2_traefik_certresolver: "{{ traefik_default_certresolver }}"

minecraft_role_traefik_enabledminecraft2_traefik_enabled

# Type: string
minecraft_role_traefik_enabled: "{{ lookup('role_var', '_dynmap_router_enabled', role='minecraft') }}"

# Type: string
minecraft2_traefik_enabled: "{{ lookup('role_var', '_dynmap_router_enabled', role='minecraft') }}"

minecraft_role_docker_ports_25565minecraft2_docker_ports_25565

# Type: string
minecraft_role_docker_ports_25565: "{{ port_lookup_minecraft_tcp.meta.port
                                    if (port_lookup_minecraft_tcp.meta.port is defined) and (port_lookup_minecraft_tcp.meta.port | trim | length > 0)
                                    else '25565' }}"

# Type: string
minecraft2_docker_ports_25565: "{{ port_lookup_minecraft_tcp.meta.port
                                if (port_lookup_minecraft_tcp.meta.port is defined) and (port_lookup_minecraft_tcp.meta.port | trim | length > 0)
                                else '25565' }}"

Container

minecraft_role_docker_containerminecraft2_docker_container

# Type: string
minecraft_role_docker_container: "{{ minecraft_name }}"

# Type: string
minecraft2_docker_container: "{{ minecraft_name }}"

Image

minecraft_role_docker_image_pullminecraft2_docker_image_pull

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

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

minecraft_role_docker_image_repominecraft2_docker_image_repo

# Type: string
minecraft_role_docker_image_repo: "itzg/minecraft-server"

# Type: string
minecraft2_docker_image_repo: "itzg/minecraft-server"

minecraft_role_docker_image_tagminecraft2_docker_image_tag

# Type: string
minecraft_role_docker_image_tag: "latest"

# Type: string
minecraft2_docker_image_tag: "latest"

minecraft_role_docker_imageminecraft2_docker_image

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

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

Ports

minecraft_role_docker_ports_defaultminecraft2_docker_ports_default

# Type: list
minecraft_role_docker_ports_default:
  - "{{ lookup('role_var', '_docker_ports_25565', role='minecraft') }}:25565/tcp"

# Type: list
minecraft2_docker_ports_default:
  - "{{ lookup('role_var', '_docker_ports_25565', role='minecraft') }}:25565/tcp"

minecraft_role_docker_ports_customminecraft2_docker_ports_custom

# Type: list
minecraft_role_docker_ports_custom: []

# Type: list
minecraft2_docker_ports_custom: []

Envs

minecraft_role_docker_envs_defaultminecraft2_docker_envs_default

# Type: dict
minecraft_role_docker_envs_default:
  TZ: "{{ tz }}"
  EULA: "TRUE"
  UID: "{{ uid }}"
  GID: "{{ gid }}"

# Type: dict
minecraft2_docker_envs_default:
  TZ: "{{ tz }}"
  EULA: "TRUE"
  UID: "{{ uid }}"
  GID: "{{ gid }}"

minecraft_role_docker_envs_customminecraft2_docker_envs_custom

# Type: dict
minecraft_role_docker_envs_custom: {}

# Type: dict
minecraft2_docker_envs_custom: {}

Volumes

minecraft_role_docker_volumes_defaultminecraft2_docker_volumes_default

# Type: list
minecraft_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='minecraft') }}/{{ minecraft_name }}/data:/data"

# Type: list
minecraft2_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='minecraft') }}/{{ minecraft_name }}/data:/data"

minecraft_role_docker_volumes_customminecraft2_docker_volumes_custom

# Type: list
minecraft_role_docker_volumes_custom: []

# Type: list
minecraft2_docker_volumes_custom: []

Hostname

minecraft_role_docker_hostnameminecraft2_docker_hostname

# Type: string
minecraft_role_docker_hostname: "{{ minecraft_name }}"

# Type: string
minecraft2_docker_hostname: "{{ minecraft_name }}"

Networks

minecraft_role_docker_networks_aliasminecraft2_docker_networks_alias

# Type: string
minecraft_role_docker_networks_alias: "{{ minecraft_name }}"

# Type: string
minecraft2_docker_networks_alias: "{{ minecraft_name }}"

minecraft_role_docker_networks_defaultminecraft2_docker_networks_default

# Type: list
minecraft_role_docker_networks_default: []

# Type: list
minecraft2_docker_networks_default: []

minecraft_role_docker_networks_customminecraft2_docker_networks_custom

# Type: list
minecraft_role_docker_networks_custom: []

# Type: list
minecraft2_docker_networks_custom: []

Restart Policy

minecraft_role_docker_restart_policyminecraft2_docker_restart_policy

# Type: string
minecraft_role_docker_restart_policy: unless-stopped

# Type: string
minecraft2_docker_restart_policy: unless-stopped

Stop Timeout

minecraft_role_docker_stop_timeoutminecraft2_docker_stop_timeout

# Type: int
minecraft_role_docker_stop_timeout: 900

# Type: int
minecraft2_docker_stop_timeout: 900

State

minecraft_role_docker_stateminecraft2_docker_state

# Type: string
minecraft_role_docker_state: started

# Type: string
minecraft2_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_role_docker_blkio_weightminecraft2_docker_blkio_weight

# Type: int
minecraft_role_docker_blkio_weight:

# Type: int
minecraft2_docker_blkio_weight:

minecraft_role_docker_cpu_periodminecraft2_docker_cpu_period

# Type: int
minecraft_role_docker_cpu_period:

# Type: int
minecraft2_docker_cpu_period:

minecraft_role_docker_cpu_quotaminecraft2_docker_cpu_quota

# Type: int
minecraft_role_docker_cpu_quota:

# Type: int
minecraft2_docker_cpu_quota:

minecraft_role_docker_cpu_sharesminecraft2_docker_cpu_shares

# Type: int
minecraft_role_docker_cpu_shares:

# Type: int
minecraft2_docker_cpu_shares:

minecraft_role_docker_cpusminecraft2_docker_cpus

# Type: string
minecraft_role_docker_cpus:

# Type: string
minecraft2_docker_cpus:

minecraft_role_docker_cpuset_cpusminecraft2_docker_cpuset_cpus

# Type: string
minecraft_role_docker_cpuset_cpus:

# Type: string
minecraft2_docker_cpuset_cpus:

minecraft_role_docker_cpuset_memsminecraft2_docker_cpuset_mems

# Type: string
minecraft_role_docker_cpuset_mems:

# Type: string
minecraft2_docker_cpuset_mems:

minecraft_role_docker_kernel_memoryminecraft2_docker_kernel_memory

# Type: string
minecraft_role_docker_kernel_memory:

# Type: string
minecraft2_docker_kernel_memory:

minecraft_role_docker_memoryminecraft2_docker_memory

# Type: string
minecraft_role_docker_memory:

# Type: string
minecraft2_docker_memory:

minecraft_role_docker_memory_reservationminecraft2_docker_memory_reservation

# Type: string
minecraft_role_docker_memory_reservation:

# Type: string
minecraft2_docker_memory_reservation:

minecraft_role_docker_memory_swapminecraft2_docker_memory_swap

# Type: string
minecraft_role_docker_memory_swap:

# Type: string
minecraft2_docker_memory_swap:

minecraft_role_docker_memory_swappinessminecraft2_docker_memory_swappiness

# Type: int
minecraft_role_docker_memory_swappiness:

# Type: int
minecraft2_docker_memory_swappiness:

minecraft_role_docker_shm_sizeminecraft2_docker_shm_size

# Type: string
minecraft_role_docker_shm_size:

# Type: string
minecraft2_docker_shm_size:

Security & Devices

minecraft_role_docker_cap_dropminecraft2_docker_cap_drop

# Type: list
minecraft_role_docker_cap_drop:

# Type: list
minecraft2_docker_cap_drop:

minecraft_role_docker_cgroupns_modeminecraft2_docker_cgroupns_mode

# Type: string
minecraft_role_docker_cgroupns_mode:

# Type: string
minecraft2_docker_cgroupns_mode:

minecraft_role_docker_device_cgroup_rulesminecraft2_docker_device_cgroup_rules

# Type: list
minecraft_role_docker_device_cgroup_rules:

# Type: list
minecraft2_docker_device_cgroup_rules:

minecraft_role_docker_device_read_bpsminecraft2_docker_device_read_bps

# Type: list
minecraft_role_docker_device_read_bps:

# Type: list
minecraft2_docker_device_read_bps:

minecraft_role_docker_device_read_iopsminecraft2_docker_device_read_iops

# Type: list
minecraft_role_docker_device_read_iops:

# Type: list
minecraft2_docker_device_read_iops:

minecraft_role_docker_device_requestsminecraft2_docker_device_requests

# Type: list
minecraft_role_docker_device_requests:

# Type: list
minecraft2_docker_device_requests:

minecraft_role_docker_device_write_bpsminecraft2_docker_device_write_bps

# Type: list
minecraft_role_docker_device_write_bps:

# Type: list
minecraft2_docker_device_write_bps:

minecraft_role_docker_device_write_iopsminecraft2_docker_device_write_iops

# Type: list
minecraft_role_docker_device_write_iops:

# Type: list
minecraft2_docker_device_write_iops:

minecraft_role_docker_devicesminecraft2_docker_devices

# Type: list
minecraft_role_docker_devices:

# Type: list
minecraft2_docker_devices:

minecraft_role_docker_devices_defaultminecraft2_docker_devices_default

# Type: string
minecraft_role_docker_devices_default:

# Type: string
minecraft2_docker_devices_default:

minecraft_role_docker_groupsminecraft2_docker_groups

# Type: list
minecraft_role_docker_groups:

# Type: list
minecraft2_docker_groups:

minecraft_role_docker_privilegedminecraft2_docker_privileged

# Type: bool (true/false)
minecraft_role_docker_privileged:

# Type: bool (true/false)
minecraft2_docker_privileged:

minecraft_role_docker_security_optsminecraft2_docker_security_opts

# Type: list
minecraft_role_docker_security_opts:

# Type: list
minecraft2_docker_security_opts:

minecraft_role_docker_userminecraft2_docker_user

# Type: string
minecraft_role_docker_user:

# Type: string
minecraft2_docker_user:

minecraft_role_docker_userns_modeminecraft2_docker_userns_mode

# Type: string
minecraft_role_docker_userns_mode:

# Type: string
minecraft2_docker_userns_mode:

Networking

minecraft_role_docker_dns_optsminecraft2_docker_dns_opts

# Type: list
minecraft_role_docker_dns_opts:

# Type: list
minecraft2_docker_dns_opts:

minecraft_role_docker_dns_search_domainsminecraft2_docker_dns_search_domains

# Type: list
minecraft_role_docker_dns_search_domains:

# Type: list
minecraft2_docker_dns_search_domains:

minecraft_role_docker_dns_serversminecraft2_docker_dns_servers

# Type: list
minecraft_role_docker_dns_servers:

# Type: list
minecraft2_docker_dns_servers:

minecraft_role_docker_domainnameminecraft2_docker_domainname

# Type: string
minecraft_role_docker_domainname:

# Type: string
minecraft2_docker_domainname:

minecraft_role_docker_exposed_portsminecraft2_docker_exposed_ports

# Type: list
minecraft_role_docker_exposed_ports:

# Type: list
minecraft2_docker_exposed_ports:

minecraft_role_docker_hostsminecraft2_docker_hosts

# Type: dict
minecraft_role_docker_hosts:

# Type: dict
minecraft2_docker_hosts:

minecraft_role_docker_hosts_use_commonminecraft2_docker_hosts_use_common

# Type: bool (true/false)
minecraft_role_docker_hosts_use_common:

# Type: bool (true/false)
minecraft2_docker_hosts_use_common:

minecraft_role_docker_ipc_modeminecraft2_docker_ipc_mode

# Type: string
minecraft_role_docker_ipc_mode:

# Type: string
minecraft2_docker_ipc_mode:

minecraft_role_docker_linksminecraft2_docker_links

# Type: list
minecraft_role_docker_links:

# Type: list
minecraft2_docker_links:

minecraft_role_docker_network_modeminecraft2_docker_network_mode

# Type: string
minecraft_role_docker_network_mode:

# Type: string
minecraft2_docker_network_mode:

minecraft_role_docker_pid_modeminecraft2_docker_pid_mode

# Type: string
minecraft_role_docker_pid_mode:

# Type: string
minecraft2_docker_pid_mode:

minecraft_role_docker_utsminecraft2_docker_uts

# Type: string
minecraft_role_docker_uts:

# Type: string
minecraft2_docker_uts:

Storage

minecraft_role_docker_keep_volumesminecraft2_docker_keep_volumes

# Type: bool (true/false)
minecraft_role_docker_keep_volumes:

# Type: bool (true/false)
minecraft2_docker_keep_volumes:

minecraft_role_docker_mountsminecraft2_docker_mounts

# Type: list
minecraft_role_docker_mounts:

# Type: list
minecraft2_docker_mounts:

minecraft_role_docker_storage_optsminecraft2_docker_storage_opts

# Type: dict
minecraft_role_docker_storage_opts:

# Type: dict
minecraft2_docker_storage_opts:

minecraft_role_docker_tmpfsminecraft2_docker_tmpfs

# Type: list
minecraft_role_docker_tmpfs:

# Type: list
minecraft2_docker_tmpfs:

minecraft_role_docker_volume_driverminecraft2_docker_volume_driver

# Type: string
minecraft_role_docker_volume_driver:

# Type: string
minecraft2_docker_volume_driver:

minecraft_role_docker_volumes_fromminecraft2_docker_volumes_from

# Type: list
minecraft_role_docker_volumes_from:

# Type: list
minecraft2_docker_volumes_from:

minecraft_role_docker_volumes_globalminecraft2_docker_volumes_global

# Type: bool (true/false)
minecraft_role_docker_volumes_global:

# Type: bool (true/false)
minecraft2_docker_volumes_global:

minecraft_role_docker_working_dirminecraft2_docker_working_dir

# Type: string
minecraft_role_docker_working_dir:

# Type: string
minecraft2_docker_working_dir:

Monitoring & Lifecycle

minecraft_role_docker_auto_removeminecraft2_docker_auto_remove

# Type: bool (true/false)
minecraft_role_docker_auto_remove:

# Type: bool (true/false)
minecraft2_docker_auto_remove:

minecraft_role_docker_cleanupminecraft2_docker_cleanup

# Type: bool (true/false)
minecraft_role_docker_cleanup:

# Type: bool (true/false)
minecraft2_docker_cleanup:

minecraft_role_docker_force_killminecraft2_docker_force_kill

# Type: string
minecraft_role_docker_force_kill:

# Type: string
minecraft2_docker_force_kill:

minecraft_role_docker_healthcheckminecraft2_docker_healthcheck

# Type: dict
minecraft_role_docker_healthcheck:

# Type: dict
minecraft2_docker_healthcheck:

minecraft_role_docker_healthy_wait_timeoutminecraft2_docker_healthy_wait_timeout

# Type: int
minecraft_role_docker_healthy_wait_timeout:

# Type: int
minecraft2_docker_healthy_wait_timeout:

minecraft_role_docker_initminecraft2_docker_init

# Type: bool (true/false)
minecraft_role_docker_init:

# Type: bool (true/false)
minecraft2_docker_init:

minecraft_role_docker_kill_signalminecraft2_docker_kill_signal

# Type: string
minecraft_role_docker_kill_signal:

# Type: string
minecraft2_docker_kill_signal:

minecraft_role_docker_log_driverminecraft2_docker_log_driver

# Type: string
minecraft_role_docker_log_driver:

# Type: string
minecraft2_docker_log_driver:

minecraft_role_docker_log_optionsminecraft2_docker_log_options

# Type: dict
minecraft_role_docker_log_options:

# Type: dict
minecraft2_docker_log_options:

minecraft_role_docker_oom_killerminecraft2_docker_oom_killer

# Type: bool (true/false)
minecraft_role_docker_oom_killer:

# Type: bool (true/false)
minecraft2_docker_oom_killer:

minecraft_role_docker_oom_score_adjminecraft2_docker_oom_score_adj

# Type: int
minecraft_role_docker_oom_score_adj:

# Type: int
minecraft2_docker_oom_score_adj:

minecraft_role_docker_output_logsminecraft2_docker_output_logs

# Type: bool (true/false)
minecraft_role_docker_output_logs:

# Type: bool (true/false)
minecraft2_docker_output_logs:

minecraft_role_docker_pausedminecraft2_docker_paused

# Type: bool (true/false)
minecraft_role_docker_paused:

# Type: bool (true/false)
minecraft2_docker_paused:

minecraft_role_docker_recreateminecraft2_docker_recreate

# Type: bool (true/false)
minecraft_role_docker_recreate:

# Type: bool (true/false)
minecraft2_docker_recreate:

minecraft_role_docker_restart_retriesminecraft2_docker_restart_retries

# Type: int
minecraft_role_docker_restart_retries:

# Type: int
minecraft2_docker_restart_retries:

Other Options

minecraft_role_docker_capabilitiesminecraft2_docker_capabilities

# Type: list
minecraft_role_docker_capabilities:

# Type: list
minecraft2_docker_capabilities:

minecraft_role_docker_cgroup_parentminecraft2_docker_cgroup_parent

# Type: string
minecraft_role_docker_cgroup_parent:

# Type: string
minecraft2_docker_cgroup_parent:

minecraft_role_docker_commandsminecraft2_docker_commands

# Type: list
minecraft_role_docker_commands:

# Type: list
minecraft2_docker_commands:

minecraft_role_docker_create_timeoutminecraft2_docker_create_timeout

# Type: int
minecraft_role_docker_create_timeout:

# Type: int
minecraft2_docker_create_timeout:

minecraft_role_docker_entrypointminecraft2_docker_entrypoint

# Type: string
minecraft_role_docker_entrypoint:

# Type: string
minecraft2_docker_entrypoint:

minecraft_role_docker_env_fileminecraft2_docker_env_file

# Type: string
minecraft_role_docker_env_file:

# Type: string
minecraft2_docker_env_file:

minecraft_role_docker_labelsminecraft2_docker_labels

# Type: dict
minecraft_role_docker_labels:

# Type: dict
minecraft2_docker_labels:

minecraft_role_docker_labels_use_commonminecraft2_docker_labels_use_common

# Type: bool (true/false)
minecraft_role_docker_labels_use_common:

# Type: bool (true/false)
minecraft2_docker_labels_use_common:

minecraft_role_docker_read_onlyminecraft2_docker_read_only

# Type: bool (true/false)
minecraft_role_docker_read_only:

# Type: bool (true/false)
minecraft2_docker_read_only:

minecraft_role_docker_runtimeminecraft2_docker_runtime

# Type: string
minecraft_role_docker_runtime:

# Type: string
minecraft2_docker_runtime:

minecraft_role_docker_sysctlsminecraft2_docker_sysctls

# Type: list
minecraft_role_docker_sysctls:

# Type: list
minecraft2_docker_sysctls:

minecraft_role_docker_ulimitsminecraft2_docker_ulimits

# Type: list
minecraft_role_docker_ulimits:

# Type: list
minecraft2_docker_ulimits:

minecraft_role_autoheal_enabledminecraft2_autoheal_enabled

# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
minecraft_role_autoheal_enabled: true

# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
minecraft2_autoheal_enabled: true

minecraft_role_depends_onminecraft2_depends_on

# List of container dependencies that must be running before containers start
# Type: string
minecraft_role_depends_on: ""

# List of container dependencies that must be running before containers start
# Type: string
minecraft2_depends_on: ""

minecraft_role_depends_on_delayminecraft2_depends_on_delay

# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
minecraft_role_depends_on_delay: "0"

# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
minecraft2_depends_on_delay: "0"

minecraft_role_depends_on_healthchecksminecraft2_depends_on_healthchecks

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

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

minecraft_role_diun_enabledminecraft2_diun_enabled

# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
minecraft_role_diun_enabled: true

# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
minecraft2_diun_enabled: true

minecraft_role_dns_enabledminecraft2_dns_enabled

# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
minecraft_role_dns_enabled: true

# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
minecraft2_dns_enabled: true

minecraft_role_docker_controllerminecraft2_docker_controller

# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
minecraft_role_docker_controller: true

# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
minecraft2_docker_controller: true

minecraft_role_docker_networks_alias_customminecraft2_docker_networks_alias_custom

# Type: list
minecraft_role_docker_networks_alias_custom:

# Type: list
minecraft2_docker_networks_alias_custom:

minecraft_role_docker_volumes_downloadminecraft2_docker_volumes_download

# Type: bool (true/false)
minecraft_role_docker_volumes_download:

# Type: bool (true/false)
minecraft2_docker_volumes_download:

minecraft_role_themepark_addonsminecraft2_themepark_addons

# Type: string
minecraft_role_themepark_addons:

# Type: string
minecraft2_themepark_addons:

minecraft_role_themepark_appminecraft2_themepark_app

# Type: string
minecraft_role_themepark_app:

# Type: string
minecraft2_themepark_app:

minecraft_role_themepark_thememinecraft2_themepark_theme

# Type: string
minecraft_role_themepark_theme:

# Type: string
minecraft2_themepark_theme:

minecraft_role_traefik_api_endpointminecraft2_traefik_api_endpoint

# Type: dict/omit
minecraft_role_traefik_api_endpoint:

# Type: dict/omit
minecraft2_traefik_api_endpoint:

minecraft_role_traefik_api_middlewareminecraft2_traefik_api_middleware

# Type: string
minecraft_role_traefik_api_middleware:

# Type: string
minecraft2_traefik_api_middleware:

minecraft_role_traefik_api_middleware_httpminecraft2_traefik_api_middleware_http

# Type: string
minecraft_role_traefik_api_middleware_http:

# Type: string
minecraft2_traefik_api_middleware_http:

minecraft_role_traefik_autodetect_enabledminecraft2_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
minecraft_role_traefik_autodetect_enabled: false

# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
minecraft2_traefik_autodetect_enabled: false

minecraft_role_traefik_crowdsec_enabledminecraft2_traefik_crowdsec_enabled

# Enable CrowdSec middleware for containers
# Type: bool (true/false)
minecraft_role_traefik_crowdsec_enabled: false

# Enable CrowdSec middleware for containers
# Type: bool (true/false)
minecraft2_traefik_crowdsec_enabled: false

minecraft_role_traefik_error_pages_enabledminecraft2_traefik_error_pages_enabled

# Enable custom error pages middleware for containers
# Type: bool (true/false)
minecraft_role_traefik_error_pages_enabled: false

# Enable custom error pages middleware for containers
# Type: bool (true/false)
minecraft2_traefik_error_pages_enabled: false

minecraft_role_traefik_gzip_enabledminecraft2_traefik_gzip_enabled

# Enable gzip compression middleware for containers
# Type: bool (true/false)
minecraft_role_traefik_gzip_enabled: false

# Enable gzip compression middleware for containers
# Type: bool (true/false)
minecraft2_traefik_gzip_enabled: false

minecraft_role_traefik_middleware_httpminecraft2_traefik_middleware_http

# Type: string
minecraft_role_traefik_middleware_http:

# Type: string
minecraft2_traefik_middleware_http:

minecraft_role_traefik_middleware_http_api_insecureminecraft2_traefik_middleware_http_api_insecure

# Type: bool (true/false)
minecraft_role_traefik_middleware_http_api_insecure:

# Type: bool (true/false)
minecraft2_traefik_middleware_http_api_insecure:

minecraft_role_traefik_middleware_http_insecureminecraft2_traefik_middleware_http_insecure

# Type: bool (true/false)
minecraft_role_traefik_middleware_http_insecure:

# Type: bool (true/false)
minecraft2_traefik_middleware_http_insecure:

minecraft_role_traefik_priorityminecraft2_traefik_priority

# Type: string
minecraft_role_traefik_priority:

# Type: string
minecraft2_traefik_priority:

minecraft_role_traefik_robot_enabledminecraft2_traefik_robot_enabled

# Enable robots.txt middleware for containers
# Type: bool (true/false)
minecraft_role_traefik_robot_enabled: true

# Enable robots.txt middleware for containers
# Type: bool (true/false)
minecraft2_traefik_robot_enabled: true

minecraft_role_traefik_tailscale_enabledminecraft2_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
minecraft_role_traefik_tailscale_enabled: false

# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
minecraft2_traefik_tailscale_enabled: false

minecraft_role_traefik_wildcard_enabledminecraft2_traefik_wildcard_enabled

# Enable wildcard certificate for containers
# Type: bool (true/false)
minecraft_role_traefik_wildcard_enabled: true

# Enable wildcard certificate for containers
# Type: bool (true/false)
minecraft2_traefik_wildcard_enabled: true

minecraft_role_web_api_http_portminecraft2_web_api_http_port

# Type: string (quoted number)
minecraft_role_web_api_http_port:

# Type: string (quoted number)
minecraft2_web_api_http_port:

minecraft_role_web_api_http_schememinecraft2_web_api_http_scheme

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

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

minecraft_role_web_api_http_serverstransportminecraft2_web_api_http_serverstransport

# Type: dict/omit
minecraft_role_web_api_http_serverstransport:

# Type: dict/omit
minecraft2_web_api_http_serverstransport:

minecraft_role_web_api_portminecraft2_web_api_port

# Type: string (quoted number)
minecraft_role_web_api_port:

# Type: string (quoted number)
minecraft2_web_api_port:

minecraft_role_web_api_schememinecraft2_web_api_scheme

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

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

minecraft_role_web_api_serverstransportminecraft2_web_api_serverstransport

# Type: dict/omit
minecraft_role_web_api_serverstransport:

# Type: dict/omit
minecraft2_web_api_serverstransport:

minecraft_role_web_fqdn_overrideminecraft2_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
minecraft_role_web_fqdn_override:

# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
minecraft2_web_fqdn_override:

Example Override

minecraft_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "minecraft2.{{ user.domain }}"
  - "minecraft.otherdomain.tld"

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

Example Override

minecraft2_web_fqdn_override:
  - "{{ traefik_host }}"
  - "minecraft2.{{ user.domain }}"
  - "minecraft.otherdomain.tld"

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

minecraft_role_web_host_overrideminecraft2_web_host_override

# Override the Traefik web host configuration for containers
# Type: string
minecraft_role_web_host_override:

# Override the Traefik web host configuration for containers
# Type: string
minecraft2_web_host_override:

Example Override

minecraft_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'minecraft2.' + user.domain }}`)"

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

Example Override

minecraft2_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'minecraft2.' + user.domain }}`)"

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

minecraft_role_web_http_portminecraft2_web_http_port

# Type: string (quoted number)
minecraft_role_web_http_port:

# Type: string (quoted number)
minecraft2_web_http_port:

minecraft_role_web_http_schememinecraft2_web_http_scheme

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

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

minecraft_role_web_http_serverstransportminecraft2_web_http_serverstransport

# Type: dict/omit
minecraft_role_web_http_serverstransport:

# Type: dict/omit
minecraft2_web_http_serverstransport:

minecraft_role_web_schememinecraft2_web_scheme

# URL scheme to use for web access to containers
# Type: string ("http"/"https")
minecraft_role_web_scheme:

# URL scheme to use for web access to containers
# Type: string ("http"/"https")
minecraft2_web_scheme:

minecraft_role_web_serverstransportminecraft2_web_serverstransport

# Type: dict/omit
minecraft_role_web_serverstransport:

# Type: dict/omit
minecraft2_web_serverstransport: