Palworld Dedicated Server Docker

Chat with the community on Discord

[!TIP] Unsure how to get started? Check out this guide I wrote!

This is a Docker container to help you get started with hosting your own Palworld dedicated server.

This Docker container has been tested and will work on the following OS:

Linux (Ubuntu/Debian)
Windows 10,11
MacOS (including Apple Silicon M1/M2/M3).

This container has also been tested and will work on both x64 and ARM64 based CPU architecture.

[!IMPORTANT] Looking to host a server for Xbox players? Follow this guide here!

Company	About
<!-- markdownlint-disable-line --><a href="https://indifferentbroccoli.com/palworld-server-hosting"><img src="https://github.com/thijsvanloef/palworld-server-docker/assets/58031337/f091b205-d6be-49fe-a508-4a23087023a1" width="150px" alt="Indifferent Broccoli" /></a><p align="center">indifferent broccoli (:\|)</p>	Thank you to our sponsor indifferent broccoli. If you decide to rent a Palworld server, rather than host yourself, try indifferent broccoli's Palword server hosting 2-day free trial

Official Documentation

Server Requirements

Resource	Minimum	Recommended
CPU	4 cores	4+ cores
RAM	16GB	Recommend over 32GB for stable operation
Storage	8GB	20GB

How to use

Keep in mind that you'll need to change the environment variables.

Docker Compose

This repository includes an example docker-compose.yml file you can use to set up your server.

services:
   palworld:
      image: thijsvanloef/palworld-server-docker:latest
      restart: unless-stopped
      container_name: palworld-server
      stop_grace_period: 30s # Set to however long you are willing to wait for the container to gracefully stop
      ports:
        - 8211:8211/udp
        - 27015:27015/udp
        # - 8212:8212/tcp  # Port for REST API if REST_API_ENABLED: true
      environment:
         PUID: 1000
         PGID: 1000
         PORT: 8211 # Optional but recommended
         PLAYERS: 16 # Optional but recommended
         SERVER_PASSWORD: "worldofpals" # Optional but recommended
         MULTITHREADING: true
         RCON_ENABLED: true
         RCON_PORT: 25575
         TZ: "UTC"
         ADMIN_PASSWORD: "adminPasswordHere"
         COMMUNITY: false  # Enable this if you want your server to show up in the community servers tab, USE WITH SERVER_PASSWORD!
         SERVER_NAME: "palworld-server-docker by Thijs van Loef"
         SERVER_DESCRIPTION: "palworld-server-docker by Thijs van Loef"
         ALLOW_CONNECT_PLATFORM: "Steam" # Defaults to "Steam" if not set, set this to "Xbox" if you want to host a server for Xbox players. CROSSPLAY BETWEEN XBOX-STEAM IS NOT YET SUPPORTED
      volumes:
         - ./palworld:/palworld/

As an alternative, you can copy the .env.example file to a new file called .env file. Modify it to your needs, check out the environment variables section to check the correct values. Modify your docker-compose.yml to this:

services:
   palworld:
      image: thijsvanloef/palworld-server-docker:latest
      restart: unless-stopped
      container_name: palworld-server
      stop_grace_period: 30s # Set to however long you are willing to wait for the container to gracefully stop
      ports:
        - 8211:8211/udp
        - 27015:27015/udp
        # - 8212:8212/tcp  # Port for REST API if REST_API_ENABLED: true
      env_file:
         -  .env
      volumes:
         - ./palworld:/palworld/

Docker Run

Change every <> to your own configuration

docker run -d \
    --name palworld-server \
    -p 8211:8211/udp \
    -p 27015:27015/udp \
    -v ./palworld:/palworld/ \
    -e PUID=1000 \
    -e PGID=1000 \
    -e PORT=8211 \
    -e PLAYERS=16 \
    -e MULTITHREADING=true \
    -e RCON_ENABLED=true \
    -e RCON_PORT=25575 \
    -e TZ=UTC \
    -e ADMIN_PASSWORD="adminPasswordHere" \
    -e SERVER_PASSWORD="worldofpals" \
    -e COMMUNITY=false \
    -e SERVER_NAME="palworld-server-docker by Thijs van Loef" \
    -e SERVER_DESCRIPTION="palworld-server-docker by Thijs van Loef" \
    -e ALLOW_CONNECT_PLATFORM="Steam" \
    --restart unless-stopped \
    --stop-timeout 30 \
    thijsvanloef/palworld-server-docker:latest

docker run -d \
    --name palworld-server \
    -p 8211:8211/udp \
    -p 27015:27015/udp \
    -v ./palworld:/palworld/ \
    --env-file .env \
    --restart unless-stopped \
    --stop-timeout 30 \
    thijsvanloef/palworld-server-docker:latest

Kubernetes

All files you will need to deploy this container to kubernetes are located in the k8s folder.

Follow the steps in the README.md here to deploy it.

Running without root

This is only for advanced users

It is possible to run this container and override the default user which is root in this image.

Because you are specifiying the user and group PUID and PGID are ignored.

If you want to find your UID: id -u If you want to find your GID: id -g

You must set user to NUMBERICAL_UID:NUMBERICAL_GID

Below we assume your UID is 1000 and your GID is 1001

In docker run add --user 1000:1001 \ above the last line.
In docker compose add user: 1000:1001 above ports.

If you wish to run it with a different UID/GID than your own you will need to change the ownership of the directory that is being bind: chown UID:GID palworld/ or by changing the permissions for all other: chmod o=rwx palworld/

Using helm chart

The official helm chart can be found in a seperate repository, palworld-server-chart

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 Backups 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 Backups with Cron	0.21.0
AUTO_REBOOT_ENABLED	Enables automatic reboots	false	true/false	0.21.0
AUTO_REBOOT_WARN_MINUTES