description:Configure Network and Services for Container
- name:Storage and Persistence
description:Persist and Share Data that is Separate from the Container
- name:Ingress
description:Ingress Configuration
- name:Security and Permissions
description:Configure Security Context and Permissions
- name:Resources and Devices
description:"Specify Resources/Devices to be Allocated to Workload"
- name:Middlewares
description:Traefik Middlewares
- name:Metrics
description:Metrics
- name:VPN
description:VPN
- name:Addons
description:Addon Configuration
- name:Advanced
description:Advanced Configuration
- name:Documentation
description:Documentation
portals:{}
questions:
- variable:global
label:Global Settings
group:"General Settings"
schema:
type:dict
hidden:true
attrs:
- variable:isSCALE
label:Flag this is SCALE
schema:
type:boolean
default:true
hidden:true
- variable:imageSelector
group:Container Image
label:Select Image
schema:
type:string
default:image
enum:
- value:image
description:Java 17 HotSpot
- value:j11Image
description:Java 11 HotSpot
- value:j11j9Image
description:Java 11 OpenJ9
- value:j8Image
description:Java 8 HotSpot
- value:j8j9Image
description:Java 8 OpenJ9
- variable:controller
group:"General Settings"
label:""
schema:
additional_attrs:true
type:dict
attrs:
- variable:replicas
description:Number of desired pod replicas
label:Desired Replicas
schema:
type:int
required:true
default:1
- variable:customextraargs
group:"General Settings"
label:"Extra Args"
description:"Do not click this unless you know what you are doing"
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:extraArgs
label:Extra Args
schema:
type:list
default:[]
items:
- variable:arg
label:Arg
schema:
type:string
- variable:secretEnv
group:App Configuration
label:Image Secrets
schema:
additional_attrs:true
type:dict
attrs:
- variable:RCON_PASSWORD
label:RCON_PASSWORD
description:This will only have effect in the first installation or always if OVERRIDE_SERVER_PROPERTIES is enabled
schema:
type:string
private:true
default:""
- variable:env
group:App Configuration
label:Image Environment
schema:
additional_attrs:true
type:dict
attrs:
- variable:EULA
label:Minecraft Eula - Link in readme sources
schema:
type:boolean
required:true
default:false
- variable:OVERRIDE_SERVER_PROPERTIES
label:Override Server Properties
description:Enable this so RCON_PASSWORD will always have effect.
schema:
type:boolean
default:false
- variable:VERSION
label:Minecraft Version - LATEST, SNAPSHOT, or verison
schema:
type:string
required:true
default:LATEST
- variable:TYPE
label:Server Type
schema:
type:string
required:true
default:VANILLA
enum:
- value:VANILLA
description:Vanilla
- value:FORGE
description:Forge
- value:FABRIC
description:Fabric
- value:SPIGOT
description:Spigot
- value:BUKKIT
description:Bukkit
- value:PAPER
description:Paper
- value:AIRPLANE
description:Airplane
- value:PURPUR
description:Purpur
- value:MAGMA
description:Magma
- value:MOHIST
description:Mohist
- value:CATSERVER
description:Catserver
- value:CANYON
description:Canyon
- value:SPONGEVANILLA
description:Sponge Vanilla
- value:LIMBO
description:Limbo
- value:CRUCIBLE
description:Crucible
- value:FTBA
description:FTBA
- value:CURSEFORGE
description:Curseforge
- value:QUILT
description:Quilt
- value:PUFFERFISH
description:Pufferfish
- value:CUSTOM
description:Custom
- variable:CUSTOM_SERVER
label:Custom Server
description:URL or a container path to an existing JAR file, will ONLY download once.
schema:
type:string
default:""
show_if:[[TYPE, "=", "CUSTOM"]]
- variable:QUILT_LOADER_VERSION
label:Quilt loader version
schema:
type:string
default:"0.16.0"
show_if:[[TYPE, "=", "QUILT"]]
- variable:QUILT_INSTALLER_VERSION
label:Quilt installer version
schema:
type:string
default:"0.4.1"
show_if:[[TYPE, "=", "QUILT"]]
- variable:QUILT_LAUNCHER
label:Quilt launcher
description:Path to a custom launcher jar available to the container relative to /data.
schema:
type:string
default:""
show_if:[[TYPE, "=", "QUILT"]]
- variable:QUILT_LAUNCHER_URL
label:Quilt launcher url
description:URL to a custom launcher jar
schema:
type:string
default:""
show_if:[[TYPE, "=", "QUILT"]]
- variable:PUFFERFISH_BUILD
label:Pufferfish build
description:"To set the actual SERVER VERSION number set the value as 'build xx' for example xx is 50. set the 'Version' variable as a single branch instead like 'latest' or '1.18' or '1.17'"
schema:
type:string
default:lastSuccessfulBuild
show_if:[[TYPE, "=", "PUFFERFISH"]]
- variable:FORGEVERSION
label:Forge Version
schema:
type:string
default:""
show_if:[[TYPE, "=", "FORGE"]]
- variable:FORGE_INSTALLER
label:Forge Installer
schema:
type:string
default:""
show_if:[[TYPE, "=", "FORGE"]]
- variable:FORGE_INSTALLER_URL
label:Forge Installer URL
schema:
type:string
default:""
show_if:[[TYPE, "=", "FORGE"]]
- variable:FABRIC_LOADER_VERSION
label:Fabric Loader Version
schema:
type:string
default:""
show_if:[[TYPE, "=", "FABRIC"]]
- variable:FABRIC_INSTALLER
label:Fabric Installer
schema:
type:string
default:""
show_if:[[TYPE, "=", "FABRIC"]]
- variable:FABRIC_INSTALLER_URL
label:Fabric Installer URL
schema:
type:string
default:""
show_if:[[TYPE, "=", "FABRIC"]]
- variable:SPIGOT_DOWNLOAD_URL
label:Spigot Download URL
schema:
type:string
default:""
show_if:[[TYPE, "=", "SPIGOT"]]
- variable:BUILD_FROM_SOURCE
label:Build Spigot from Source?
schema:
type:boolean
default:false
show_if:[[TYPE, "=", "SPIGOT"]]
- variable:BUKKIT_DOWNLOAD_URL
label:Bukkit Download URL
schema:
type:string
default:""
show_if:[[TYPE, "=", "BUKKIT"]]
- variable:PAPERBUILD
label:Paper Build Number
schema:
type:string
default:""
show_if:[[TYPE, "=", "PAPER"]]
- variable:PAPER_DOWNLOAD_URL
label:Paper Download URL
schema:
type:string
default:""
show_if:[[TYPE, "=", "PAPER"]]
- variable:PACKWIZ_URL
label:Packwiz URL
schema:
type:string
default:""
show_if:[[TYPE, "=", "PAPER"]]
- variable:AIRPLANE_BUILD
label:Airplane Build
schema:
type:string
default:lastSuccessfulBuild
show_if:[[TYPE, "=", "AIRPLANE"]]
- variable:MAGMA_CHANNEL
label:Magma Channel
schema:
type:string
default:stable
show_if:[[TYPE, "=", "MAGMA"]]
- variable:MOHIST_BUILD
label:Mohist Build
schema:
type:string
default:""
show_if:[[TYPE, "=", "MOHIST"]]
- variable:CANYON_BUILD
label:Canyon Build
schema:
type:string
default:""
show_if:[[TYPE, "=", "CANYON"]]
- variable:SPONGEBRANCH
label:Sponge Branch
schema:
type:string
default:STABLE
show_if:[[TYPE, "=", "SPONGEVANILLA"]]
- variable:SPONGEVERSION
label:Sponge Version
schema:
type:string
default:""
show_if:[[TYPE, "=", "SPONGEVANILLA"]]
- variable:LIMBO_BUILD
label:Limbo Build
schema:
type:string
default:LATEST
show_if:[[TYPE, "=", "LIMBO"]]
- variable:LIMBO_SCHEMA_FILENAME
label:Limbo Schema Filename
schema:
type:string
default:default.schem
show_if:[[TYPE, "=", "LIMBO"]]
- variable:CRUCIBLE_RELEASE
label:Crucible Release
schema:
type:string
default:latest
show_if:[[TYPE, "=", "CRUCIBLE"]]
- variable:FTB_MODPACK_ID
label:FTB Modpack ID
schema:
type:string
default:""
show_if:[[TYPE, "=", "FTBA"]]
- variable:FTB_MODPACK_VERSION_ID
label:FTB Modpack Version ID
schema:
type:string
default:""
show_if:[[TYPE, "=", "FTBA"]]
- variable:CF_SERVER_MOD
label:CF Server Mod
schema:
type:string
default:""
show_if:[[TYPE, "=", "CURSEFORGE"]]
- variable:CF_BASE_DIR
label:CF Base Dir
schema:
type:string
default:""
show_if:[[TYPE, "=", "CURSEFORGE"]]
- variable:USE_MODPACK_START_SCRIPT
label:Use Modpack Start Script
schema:
type:boolean
default:true
show_if:[[TYPE, "=", "CURSEFORGE"]]
- variable:FTB_LEGACYJAVAFIXER
label:Fix for <unable to launch forgemodloader>
schema:
type:boolean
default:false
show_if:[[TYPE, "=", "CURSEFORGE"]]
- variable:DIFFICULTY
label:Difficulty
schema:
type:string
required:true
default:easy
enum:
- value:peaceful
description:Peaceful
- value:easy
description:Easy
- value:normal
description:Normal
- value:hard
description:Hard
- variable:WHITELIST
label:Whitelist
schema:
type:string
default:""
- variable:OPS
label:OPs
schema:
type:string
default:""
- variable:ICON
label:URL to Server Icon
schema:
type:string
default:""
- variable:MAX_PLAYERS
label:Max Connected Players
schema:
type:int
required:true
default:20
- variable:MAX_WORLD_SIZE
label:World Border Radius in blocks
schema:
type:int
required:true
default:10000
- variable:ALLOW_NETHER
label:Enable/Disable Nether
schema:
type:boolean
default:true
- variable:ANNOUNCE_PLAYER_ACHIEVEMENTS
label:Enable/Disable Announceing Player Achievements
schema:
type:boolean
default:true
- variable:ENABLE_COMMAND_BLOCK
label:Enable/Disable Command Blocks
schema:
type:boolean
default:false
- variable:FORCE_GAMEMODE
label:Enable/Disable Force Gamemode
schema:
type:boolean
default:false
- variable:GENERATE_STRUCTURES
label:Enable/Disable Generate Structures
schema:
type:boolean
default:true
- variable:HARDCORE
label:Enable/Disable Hardcore Mode
schema:
type:boolean
default:false
- variable:MAX_BUILD_HEIGHT
label:Max World Build Height
schema:
type:int
required:true
default:256
- variable:MAX_TICK_TIME
label:Max Tick Time
schema:
type:int
required:true
default:60000
- variable:SPAWN_ANIMALS
label:Enable/Disable Spawning Animals
schema:
type:boolean
default:true
- variable:SPAWN_MONSTERS
label:Enable/Disable Spawning Monsters
schema:
type:boolean
default:true
- variable:SPAWN_NPCS
label:Enable/Disable Spawning NPCs
schema:
type:boolean
default:true
- variable:VIEW_DISTANCE
label:Server View Distance
schema:
type:int
required:true
default:10
- variable:SEED
label:Level Seed
schema:
type:string
default:""
- variable:MODE
label:Default Gamemode
schema:
type:string
required:true
default:survival
enum:
- value:survival
description:Survival
- value:creative
description:Creative
- value:adventure
description:Adventure
- value:spectator
description:Spectator
- variable:MOTD
label:Server Message of the Day
schema:
type:string
default:Welcome to Minecraft on TrueNAS Scale!
- variable:PVP
label:Enable/Disable PVP
schema:
type:boolean
default:false
- variable:LEVEL_TYPE
label:Level Type
schema:
type:string
required:true
default:DEFAULT
- variable:GENERATOR_SETTINGS
label:Generator Settings
schema:
type:string
default:""
- variable:LEVEL
label:World Save Name
schema:
type:string
required:true
default:world
- variable:WORLD
label:URL of world download
schema:
type:string
default:""
- variable:FORCE_REDOWNLOAD
label:Force redownload server files
description:Force re-download of the server file for VANILLA, FORGE, BUKKIT, SPIGOT, PAPER, CURSEFORGE, SPONGEVANILLA server types.
schema:
type:string
default:"false"
enum:
- value:"false"
description:"False"
- value:"true"
description:"True"
- variable:ONLINE_MODE
label:Enable/Disable Online Mode
schema:
type:boolean
default:true
- variable:advanced
label:Show Advanced Server Settings
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:MEMORY
label:Server Memory
schema:
type:string
required:true
default:2048M
- variable:JVM_OPTS
label:JVM Options
schema:
type:string
default:""
- variable:USE_FLARE_FLAGS
label:Enable to add appropriate flags for the Flare profiler
description:"Only select server types can use these flags. please checkout the upstream project for more info -> https://github.com/itzg/docker-minecraft-server#enable-flare-flags"
schema:
type:boolean
default:false
- variable:JVM_XX_OPTS
label:JVM -X Options
schema:
type:string
default:""
- variable:TZ
label:Timezone
group:"General Settings"
schema:
type:string
default:"Etc/UTC"
$ref:
- "definitions/timezone"
- variable:envList
label:Extra Environment Variables
description:"Please be aware that some variables are set in the background, adding duplicates here might cause issues or prevent the app from starting..."
group:"General Settings"
schema:
type:list
default:[]
items:
- variable:envItem
label:Environment Variable
schema:
additional_attrs:true
type:dict
attrs:
- variable:name
label:Name
schema:
type:string
- variable:value
label:Value
schema:
type:string
- variable:service
group:Networking and Services
label:Configure Service(s)
schema:
additional_attrs:true
type:dict
attrs:
- variable:main
label:Main Service
description:The Primary service on which the healthcheck runs, often the webUI
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enable the Service
schema:
type:boolean
default:true
hidden:true
- variable:type
label:Service Type
description:"ClusterIP's are only internally available and Loadbalancer exposes the service using the system loadbalancer"
schema:
type:string
default:LoadBalancer
enum:
- value:LoadBalancer
description:LoadBalancer (Expose Ports)
- value:ClusterIP
description:ClusterIP (Do Not Expose Ports)
- value:Simple
description:Deprecated CHANGE THIS
- variable:loadBalancerIP
label:LoadBalancer IP
description:"MetalLB Only: Selects the Loadbalancer IP to expose on. Required when using PortalButton with MetalLB"
schema:
show_if:[["type","=","LoadBalancer"]]
type:string
default:""
- variable:ports
label:"Service's Port(s) Configuration"
schema:
additional_attrs:true
type:dict
attrs:
- variable:main
label:Main Service Port Configuration
schema:
additional_attrs:true
type:dict
attrs:
- variable:port
label:Port
description:This port exposes the container port on the service
schema:
type:int
default:25565
required:true
- variable:rcon
label:RCON Service
description:The Primary service on which the healthcheck runs, often the webUI
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enable the Service
schema:
type:boolean
default:true
hidden:true
- variable:type
label:Service Type
description:"ClusterIP's are only internally available and Loadbalancer exposes the service using the system loadbalancer"
schema:
type:string
default:LoadBalancer
enum:
- value:LoadBalancer
description:LoadBalancer (Expose Ports)
- value:ClusterIP
description:ClusterIP (Do Not Expose Ports)
- value:Simple
description:Deprecated CHANGE THIS
- variable:loadBalancerIP
label:LoadBalancer IP
description:"MetalLB Only: Selects the Loadbalancer IP to expose on. Required when using PortalButton with MetalLB"
schema:
show_if:[["type","=","LoadBalancer"]]
type:string
default:""
- variable:ports
label:"Service's Port(s) Configuration"
schema:
additional_attrs:true
type:dict
attrs:
- variable:rcon
label:RCON Service Port Configuration
schema:
additional_attrs:true
type:dict
attrs:
- variable:port
label:Port
description:This port exposes the container port on the service
schema:
type:int
default:25575
required:true
- variable:serviceexpert
group:Networking and Services
label:Show Expert Config
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:hostNetwork
group:Networking and Services
label:Host-Networking (Complicated)
schema:
type:boolean
default:false
- variable:externalInterfaces
description:Add External Interfaces
label:Add external Interfaces
group:Networking
schema:
type:list
items:
- variable:interfaceConfiguration
description:Interface Configuration
label:Interface Configuration
schema:
type:dict
$ref:
- "normalize/interfaceConfiguration"
attrs:
- variable:hostInterface
description:Please Specify Host Interface
label:Host Interface
schema:
type:string
required:true
$ref:
- "definitions/interface"
- variable:ipam
description:Define how IP Address will be managed
label:IP Address Management
schema:
type:dict
required:true
attrs:
- variable:type
description:Specify type for IPAM
label:IPAM Type
schema:
type:string
required:true
enum:
- value:dhcp
description:Use DHCP
- value:static
description:Use Static IP
show_subquestions_if:static
subquestions:
- variable:staticIPConfigurations
label:Static IP Addresses
schema:
type:list
items:
- variable:staticIP
label:Static IP
schema:
type:ipaddr
cidr:true
- variable:staticRoutes
label:Static Routes
schema:
type:list
items:
- variable:staticRouteConfiguration
label:Static Route Configuration
schema:
additional_attrs:true
type:dict
attrs:
- variable:destination
label:Destination
schema:
type:ipaddr
cidr:true
required:true
- variable:gateway
label:Gateway
schema:
type:ipaddr
cidr:false
required:true
- variable:serviceList
label:Add Manual Custom Services
group:Networking and Services
schema:
type:list
default:[]
items:
- variable:serviceListEntry
label:Custom Service
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enable the service
schema:
type:boolean
default:true
hidden:true
- variable:name
label:Name
schema:
type:string
default:""
- variable:type
label:Service Type
description:"ClusterIP's are only internally available and Loadbalancer exposes the service using the system loadbalancer"
schema:
type:string
default:LoadBalancer
enum:
- value:LoadBalancer
description:LoadBalancer (Expose Ports)
- value:ClusterIP
description:ClusterIP (Do Not Expose Ports)
- value:Simple
description:Deprecated CHANGE THIS
- variable:loadBalancerIP
label:LoadBalancer IP
description:"MetalLB Only: Selects the Loadbalancer IP to expose on. Required when using PortalButton with MetalLB"
schema:
show_if:[["type","=","LoadBalancer"]]
type:string
default:""
- variable:advancedsvcset
label:Show Advanced Service Settings
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:externalIPs
label:"External IP's"
description:"External IP's"
schema:
type:list
default:[]
items:
- variable:externalIP
label:External IP
schema:
type:string
- variable:ipFamilyPolicy
label:IP Family Policy
description:Specify the IP Policy
schema:
type:string
default:SingleStack
enum:
- value:SingleStack
description:SingleStack
- value:PreferDualStack
description:PreferDualStack
- value:RequireDualStack
description:RequireDualStack
- variable:ipFamilies
label:IP Families
description:(Advanced) The IP Families that should be used
schema:
type:list
default:[]
items:
- variable:ipFamily
label:IP Family
schema:
type:string
- variable:portsList
label:Additional Service Ports
schema:
type:list
default:[]
items:
- variable:portsListEntry
label:Custom ports
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enable the Port
schema:
type:boolean
default:true
hidden:true
- variable:name
label:Port Name
schema:
type:string
default:""
- variable:protocol
label:Port Type
schema:
type:string
default:TCP
enum:
- value:HTTP
description:HTTP
- value:HTTPS
description:HTTPS
- value:TCP
description:TCP
- value:UDP
description:UDP
- variable:targetPort
label:Target Port
description:This port exposes the container port on the service
schema:
type:int
required:true
- variable:port
label:Container Port
schema:
type:int
required:true
- variable:persistence
label:Integrated Persistent Storage
description:Integrated Persistent Storage
group:Storage and Persistence
schema:
additional_attrs:true
type:dict
attrs:
- variable:data
label:App Data Storage
description:Stores the Application Configuration.
schema:
additional_attrs:true
type:dict
attrs:
- variable:type
label:Type of Storage
description:Sets the persistence type, Anything other than PVC could break rollback!
schema:
type:string
default:pvc
enum:
- value:pvc
description:PVC
- value:hostPath
description:Host Path
- value:emptyDir
description:emptyDir
- value:nfs
description:NFS Share
- variable:server
label:NFS Server
schema:
show_if:[["type","=","nfs"]]
type:string
default:""
- variable:path
label:Path on NFS Server
schema:
show_if:[["type","=","nfs"]]
type:string
default:""
- variable:setPermissions
label:Automatic Permissions
description:Automatically set permissions on install
schema:
show_if:[["type","=","hostPath"]]
type:boolean
default:false
- variable:readOnly
label:Read Only
schema:
type:boolean
default:false
- variable:hostPath
label:Host Path
description:Path inside the container the storage is mounted
schema:
show_if:[["type","=","hostPath"]]
type:hostpath
- variable:medium
label:EmptyDir Medium
schema:
show_if:[["type","=","emptyDir"]]
type:string
default:""
enum:
- value:""
description:Default
- value:Memory
description:Memory
- variable:size
label:Size quotum of Storage (Do NOT REDUCE after installation)
description:This value can ONLY be INCREASED after the installation
schema:
show_if:[["type","=","pvc"]]
type:string
default:256Gi
- variable:persistenceList
label:Additional App Storage
group:Storage and Persistence
schema:
type:list
default:[]
items:
- variable:persistenceListEntry
label:Custom Storage
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enable the storage
schema:
type:boolean
default:true
hidden:true
- variable:type
label:Type of Storage
description:Sets the persistence type, Anything other than PVC could break rollback!
schema:
type:string
default:hostPath
enum:
- value:pvc
description:PVC
- value:hostPath
description:Host Path
- value:emptyDir
description:emptyDir
- value:nfs
description:NFS Share
- variable:server
label:NFS Server
schema:
show_if:[["type","=","nfs"]]
type:string
default:""
- variable:path
label:Path on NFS Server
schema:
show_if:[["type","=","nfs"]]
type:string
default:""
- variable:setPermissions
label:Automatic Permissions
description:Automatically set permissions on install
schema:
show_if:[["type","=","hostPath"]]
type:boolean
default:false
- variable:readOnly
label:Read Only
schema:
type:boolean
default:false
- variable:hostPath
label:Host Path
description:Path inside the container the storage is mounted
schema:
show_if:[["type","=","hostPath"]]
type:hostpath
- variable:mountPath
label:Mount Path
description:Path inside the container the storage is mounted