Environment Variables

This page provides a reference for all environment variables that can be used to configure your Hytale server container.

Container Options

Configure container runtime behavior and user permissions.

Variable	Default	Description
`UID`	`1000`	User id to run as
`GID`	`1000`	Group id to run as
`TZ`	`UTC`	Timezone
`SKIP_CHOWN_DATA`	`false`	Skip ownership change of data directory

Configure automatic server file downloads and updates.

Variable	Default	Description
`AUTO_DOWNLOAD`	`true`	Auto-download server files
`PATCHLINE`	`release`	Download patchline (release/beta/alpha)
`SKIP_DOWNLOADER_UPDATE`	`false`	Skip downloader updates

Control JVM memory settings and options.

Variable	Default	Description
`MEMORY`	`4G`	JVM heap size
`MIN_MEMORY`	`4G`	JVM initial heap size (-Xms), defaults to MEMORY
`MAX_MEMORY`	`4G`	JVM maximum heap size (-Xmx), defaults to MEMORY
`JVM_OPTS`		Extra JVM options (array format)

Configure server logging behavior.

Variable	Default	Description
`LOG_LEVEL`	`info`	Root logger level (trace, debug, info, warn, error)

Set server ports and network-related options.

Core Hytale server settings.

Variable	Default	Description

Variable	Default	Description
`ASSETS_PATH`	`/data/Assets.zip`	Asset directory
`PREFAB_CACHE`		Prefab cache directory for immutable assets
`WORLD_GEN`		World generation directory
`MODS_PATH`		Additional mods directories

Variable	Default	Description
`UNIVERSE_PATH`	`/data/universe`	Universe data directory

Variable	Default	Description
`AUTH_MODE`	`authenticated`	Authentication mode (authenticated/offline/insecure)
`IDENTITY_TOKEN`		Identity token
`SESSION_TOKEN`		Session token for Session Service API

Variable	Default	Description
`BARE_MODE`	`false`	Run server in bare mode
`SINGLEPLAYER`	`false`	Enable singleplayer mode

Variable	Default	Description
`ALLOW_OP`	`false`	Allow operator permissions

Variable	Default	Description
`ACCEPT_EARLY_PLUGINS`	`false`	Loading early plugins is unsupported and may cause stability issues
`EARLY_PLUGINS`		Early plugin directories

Variable	Default	Description
`BACKUP_ENABLED`	`false`	Enable automatic backups
`BACKUP_DIR`		Backup storage directory
`BACKUP_FREQUENCY`		Backup frequency in minutes
`BACKUP_MAX_COUNT`		Maximum number of backups to keep

Variable	Default	Description
`FORCE_NETWORK_FLUSH`	`true`	Force network flush (true/false)

Variable	Default	Description
`VALIDATE_ASSETS`	`false`	Validate assets on startup
`VALIDATE_PREFABS`		Validate prefabs (ValidationOption)
`VALIDATE_WORLD_GEN`	`false`	Validate world generation
`SHUTDOWN_AFTER_VALIDATE`	`false`	Auto-shutdown after validation
`MIGRATE_WORLDS`		Worlds to migrate

Variable	Default	Description
`BOOT_COMMAND`		Command to run on boot
`GENERATE_SCHEMA`	`false`	Generate schema and exit

Variable	Default	Description
`DISABLE_SENTRY`	`false`	Disable Sentry error reporting
`DISABLE_ASSET_COMPARE`	`false`	Disable asset comparison
`DISABLE_CPB_BUILD`	`false`	Disable compact prefab buffer building
`DISABLE_FILE_WATCHER`	`false`	Disable file watcher
`EVENT_DEBUG`	`false`	Enable event debugging
`OWNER_NAME`		Server owner name
`OWNER_UUID`		Server owner UUID
`CLIENT_PID`		Client process ID

Pass additional custom arguments to the server.

Variable	Default	Description
`EXTRA_ARGS`		Extra arguments to pass to the server