mirror of
https://github.com/truenas/charts.git
synced 2026-04-13 10:39:46 +08:00
c479033fc9
* palworld - allow additional config * bump version * test actual keys * dont print passwords * handle bools * lint * handle bools * only create dirs if not exist * bypass bools on sh * handle weird cases with quoting
603 lines
22 KiB
YAML
603 lines
22 KiB
YAML
groups:
|
|
- name: Palworld Configuration
|
|
description: Configure Palworld
|
|
- name: User and Group Configuration
|
|
description: Configure User and Group for Palworld
|
|
- name: Network Configuration
|
|
description: Configure Network for Palworld
|
|
- name: Storage Configuration
|
|
description: Configure Storage for Palworld
|
|
- name: Resources Configuration
|
|
description: Configure Resources for Palworld
|
|
|
|
questions:
|
|
- variable: palworldConfig
|
|
label: ""
|
|
group: Palworld Configuration
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: adminPassword
|
|
label: Admin Password
|
|
description: Your server admin password
|
|
schema:
|
|
type: string
|
|
private: true
|
|
required: true
|
|
default: ""
|
|
- variable: server
|
|
label: Server Configuration
|
|
description: Configure the server for Palworld
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Server Name
|
|
description: Your server name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: "TrueNAS Palworld Server"
|
|
- variable: description
|
|
label: Server Description
|
|
description: Your server description
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: "Palworld Server running on TrueNAS"
|
|
- variable: password
|
|
label: Server Password
|
|
description: |
|
|
Your server password, leave blank for no password
|
|
schema:
|
|
type: string
|
|
private: true
|
|
default: ""
|
|
- variable: iniKeys
|
|
label: Configure INI Keys
|
|
description: |
|
|
Enter your INI keys </br>
|
|
Updates the keys in PalWorldSettings.ini
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: iniKey
|
|
label: INI Key
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: key
|
|
label: Key
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
required: true
|
|
- variable: value
|
|
label: Value
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: backup
|
|
label: Backup
|
|
description: Configure the backup for Palworld
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: Enabled
|
|
description: Enable the backup for Palworld
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: interval
|
|
label: Interval
|
|
description: Interval in minutes to backup the server
|
|
schema:
|
|
type: int
|
|
show_if: [["enabled", "=", true]]
|
|
default: 120
|
|
required: true
|
|
min: 15
|
|
- variable: keep
|
|
label: Keep
|
|
description: How many backups to keep
|
|
schema:
|
|
type: int
|
|
show_if: [["enabled", "=", true]]
|
|
default: 3
|
|
required: true
|
|
min: 1
|
|
- variable: gameParams
|
|
label: Game Parameters
|
|
description: |
|
|
Enter your game parameters </br>
|
|
Format: EpicApp=PalServer
|
|
schema:
|
|
type: list
|
|
default:
|
|
- EpicApp=PalServer
|
|
items:
|
|
- variable: gameParam
|
|
label: Game Parameter
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: gameParamsExtra
|
|
label: Extra Game Parameters
|
|
description: |
|
|
Enter your extra game parameters </br>
|
|
Format: -NoAsyncLoadingThread
|
|
schema:
|
|
type: list
|
|
default:
|
|
- -useperfthreads
|
|
- -NoAsyncLoadingThread
|
|
- -UseMultithreadForDS
|
|
items:
|
|
- variable: gameParamExtra
|
|
label: Extra Game Parameter
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: updatePublicIP
|
|
label: Update Public IP
|
|
description: |
|
|
If enabled the container will check on each container
|
|
start if the Public IP is still valid.
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: validate
|
|
label: Validate
|
|
description: If enabled the container validates the game data
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: username
|
|
label: Username
|
|
description: Leave blank for anonymous login
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: password
|
|
label: Password
|
|
description: Leave blank for anonymous login
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
show_if: [["username", "!=", ""]]
|
|
private: true
|
|
- variable: additionalEnvs
|
|
label: Additional Environment Variables
|
|
description: Configure additional environment variables for Palworld.
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: env
|
|
label: Environment Variable
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: value
|
|
label: Value
|
|
schema:
|
|
type: string
|
|
required: true
|
|
|
|
- variable: palworldID
|
|
label: ""
|
|
group: User and Group Configuration
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: user
|
|
label: User ID
|
|
description: The user id that Palworld files will be owned by.
|
|
schema:
|
|
type: int
|
|
min: 568
|
|
default: 568
|
|
required: true
|
|
- variable: group
|
|
label: Group ID
|
|
description: The group id that Palworld files will be owned by.
|
|
schema:
|
|
type: int
|
|
min: 568
|
|
default: 568
|
|
required: true
|
|
|
|
- variable: palworldNetwork
|
|
label: ""
|
|
group: Network Configuration
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: serverPort
|
|
label: Server Port
|
|
description: The UDP port for the Palworld Server.
|
|
schema:
|
|
type: int
|
|
default: 38211
|
|
min: 9000
|
|
max: 65535
|
|
required: true
|
|
- variable: rconPort
|
|
label: RCON Port
|
|
description: The TCP port for the Palworld RCON.
|
|
schema:
|
|
type: int
|
|
default: 38212
|
|
min: 9000
|
|
max: 65535
|
|
required: true
|
|
- variable: hostNetwork
|
|
label: Host Network
|
|
description: |
|
|
Bind to the host network. It might be needed for the UDP server port to work.
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
|
|
- variable: palworldStorage
|
|
label: ""
|
|
group: Storage Configuration
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: steamcmd
|
|
label: Palworld SteamCMD Storage
|
|
description: The path to store Palworld SteamCMD.
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: type
|
|
label: Type
|
|
description: |
|
|
ixVolume: Is dataset created automatically by the system.</br>
|
|
Host Path: Is a path that already exists on the system.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
immutable: true
|
|
default: "ixVolume"
|
|
enum:
|
|
- value: "hostPath"
|
|
description: Host Path (Path that already exists on the system)
|
|
- value: "ixVolume"
|
|
description: ixVolume (Dataset created automatically by the system)
|
|
- variable: ixVolumeConfig
|
|
label: ixVolume Configuration
|
|
description: The configuration for the ixVolume dataset.
|
|
schema:
|
|
type: dict
|
|
show_if: [["type", "=", "ixVolume"]]
|
|
$ref:
|
|
- "normalize/ixVolume"
|
|
attrs:
|
|
- variable: aclEnable
|
|
label: Enable ACL
|
|
description: Enable ACL for the dataset.
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: datasetName
|
|
label: Dataset Name
|
|
description: The name of the dataset to use for storage.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
immutable: true
|
|
hidden: true
|
|
default: "steamcmd"
|
|
- variable: aclEntries
|
|
label: ACL Configuration
|
|
schema:
|
|
type: dict
|
|
show_if: [["aclEnable", "=", true]]
|
|
attrs: []
|
|
- variable: hostPathConfig
|
|
label: Host Path Configuration
|
|
schema:
|
|
type: dict
|
|
show_if: [["type", "=", "hostPath"]]
|
|
attrs:
|
|
- variable: aclEnable
|
|
label: Enable ACL
|
|
description: Enable ACL for the dataset.
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: acl
|
|
label: ACL Configuration
|
|
schema:
|
|
type: dict
|
|
show_if: [["aclEnable", "=", true]]
|
|
attrs: []
|
|
$ref:
|
|
- "normalize/acl"
|
|
- variable: hostPath
|
|
label: Host Path
|
|
description: The host path to use for storage.
|
|
schema:
|
|
type: hostpath
|
|
show_if: [["aclEnable", "=", false]]
|
|
required: true
|
|
|
|
- variable: server
|
|
label: Palworld Server Storage
|
|
description: The path to store Palworld Server.
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: type
|
|
label: Type
|
|
description: |
|
|
ixVolume: Is dataset created automatically by the system.</br>
|
|
Host Path: Is a path that already exists on the system.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
immutable: true
|
|
default: "ixVolume"
|
|
enum:
|
|
- value: "hostPath"
|
|
description: Host Path (Path that already exists on the system)
|
|
- value: "ixVolume"
|
|
description: ixVolume (Dataset created automatically by the system)
|
|
- variable: readOnly
|
|
label: Read Only
|
|
description: Mount the volume as read only.
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: ixVolumeConfig
|
|
label: ixVolume Configuration
|
|
description: The configuration for the ixVolume dataset.
|
|
schema:
|
|
type: dict
|
|
show_if: [["type", "=", "ixVolume"]]
|
|
$ref:
|
|
- "normalize/ixVolume"
|
|
attrs:
|
|
- variable: aclEnable
|
|
label: Enable ACL
|
|
description: Enable ACL for the dataset.
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: datasetName
|
|
label: Dataset Name
|
|
description: The name of the dataset to use for storage.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
immutable: true
|
|
hidden: true
|
|
default: "server"
|
|
- variable: aclEntries
|
|
label: ACL Configuration
|
|
schema:
|
|
type: dict
|
|
show_if: [["aclEnable", "=", true]]
|
|
attrs: []
|
|
- variable: hostPathConfig
|
|
label: Host Path Configuration
|
|
schema:
|
|
type: dict
|
|
show_if: [["type", "=", "hostPath"]]
|
|
attrs:
|
|
- variable: aclEnable
|
|
label: Enable ACL
|
|
description: Enable ACL for the dataset.
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: acl
|
|
label: ACL Configuration
|
|
schema:
|
|
type: dict
|
|
show_if: [["aclEnable", "=", true]]
|
|
attrs: []
|
|
$ref:
|
|
- "normalize/acl"
|
|
- variable: hostPath
|
|
label: Host Path
|
|
description: The host path to use for storage.
|
|
schema:
|
|
type: hostpath
|
|
show_if: [["aclEnable", "=", false]]
|
|
required: true
|
|
|
|
- variable: additionalStorages
|
|
label: Additional Storage
|
|
description: Additional storage for Palworld.
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: storageEntry
|
|
label: Storage Entry
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: type
|
|
label: Type
|
|
description: |
|
|
ixVolume: Is dataset created automatically by the system.</br>
|
|
Host Path: Is a path that already exists on the system.</br>
|
|
SMB Share: Is a SMB share that is mounted to a persistent volume claim.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: "ixVolume"
|
|
immutable: true
|
|
enum:
|
|
- value: "hostPath"
|
|
description: Host Path (Path that already exists on the system)
|
|
- value: "ixVolume"
|
|
description: ixVolume (Dataset created automatically by the system)
|
|
- value: "smb-pv-pvc"
|
|
description: SMB Share (Mounts a persistent volume claim to a SMB share)
|
|
- variable: readOnly
|
|
label: Read Only
|
|
description: Mount the volume as read only.
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: mountPath
|
|
label: Mount Path
|
|
description: The path inside the container to mount the storage.
|
|
schema:
|
|
type: path
|
|
required: true
|
|
- variable: hostPathConfig
|
|
label: Host Path Configuration
|
|
schema:
|
|
type: dict
|
|
show_if: [["type", "=", "hostPath"]]
|
|
attrs:
|
|
- variable: aclEnable
|
|
label: Enable ACL
|
|
description: Enable ACL for the dataset.
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: acl
|
|
label: ACL Configuration
|
|
schema:
|
|
type: dict
|
|
show_if: [["aclEnable", "=", true]]
|
|
attrs: []
|
|
$ref:
|
|
- "normalize/acl"
|
|
- variable: hostPath
|
|
label: Host Path
|
|
description: The host path to use for storage.
|
|
schema:
|
|
type: hostpath
|
|
show_if: [["aclEnable", "=", false]]
|
|
required: true
|
|
- variable: ixVolumeConfig
|
|
label: ixVolume Configuration
|
|
description: The configuration for the ixVolume dataset.
|
|
schema:
|
|
type: dict
|
|
show_if: [["type", "=", "ixVolume"]]
|
|
$ref:
|
|
- "normalize/ixVolume"
|
|
attrs:
|
|
- variable: aclEnable
|
|
label: Enable ACL
|
|
description: Enable ACL for the dataset.
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: datasetName
|
|
label: Dataset Name
|
|
description: The name of the dataset to use for storage.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
immutable: true
|
|
default: "storage_entry"
|
|
- variable: aclEntries
|
|
label: ACL Configuration
|
|
schema:
|
|
type: dict
|
|
show_if: [["aclEnable", "=", true]]
|
|
attrs: []
|
|
- variable: smbConfig
|
|
label: SMB Share Configuration
|
|
description: The configuration for the SMB Share.
|
|
schema:
|
|
type: dict
|
|
show_if: [["type", "=", "smb-pv-pvc"]]
|
|
attrs:
|
|
- variable: server
|
|
label: Server
|
|
description: The server for the SMB share.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: share
|
|
label: Share
|
|
description: The share name for the SMB share.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: domain
|
|
label: Domain (Optional)
|
|
description: The domain for the SMB share.
|
|
schema:
|
|
type: string
|
|
- variable: username
|
|
label: Username
|
|
description: The username for the SMB share.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: password
|
|
label: Password
|
|
description: The password for the SMB share.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
private: true
|
|
- variable: size
|
|
label: Size (in Gi)
|
|
description: The size of the volume quota.
|
|
schema:
|
|
type: int
|
|
required: true
|
|
min: 1
|
|
default: 1
|
|
|
|
- variable: resources
|
|
group: Resources Configuration
|
|
label: ""
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: limits
|
|
label: Limits
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: cpu
|
|
label: CPU
|
|
description: CPU limit for Palworld.
|
|
schema:
|
|
type: string
|
|
max_length: 6
|
|
valid_chars: '^(0\.[1-9]|[1-9][0-9]*)(\.[0-9]|m?)$'
|
|
valid_chars_error: |
|
|
Valid CPU limit formats are</br>
|
|
- Plain Integer - eg. 1</br>
|
|
- Float - eg. 0.5</br>
|
|
- Milicpu - eg. 500m
|
|
default: "4000m"
|
|
required: true
|
|
- variable: memory
|
|
label: Memory
|
|
description: Memory limit for Palworld.
|
|
schema:
|
|
type: string
|
|
max_length: 12
|
|
valid_chars: '^[1-9][0-9]*([EPTGMK]i?|e[0-9]+)?$'
|
|
valid_chars_error: |
|
|
Valid Memory limit formats are</br>
|
|
- Suffixed with E/P/T/G/M/K - eg. 1G</br>
|
|
- Suffixed with Ei/Pi/Ti/Gi/Mi/Ki - eg. 1Gi</br>
|
|
- Plain Integer in bytes - eg. 1024</br>
|
|
- Exponent - eg. 134e6
|
|
default: "8Gi"
|
|
required: true
|