2022-02-04 16:57:41 -05:00
# Include{groups}
2022-10-22 18:09:48 -04:00
portals : {}
2022-02-04 16:57:41 -05:00
questions :
# Include{global}
2023-03-01 02:55:51 -05:00
# Include{workload}
# Include{workloadDeployment}
# Include{replicas1}
# Include{podSpec}
# Include{containerMain}
2023-04-19 19:19:46 -04:00
- variable : imageSelector
label : Select Image
schema :
type : string
default : image
enum :
- value : image
2023-11-24 14:05:53 -05:00
description : Java 17 Hotspot
- value : j21Image
description : Java 21 Hotspot
- value : j21graalvmImage
description : Java 21 Graalvm
- value : j21alpineImage
description : Java 21 Alpine
2023-04-19 19:19:46 -04:00
- value : j17j9Image
description : Java 17 OpenJ9
- value : j17jdkImage
description : Java 17 JDK
2023-11-24 14:05:53 -05:00
- value : j17graalvmImage
description : Java 17 Graalvm
2023-04-19 19:19:46 -04:00
- value : j17alpineImage
2023-06-20 17:17:35 -04:00
description : Java 17 Alpine
2023-04-19 19:19:46 -04:00
- value : j11jdkImage
description : Java 11 JDK
- value : j11Image
2023-11-24 14:05:53 -05:00
description : Java 11 Hotspot
2023-04-19 19:19:46 -04:00
- value : j11j9Image
description : Java 11 OpenJ9
- value : j8Image
description : Java 8 HotSpot
2023-11-24 14:05:53 -05:00
- value : j8graalvmImage
2023-04-19 19:19:46 -04:00
description : Java 8 GraalVM CE
- value : j8jdkImage
description : Java 8 JDK
- value : j8j9Image
description : Java 8 OpenJ9
2023-04-14 12:11:04 -04:00
- variable : env
label : Image Environment
schema :
additional_attrs : true
type : dict
attrs :
- variable : RCON_PASSWORD
2023-12-20 07:02:35 -05:00
label : Rcon Password
2023-04-14 12:11:04 -04:00
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 : EULA
label : Minecraft Eula
schema :
type : boolean
required : true
default : false
- variable : OVERRIDE_SERVER_PROPERTIES
label : Override Server Properties
description : Enable this to automatically manage the server.properties in the GUI.
schema :
type : boolean
default : false
- variable : VERSION
label : Minecraft Version
description : Set the Minecraft Version - LATEST, SNAPSHOT, or specific version.
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
2023-11-27 16:51:31 -05:00
- value : NEOFORGE
description : NeoForge
2023-04-14 12:11:04 -04:00
- 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
2023-06-01 17:07:16 -04:00
- value : AUTO_CURSEFORGE
description : Auto CurseForge
2023-04-14 12:11:04 -04:00
- value : QUILT
description : Quilt
- value : PUFFERFISH
description : Pufferfish
- value : CUSTOM
description : Custom
2024-01-27 06:48:42 -05:00
- variable : PACKWIZ_URL
label : Packwiz URL
schema :
type : string
default : ""
show_if : [ [ TYPE, "!=", "VANILLA"]]
2023-04-14 12:11:04 -04:00
- 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"]]
2023-11-27 16:51:31 -05:00
- variable : NEOFORGE_VERSION
label : NeoForge Version
schema :
type : string
default : "47.1.79"
show_if : [ [ TYPE, "=", "NEOFORGE"]]
2023-04-14 12:11:04 -04:00
- 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 : 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"]]
2023-06-01 17:07:16 -04:00
- variable : CF_API_KEY
label : CF API Key
schema :
type : string
default : ""
show_if : [ [ TYPE, "=", "AUTO_CURSEFORGE"]]
- variable : CF_PAGE_URL
label : CF modpack page URL
schema :
type : string
default : ""
show_if : [ [ TYPE, "=", "AUTO_CURSEFORGE"]]
- variable : CF_SLUG
label : CF modpack slug
schema :
type : string
default : ""
show_if : [ [ TYPE, "=", "AUTO_CURSEFORGE"]]
- variable : modpack_exclusions
label : Configure modpack exclusions
schema :
type : boolean
default : false
show_if : [ [ TYPE, "=", "AUTO_CURSEFORGE"]]
show_subquestions_if : true
subquestions :
- variable : CF_EXCLUDE_INCLUDE_FILE
label : JSON file path
schema :
type : string
- variable : CF_EXCLUDE_MODS
label : List of project slugs or IDs to exclude
description : "Comma or space delimited list"
schema :
type : string
default : ""
- variable : CF_FORCE_INCLUDE_MODS
label : List of project slugs or IDs to force include
description : "Comma or space delimited list"
schema :
type : string
default : ""
- variable : CF_FORCE_SYNCHRONIZE
label : Check to ensure the exclude/includes are re-evaluated
schema :
type : boolean
default : false
- variable : advanced_auto_curseforge
label : Advanced Auto CurseForge configurations
schema :
type : boolean
default : false
show_if : [ [ TYPE, "=", "AUTO_CURSEFORGE"]]
show_subquestions_if : true
subquestions :
- variable : CF_OVERRIDES_SKIP_EXISTING
label : Skip files in the overrides that already exist in the data directory
schema :
type : boolean
default : false
- variable : CF_PARALLEL_DOWNLOADS
label : How many parallel mod downloads to perform
schema :
type : int
default : 4
- variable : CF_SET_LEVEL_FROM
label : Saves directory
description : "Some modpacks come with world/save data via a worlds file and/or the overrides provided with the modpack. Either approach can be selected to set the LEVEL to the resulting saves directory."
schema :
type : string
default : ""
enum :
- value : ""
description : Default
- value : WORLD_FILE
description : World File
- value : OVERRIDES
description : Overrides
2023-04-14 12:11:04 -04:00
- 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 Nether
schema :
type : boolean
default : true
- variable : ANNOUNCE_PLAYER_ACHIEVEMENTS
label : Enable Announcing Player Achievements
schema :
type : boolean
default : true
- variable : ENABLE_COMMAND_BLOCK
label : Enable Command Blocks
schema :
type : boolean
default : false
- variable : FORCE_GAMEMODE
label : Enable Force Game Mode
schema :
type : boolean
default : false
- variable : GENERATE_STRUCTURES
label : Enable Generate Structures
schema :
type : boolean
default : true
- variable : HARDCORE
label : Enable Hardcore Mode
description : If set to true, players will be set to spectator mode if they die.
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 Spawning Animals
schema :
type : boolean
default : true
- variable : SPAWN_MONSTERS
label : Enable Spawning Monsters
schema :
type : boolean
default : true
- variable : SPAWN_NPCS
label : Enable 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 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 Online Mode
schema :
type : boolean
default : true
- variable : USE_FLARE_FLAGS
label : Use Flare Flags
description : Enable to add appropriate flags for the Flare profiler on selected server types - https://github.com/itzg/docker-minecraft-server#enable-flare-flags
schema :
type : boolean
default : false
- variable : USE_AIKAR_FLAGS
label : Use Aikar Flags
description : Optimal JVM flags for GC tuning.
schema :
type : boolean
default : true
- variable : USE_SIMD_FLAGS
label : Use SIMD Flags
description : Enable support for optimized SIMD operations.
schema :
type : boolean
default : false
- 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 : JVM_XX_OPTS
label : JVM -X Options
schema :
type : string
default : ""
2023-03-01 02:55:51 -05:00
# Include{containerBasic}
# Include{containerAdvanced}
2023-12-20 07:02:35 -05:00
- variable : mcbackup
group : App Configuration
label : MC Backup Configuration
schema :
additional_attrs : true
type : dict
attrs :
- variable : enabled
label : Enable MC Backup Container
schema :
type : boolean
default : false
show_subquestions_if : true
subquestions :
- variable : initial_delay
label : Initial Delay
schema :
type : string
default : 2m
- variable : backup_interval
label : Backup Interval
schema :
type : string
2024-01-14 17:53:13 -05:00
default : 24h
2023-12-20 07:02:35 -05:00
- variable : player_online_check_interval
label : Player Online Check Interval
schema :
type : string
default : 5m
- variable : prune_backups_days
label : Prune Backups Days
schema :
type : int
default : 7
- variable : pause_if_no_players
label : Pause If No Players
schema :
type : boolean
default : false
- variable : link_latest
label : Link Latest
description : Creates a symbolic link to the latest backup.
schema :
type : boolean
default : false
- variable : tar_compress_method
label : Tar Compress Method
schema :
type : string
default : gzip
enum :
- value : gzip
description : Gzip
- value : bzip2
description : Bzip2
- value : zstd
description : Zstd
- variable : zstd_params
label : ZSTD Params
schema :
type : list
empty : false
default :
- --long=25
- --single-thread
required : true
items :
- variable : param
label : Param
schema :
type : string
required : true
default : ""
- variable : excludes
label : Excludes
schema :
type : list
empty : false
default :
- "*.jar"
- "cache"
- "logs"
- "*.tmp"
required : true
items :
- variable : exclude
label : Exclude
schema :
type : string
required : true
default : ""
2022-02-04 16:57:41 -05:00
# Include{containerConfig}
2023-05-22 03:02:18 -04:00
# Include{podOptions}
2022-08-08 17:25:02 -04:00
# Include{serviceRoot}
2022-02-04 16:57:41 -05:00
- variable : main
2022-10-22 18:09:48 -04:00
label : Main Service
2023-02-03 18:39:18 -05:00
description : The Primary service on which the Minecraft Server runs on
2022-02-04 16:57:41 -05:00
schema :
additional_attrs : true
type : dict
attrs :
2022-09-17 07:24:06 -04:00
# Include{serviceSelectorLoadBalancer}
2022-09-14 17:27:12 -04:00
# Include{serviceSelectorExtras}
2022-02-04 16:57:41 -05:00
- variable : main
2022-10-22 18:09:48 -04:00
label : Main Service Port Configuration
2022-02-04 16:57:41 -05:00
schema :
additional_attrs : true
type : dict
attrs :
- variable : port
2022-10-22 18:09:48 -04:00
label : Port
description : This port exposes the container port on the service
2022-02-04 16:57:41 -05:00
schema :
type : int
default : 25565
required : true
2023-06-20 17:17:35 -04:00
- variable : query
label : Query 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
2022-03-23 00:13:05 -04:00
- variable : rcon
2022-10-22 18:09:48 -04:00
label : RCON Service
2023-02-03 18:39:18 -05:00
description : The RCON service.
2022-03-23 00:13:05 -04:00
schema :
additional_attrs : true
type : dict
attrs :
2022-09-17 07:24:06 -04:00
# Include{serviceSelectorLoadBalancer}
2022-09-14 17:27:12 -04:00
# Include{serviceSelectorExtras}
2022-03-23 00:13:05 -04:00
- variable : rcon
2022-10-22 18:09:48 -04:00
label : RCON Service Port Configuration
2022-03-23 00:13:05 -04:00
schema :
additional_attrs : true
type : dict
attrs :
- variable : port
2022-10-22 18:09:48 -04:00
label : Port
description : This port exposes the container port on the service
2022-03-23 00:13:05 -04:00
schema :
type : int
default : 25575
required : true
2024-04-22 08:11:52 -04:00
# Include{externalInterfaces}
2022-02-04 16:57:41 -05:00
# Include{serviceList}
2022-08-08 17:25:02 -04:00
# Include{persistenceRoot}
2022-02-04 16:57:41 -05:00
- variable : data
2022-10-22 18:09:48 -04:00
label : App Data Storage
2023-02-03 18:39:18 -05:00
description : Stores the Application Data.
2022-02-04 16:57:41 -05:00
schema :
additional_attrs : true
type : dict
attrs :
2023-12-20 07:02:35 -05:00
# Include{persistenceBasic}
- variable : backups
label : App Backups Storage
description : Stores the Application Backups.
schema :
additional_attrs : true
type : dict
attrs :
2022-02-04 16:57:41 -05:00
# Include{persistenceBasic}
# Include{persistenceList}
2023-04-14 12:11:04 -04:00
# Include{securityContextRoot}
- variable : runAsUser
label : "runAsUser"
description : "The UserID of the user running the application"
schema :
type : int
2023-06-20 17:17:35 -04:00
default : 568
2023-04-14 12:11:04 -04:00
- variable : runAsGroup
label : "runAsGroup"
description : "The groupID of the user running the application"
schema :
type : int
2023-06-20 17:17:35 -04:00
default : 568
2023-03-01 03:30:36 -05:00
# Include{securityContextContainer}
# Include{securityContextAdvanced}
# Include{securityContextPod}
2023-04-14 12:11:04 -04:00
- variable : fsGroup
label : "fsGroup"
description : "The group that should own ALL storage."
schema :
type : int
default : 568
2022-02-04 16:57:41 -05:00
# Include{resources}
# Include{advanced}
# Include{addons}
2022-10-01 17:39:52 -04:00
# Include{codeserver}
2023-03-01 03:30:36 -05:00
# Include{netshoot}
2022-10-01 17:39:52 -04:00
# Include{vpn}
2022-08-12 07:15:27 -04:00
# Include{documentation}
