Palworld Dedicated Server Settings
How to change the Palworld Server Settings using Docker Environment variables.
Environment variables
You can use the following values to change the settings of the server on boot. It is highly recommended you set the following environment values before starting the server:
- PLAYERS
- PORT
- PUID
- PGID
| Variable | Info | Default Values | Allowed Values | Added in Version |
|---|---|---|---|---|
| TZ | Timezone used for time stamping backup server | UTC | See TZ Identifiers | 0.1.0 |
| PLAYERS* | Max amount of players that are able to join the server | 16 | 1-32 | 0.1.0 |
| PORT* | UDP port that the server will expose | 8211 | 1024-65535 | 0.1.0 |
| PUID* | The uid of the user the server should run as | 1000 | !0 | 0.6.0 |
| PGID* | The gid of the group the server should run as | 1000 | !0 | 0.6.0 |
| MULTITHREADING** | Improves performance in multi-threaded CPU environments. It is effective up to a maximum of about 4 threads, and allocating more than this number of threads does not make much sense. | false | true/false | 0.1.0 |
| COMMUNITY | Whether or not the server shows up in the community server browser (USE WITH SERVER_PASSWORD) | false | true/false | 0.1.0 |
| PUBLIC_IP | You can manually specify the global IP address of the network on which the server running. If not specified, it will be detected automatically. If it does not work well, try manual configuration. | x.x.x.x | 0.1.0 | |
| PUBLIC_PORT | You can manually specify the port number of the network on which the server running. If not specified, it will be detected automatically. If it does not work well, try manual configuration. | 1024-65535 | 0.1.0 | |
| SERVER_NAME | A name for your server | "string" | 0.1.0 | |
| SERVER_DESCRIPTION | Your server Description | "string" | 0.1.0 | |
| SERVER_PASSWORD | Secure your community server with a password | "string" | 0.1.0 | |
| ADMIN_PASSWORD | Secure administration access in the server with a password | "string" | 0.4.0 | |
| UPDATE_ON_BOOT** | Update/Install the server when the docker container starts (THIS HAS TO BE ENABLED THE FIRST TIME YOU RUN THE CONTAINER) | true | true/false | 0.3.0 |
| RCON_ENABLED*** | Enable RCON for the Palworld server | true | true/false | 0.1.0 |
| RCON_PORT | RCON port to connect to | 25575 | 1024-65535 | 0.1.0 |
| REST_API_ENABLED | Enable REST API for the palworld server | false | true/false | 0.35.0 |
| REST_API_PORT | REST API port to connect to | 8212 | 1024-65535 | 0.35.0 |
| QUERY_PORT | Query port used to communicate with Steam servers | 27015 | 1024-65535 | 0.1.0 |
| ALLOW_CONNECT_PLATFORM | Specify if you are hosting a dedicated server for Steam or Xbox players | Steam | Steam/Xbox | 0.38.0 |
| BACKUP_CRON_EXPRESSION | Setting affects frequency of automatic backups. | 0 0 * * * | Needs a Cron-Expression - See Configuring Automatic Backups with Cron | 0.19.0 |
| BACKUP_ENABLED | Enables automatic backups | true | true/false | 0.19.0 |
| USE_BACKUP_SAVE_DATA | Enables native automatic backups | true | true/false | 0.35.0 |
| DELETE_OLD_BACKUPS | Delete backups after a certain number of days | false | true/false | 0.19.0 |
| OLD_BACKUP_DAYS | How many days to keep backups | 30 | any positive integer | 0.19.0 |
| AUTO_UPDATE_CRON_EXPRESSION | Setting affects frequency of automatic updates. | 0 * * * * | Needs a Cron-Expression - See Configuring Automatic Updates with Cron | 0.20.0 |
| AUTO_UPDATE_ENABLED | Enables automatic updates | false | true/false | 0.20.0 |
| AUTO_UPDATE_WARN_MINUTES | How long to wait to update the server, after the player were informed. (This will be ignored, if no Players are connected) | 30 | Integer | 0.20.0 |
| AUTO_REBOOT_CRON_EXPRESSION | Setting affects frequency of automatic updates. | 0 0 * * * | Needs a Cron-Expression - See Configuring Automatic Reboots with Cron | 0.21.0 |
| AUTO_REBOOT_ENABLED | Enables automatic reboots | false | true/false | 0.21.0 |
| AUTO_REBOOT_WARN_MINUTES | How long to wait to reboot the server, after the player were informed. | 5 | Integer | 0.21.0 |
| AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE | Restart the Server even if there are players online. | false | true/false | 0.21.0 |
| TARGET_MANIFEST_ID | Locks game version to corespond with Manfiest ID from Steam Download Depot. | See Manifest ID Table | 0.27.0 | |
| STEAM_USERNAME | Steam username for downloading the server files (only needed when using TARGET_MANIFEST_ID). | "string" | 1.2.2 | |
| STEAM_PASSWORD | Steam password for downloading the server files (only needed when using TARGET_MANIFEST_ID). | "string" | 1.2.2 | |
| INSTALL_BETA_INSIDER | Installs the latest Beta version of the Palworld dedicated server | false | true/false | 0.38.0 |
| DISCORD_WEBHOOK_URL | Discord webhook url found after creating a webhook on a discord server | https://discord.com/api/webhooks/<webhook_id> | 0.22.0 | |
| DISCORD_SUPPRESS_NOTIFICATIONS | Enables/Disables @silent messages for the server messages. | false | boolean | 0.34.0 |
| DISCORD_CONNECT_TIMEOUT | Discord command initial connection timeout | 30 | !0 | 0.22.0 |
| DISCORD_MAX_TIMEOUT | Discord total hook timeout | 30 | !0 | 0.22.0 |
| DISCORD_PRE_UPDATE_BOOT_MESSAGE | Discord message sent when server begins updating | Server is updating... | "string" | 0.31.0 |
| DISCORD_PRE_UPDATE_BOOT_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 |
| DISCORD_PRE_UPDATE_BOOT_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | "string" | 0.31.0 | |
| DISCORD_POST_UPDATE_BOOT_MESSAGE | Discord message sent when server completes updating | Server update complete! | "string" | 0.31.0 |
| DISCORD_POST_UPDATE_BOOT_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 |
| DISCORD_POST_UPDATE_BOOT_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | "string" | 0.31.0 | |
| DISCORD_PRE_START_MESSAGE | Discord message sent when server begins to start | Server has been started! | "string" | 0.31.0 |
| DISCORD_PRE_START_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 |
| DISCORD_PRE_START_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | "string" | 0.31.0 | |
| DISCORD_PRE_SHUTDOWN_MESSAGE | Discord message sent when server begins to shutdown | Server is shutting down... | "string" | 0.31.0 |
| DISCORD_PRE_SHUTDOWN_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 |
| DISCORD_PRE_SHUTDOWN_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | "string" | 0.31.0 | |
| DISCORD_POST_SHUTDOWN_MESSAGE | Discord message sent when server has stopped | Server is stopped! | "string" | 0.31.0 |
| DISCORD_POST_SHUTDOWN_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 |
| DISCORD_POST_SHUTDOWN_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | "string" | 0.31.0 | |
| DISCORD_PLAYER_JOIN_MESSAGE | Discord message sent when player joins the server | player_name has joined Palworld! | "string" | 0.31.0 |
| DISCORD_PLAYER_JOIN_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 |
| DISCORD_PLAYER_JOIN_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | "string" | 0.31.0 | |
| DISCORD_PLAYER_LEAVE_MESSAGE | Discord message sent when player leaves the server | player_name has left Palworld. | "string" | 0.31.0 |
| DISCORD_PLAYER_LEAVE_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 |
| DISCORD_PLAYER_LEAVE_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | "string" | 0.31.0 | |
| DISCORD_PRE_BACKUP_MESSAGE | Discord message when starting to create a backup | Creating backup... | "string" | 0.31.0 |
| DISCORD_PRE_BACKUP_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 |
| DISCORD_PRE_BACKUP_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | "string" | 0.31.0 | |
| DISCORD_POST_BACKUP_MESSAGE | Discord message when a backup has been made | Backup created at file_path | "string" | 0.31.0 |
| DISCORD_POST_BACKUP_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 |
| DISCORD_POST_BACKUP_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | "string" | 0.31.0 | |
| DISCORD_PRE_BACKUP_DELETE_MESSAGE | Discord message when starting to remove older backups | Removing backups older than old_backup_days days | "string" | 0.31.0 |
| DISCORD_PRE_BACKUP_DELETE_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 |
| DISCORD_PRE_BACKUP_DELETE_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | "string" | 0.31.0 | |
| DISCORD_POST_BACKUP_DELETE_MESSAGE | Discord message when successfully removed older backups | Removed backups older than old_backup_days days | "string" | 0.31.0 |
| DISCORD_POST_BACKUP_DELETE_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 |
| DISCORD_POST_BACKUP_DELETE_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | "string" | 0.31.0 | |
| DISCORD_ERR_BACKUP_DELETE_MESSAGE | Discord message when there has been an error removing older backups | Unable to delete old backups, OLD_BACKUP_DAYS is not an integer. OLD_BACKUP_DAYS=old_backup_days | "string" | 0.31.0 |
| DISCORD_ERR_BACKUP_DELETE_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 |
| DISCORD_ERR_BACKUP_DELETE_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | "string" | 0.31.0 | |
| DISABLE_GENERATE_SETTINGS | Whether to automatically generate the PalWorldSettings.ini | false | true/false | 0.24.0 |
| DISABLE_GENERATE_ENGINE | Whether to automatically generate the Engine.ini | true | true/false | 0.30.0 |
| ENABLE_PLAYER_LOGGING | Enables Logging and announcing when players join and leave | true | true/false | 0.31.0 |
| PLAYER_LOGGING_POLL_PERIOD | Polling period (in seconds) to check for players who have joined or left | 5 | !0 | 0.31.0 |
| USE_DEPOT_DOWNLOADER | Uses DepotDownloader to download game server files instead of steamcmd. This will help hosts incompatible with steamcmd (e.g. M-series Mac) | false | true/false | 0.39.0 |
*highly recommended to set
** Make sure you know what you are doing when running this option enabled
*** Required for docker stop to save and gracefully close the server
ARM64-exclusive environment variables
ARM64 hosts can use the following variables to tweak their server setup. This includes known relevant Box64 configurations one can modify for better server stability/performance.
For the Box64 configurations, please see the their official documentation for more info.
tip
Set ARM64_DEVICE to the most appropriate setting for your device. generic is expected
to work on all devices but better stability can be found with specifying your device.
For more specific device compatibility, create an issue on the
base image repo.
| Variable | Info | Default Values | Allowed Values | Added in Version |
|---|---|---|---|---|
| BOX64_DYNAREC_STRONGMEM | [Box64 config] Enable/Disable simulation of Strong Memory model | 1 | 0, 1, 2, 3 | 0.23.0 |
| BOX64_DYNAREC_BIGBLOCK | [Box64 config] Enables/Disables Box64's Dynarec building BigBlock. | 1 | 0, 1, 2, 3 | 0.23.0 |
| BOX64_DYNAREC_SAFEFLAGS | [Box64 config] Handling of flags on CALL/RET opcodes | 1 | 0, 1, 2 | 0.23.0 |
| BOX64_DYNAREC_FASTROUND | [Box64 config] Enable/Disable generation of precise x86 rounding | 1 | 0, 1 | 0.23.0 |
| BOX64_DYNAREC_FASTNAN | [Box64 config] Enable/Disable generation of -NAN | 1 | 0, 1 | 0.23.0 |
| BOX64_DYNAREC_X87DOUBLE | [Box64 config] Force the use of Double for x87 emulation | 0 | 0, 1 | 0.23.0 |
| ARM64_DEVICE | Specify Box64 build to be used based on host device. This setting is only applicable for ARM64 hosts. | generic | generic, m1, rpi5, adlink | 0.39.0 |
Game Ports
The server needs the following ports by default.
| Port | Info |
|---|---|
| 8211 | Game Port (UDP) |
| 8212 | REST API Port (TCP) |
| 27015 | Query Port (UDP) |
| 25575 | RCON Port (TCP) |