All apps · 0 apps
Palworld-Wine-Server
Docker app from Malclir's Repository
Overview
Readme
View on GitHubPalworld Wine Server — Unraid template
Community-maintained Unraid Community Applications template for ripps818/docker-palworld-dedicated-server-wine.
The template references the upstream image unchanged:
ghcr.io/ripps818/docker-palworld-dedicated-server-wine:latest
It does not rebuild the image or bundle custom scripts, Palworld files, saves, UE4SS, or gameplay mods.
What the template adds
- searchable installation from Unraid Community Applications
- persistent
/palworldappdata and optional Steam session-cache mappings - correct UDP game, TCP REST API, and upstream query-port mappings
- Unraid-native
PUID=99andPGID=100defaults - clear distinction between the player join password and admin/API password
- documented REST API, backup, Workshop, Steam Guard, and UE4SS settings
- safe defaults that leave deprecated RCON disabled
- a dedicated issue tracker for Unraid-template support
Initial installation
- Install the app from Unraid Community Applications.
- Set Admin / REST API Password.
- Set an optional Server Join Password.
- Confirm the game and REST API host ports are available.
- Apply the template and watch the container log during its first installation.
- Forward only the UDP game port (
8211by default)
The initial Wine/SteamCMD setup downloads the Windows Palworld dedicated server into the persistent appdata directory and can take several minutes.
Important settings
Admin password versus server password
ADMIN_PASSWORDauthenticates Palworld administration and REST API requests.SERVER_PASSWORDis the password players enter when joining.
They should not be the same password.
REST API
The image's player detection, safe backup announcements, update announcements,
and management commands use the Palworld REST API. The template enables it and
maps TCP port 8212 by default.
Do not forward the REST API port on your router. Treat it as a LAN management
interface protected by ADMIN_PASSWORD.
Server settings mode
auto: environment variables in the Unraid template control server settings.manual: most game-setting environment variables are ignored; editPalWorldSettings.iniyourself.
Changing the file while SERVER_SETTINGS_MODE=auto will not make that file the
source of truth.
Steam Workshop authentication
Palworld Workshop content requires a Steam account that owns the game. The
template provides an optional persistent Steam cache at
/home/steam/Steam.
Authenticate once from the Unraid terminal:
docker exec -it --user steam Palworld-Wine-Server steamcmd
At the Steam> prompt:
login your-steam-account-name your-steam-password steam-guard-code
quit
Note: The Steam Guard code can be gotten on the app -> Steam Guard -> cog wheel -> Generate Guard Code
Store the username in the template if needed, but leave STEAM_PASSWORD unset so
subsequent starts reuse the cached session instead of repeatedly triggering Steam Guard.
Mods and UE4SS
WORKSHOP_MOD_IDS accepts comma-separated Workshop IDs. Experimental UE4SS can
be enabled separately with INSTALL_UE4SS_EXPERIMENTAL=true.
No mods are included by this repository or enabled by default.
Support boundary
- Image, Wine runtime, Palworld installation, and container tooling: upstream project
- Unraid XML fields, paths, defaults, and CA presentation: template issues
Validation
bash scripts/validate.sh
The repository and template are MIT licensed. The referenced upstream image is separately distributed under its own MIT license.
Install Palworld-Wine-Server on Unraid in a few clicks.
Find Palworld-Wine-Server in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.
Requirements
Categories
Related apps
Explore more like this
Explore allDetails
ghcr.io/ripps818/docker-palworld-dedicated-server-wine:latestRuntime arguments
- Network
bridge- Shell
bash- Privileged
- false
Template configuration
Public Palworld gameplay port. Forward this UDP port through your router for Internet players.
- Target
- 8211
- Default
- 8211
Palworld REST API used by container management, player detection, and safe announcements. Do not router-forward this port.
- Target
- 8212
- Default
- 8212
Upstream Steam query port mapping.
- Target
- 27015
- Default
- 27015
Persistent Palworld installation, configuration, saves, backups, and mods.
- Target
- /palworld
- Default
- /mnt/user/appdata/palworld-wine-server
Persists the Steam Guard login token used for authenticated Workshop downloads.
- Target
- /home/steam/Steam
- Default
- /mnt/user/appdata/palworld-wine-server/steam-cache
Unraid user ID used for files in appdata.
- Default
- 99
Unraid users group ID used for files in appdata.
- Default
- 100
IANA timezone used for logs, backups, and scheduled jobs.
- Target
- TZ
- Default
- Etc/UTC
Name shown to players.
- Target
- SERVER_NAME
- Default
- Palworld Wine Server
Optional password players enter when joining. Do not reuse the admin password.
- Target
- SERVER_PASSWORD
Required private password for Palworld administration and REST API Basic Auth. Use a strong unique value.
- Target
- ADMIN_PASSWORD
Maximum concurrent players. Increase only when the host has sufficient CPU and memory.
- Target
- MAX_PLAYERS
- Default
- 16
Set true to advertise the server in Palworld's community server list.
- Target
- COMMUNITY_SERVER
- Default
- false
Platforms allowed to connect.
- Target
- CROSSPLAY_PLATFORMS
- Default
- (Steam,Xbox,PS5,Mac)
auto: template environment variables control settings. manual: edit PalWorldSettings.ini and most game-setting variables are ignored.
- Target
- SERVER_SETTINGS_MODE
- Default
- auto
Required by current container management, player detection, safe backup announcements, and restapicli.
- Target
- RESTAPI_ENABLED
- Default
- true
Must match the REST API container port mapping.
- Target
- RESTAPI_PORT
- Default
- 8212
Deprecated by current container tooling. Leave false unless using an external legacy RCON client.
- Target
- RCON_ENABLED
- Default
- false
Enables the upstream multithreaded dedicated-server launch options.
- Target
- MULTITHREAD_ENABLED
- Default
- true
Creates server backups in the persistent /palworld directory.
- Target
- BACKUP_ENABLED
- Default
- true
Supercronic expression. The default creates one backup every hour.
- Target
- BACKUP_CRON_EXPRESSION
- Default
- 0 * * * *
Automatically removes old backups beyond the configured count.
- Target
- BACKUP_RETENTION_POLICY
- Default
- true
Number of server backups retained when retention is enabled.
- Target
- BACKUP_RETENTION_AMOUNT_TO_KEEP
- Default
- 72
Logs joins and leaves and supports webhooks. Requires the REST API.
- Target
- PLAYER_DETECTION_ENABLED
- Default
- true
Checks and installs Palworld Dedicated Server updates whenever the container starts.
- Target
- ALWAYS_UPDATE_ON_START
- Default
- true
Validates game files on startup. Validation can overwrite direct modifications to upstream game files.
- Target
- STEAMCMD_VALIDATE_FILES
- Default
- true
Periodically checks for game updates and can restart after an announced countdown.
- Target
- AUTO_UPDATE_ENABLED
- Default
- false
Optional comma-separated Steam Workshop Published File IDs.
- Target
- WORKSHOP_MOD_IDS
Supercronic expression for Workshop update checks; default is every six hours.
- Target
- WORKSHOP_MOD_UPDATE_CRON
- Default
- 0 */6 * * *
Optional Steam username for paid Workshop content. Authenticate interactively once and use the persistent Steam cache; do not store STEAM_PASSWORD here.
- Target
- STEAM_USERNAME
Downloads and deploys the upstream Palworld-specific experimental UE4SS framework for compatible server mods.
- Target
- INSTALL_UE4SS_EXPERIMENTAL
- Default
- false
Allows clients using supported client-side mods to connect.
- Target
- ALLOW_CLIENT_MOD
- Default
- true