Docker - Palworld Dedicated Server
This Docker image includes a Palworld Dedicated Server based on Linux and Docker.
Heads-up — RCON has been removed. This image no longer uses RCON for any container tooling. All server management (player detection, backups, restarts, CLI) now runs via the Palworld REST API.
RCON_ENABLED now defaults to false — this only controls the game server INI setting, not container functionality.- Make sure
RESTAPI_ENABLED=true is set in your default.env.
- See the Changelog for the full migration guide and renamed environment variables.
Public Service Announcement — Custom Script Feature
After many community requests, this image now supports running a custom script before the server starts.
This feature is entirely opt-in and is controlled by the CUSTOM_SCRIPT_ENABLED environment variable, which defaults to false.
This image will never ship with a custom script of any kind.
If you come across a Docker image that appears to be this one but includes a bundled custom script, please be careful — it is not this image and I have no affiliation with it.
This feature was added at the request of the community. While I am glad to offer the option, I will not be providing support for it, and I refuse to accept any liability for any harm, data loss, corruption, or security issues that may result from its use. Please use it at your own discretion. — Public Service Announcement.
Table of Contents
How to ask for support for this Docker image
If you need support for this Docker image:
- Feel free to create a new issue.
- You can reference other issues if you’re experiencing a similar problem via #issue-number.
- Follow the instructions and answer the questions of people who are willing to help you.
- Once your issue is resolved, please close it and please consider giving this repo and the Docker-Hub repository a star.
- Please note that any issue that has been inactive for a week will be closed due to inactivity.
Please avoid:
- Reusing or necroing issues. This can lead to spam and may harass participants who didn’t agree to be part of your new problem.
- If this happens, we reserve the right to lock the issue or delete the comments, you have been warned!
Requirements
To run this Docker image, you need a basic understanding of Docker, Docker-Compose, Linux, and Networking (Port-Forwarding/NAT).
Minimum system requirements
| Resource |
1-8 players |
8-12+ players |
| CPU |
4 CPU-Cores @ High GHz |
6-8 CPU Cores @ High GHz |
| RAM |
8GB RAM Base + 2GB per player |
12GB RAM Base + 2GB per player |
| Storage |
30GB |
30GB+ |
Changelog
You can find the changelog here
Credits / Shoutout / Contributions
This 2 persons helped a lot along to way and made me and this project better! So if you do not like my version of the Docker image or looking for other features, feel free to check out the following 2 images:
Getting started
- Create a
game sub-directory on your Docker-Node in your game-server-directory
- (Examples:
/srv/palworld, /opt/palworld or /home/username/palworld)
- This directory will be used to store the game server files, including configs and savegames
- In older versions we asked you to setup permissions via CHMOD or CHOWN, this should not be needed anymore!
- Set up Port-Forwarding or NAT for the ports in the Docker-Compose file
- Pull the latest version of the image with
docker pull jammsen/palworld-dedicated-server:latest
- Download the compose.yml and default.env
- Set up the
compose.yml and default.env to your liking
- Make sure you setup PUID and PGID according to the user you want to use
- PUID and PGID 0 will error out, thats on purpose!
- if you use Docker as root, then you can just use 1000 inside the container
- Refer to the Environment-Variables section for more information
- Start the container via
docker-compose up -d && docker-compose logs -f
- Watch the log, if no errors occur you can close the logs with ctrl+c
- Now have fun and happy gaming! 🎮😉
Environment variables
See this file for the documentation
Docker-Compose examples
Gameserver with REST API
services:
palworld-dedicated-server:
container_name: palworld-dedicated-server
image: jammsen/palworld-dedicated-server:latest
restart: unless-stopped
logging:
driver: "local"
options:
max-size: "10m"
max-file: "3"
ports:
- target: 8211 # Gamerserver port inside of the container
published: 8211 # Gamerserver port on your host
protocol: udp
mode: host
- target: 8212 # Gameserver REST API port inside of the container
published: 8212 # Gameserver REST API port on your host
protocol: tcp
mode: host
env_file:
- ./default.env
volumes:
- ./game:/palworld
Run REST API commands
You can use docker exec palworld-dedicated-server restapicli <command> right on your terminal/shell.
$ docker exec palworld-dedicated-server restapicli players
> Players: {"players": [...]}
$ docker exec palworld-dedicated-server restapicli info
> Server info: {"version": "v0.7.3.90464", "servername": "...", ...}
$ docker exec palworld-dedicated-server restapicli metrics
> Metrics: {"currentplayernum": 1, "serverfps": 120, ...}
$ docker exec palworld-dedicated-server restapicli settings
> Settings: {"Difficulty": "None", "DayTimeSpeedRate": 1.0, ...}
$ docker exec palworld-dedicated-server restapicli gamedata
> Game data: {"Time": "2026-07-10 12:00:00", "FPS": 120, "ActorData": [...]}
# Warning: snapshot of ALL world actors - output can be huge, pipe it to jq or a file
# Note: The game currently answers "PalGameDataBridge GameData API is not enabled" -
# Pocketpair documents the endpoint but has not exposed any way to enable it on
# dedicated servers yet (no INI setting, no launch argument). Tracked in #321.
$ docker exec palworld-dedicated-server restapicli save
> Saving world...
> World saved.
$ docker exec palworld-dedicated-server restapicli announce "Hello players!"
> Announced: Hello players!
$ docker exec palworld-dedicated-server restapicli kick steam_76000000000000123 "Goodbye!"
> Kicked: steam_76000000000000123
$ docker exec palworld-dedicated-server restapicli ban steam_76000000000000123 "You are banned."
> Banned: steam_76000000000000123
$ docker exec palworld-dedicated-server restapicli unban steam_76000000000000123
> Unbanned: steam_76000000000000123
$ docker exec palworld-dedicated-server restapicli banlist
> Ban list (2 entries):
steam_76000000000000123
steam_76000000000000456
$ docker exec palworld-dedicated-server restapicli shutdown 60 "Server restarting soon"
> Shutting down server in 60s...
> Shutdown issued.
Backup Manager
[!WARNING]
If RESTAPI_ENABLED is set to false, the backup manager will not announce backup start/success/failure in-game and will not trigger a world save before creating a backup.
This means that the backup will be created from the last auto-save of the server.
This can lead to data-loss and/or savegame corruption.
Recommendation: Please make sure that RESTAPI_ENABLED=true is set before using the backup manager.
Please use in the following part always the --user steam option or your files will be written as root
Usage: docker exec --user steam palworld-dedicated-server backup [command] [arguments]
| Command |
Argument |
Required/Optional |
Default Value |
Values |
Description |
| create |
N/A |
N/A |
N/A |
N/A |
Creates a backup. |
| list |
<number_to_list> |
Optional |
N/A |
Positive numbers |
Lists all backups.
If <number_to_list> is specified, only the most
recent <number_to_list> backups are listed. |
| clean |
<number_to_keep> |
Optional |
BACKUP_RETENTION_AMOUNT_TO_KEEP |
Positive numbers |
Cleans up backups.
If <number_to_list> is specified, cleans and keeps
the most recent<number_to_keep> backups.
If not, default to BACKUP_RETENTION_AMOUNT_TO_KEEP var |
Examples:
$ docker exec --user steam palworld-dedicated-server backup create
>>> Backup 'saved-20240203_032855.tar.gz' created successfully
$ docker exec --user steam palworld-dedicated-server backup list
>>> Listing 2 backup file(s)!
2024-02-03 03:28:55 | saved-20240203_032855.tar.gz
2024-02-03 03:28:00 | saved-20240203_032800.tar.gz
$ docker exec --user steam palworld-dedicated-server backup clean 3
>>> 1 backup(s) cleaned, keeping 2 backup(s).
$ docker exec --user steam palworld-dedicated-server backup list 1
>>> Listing 1 out of 2 backup file(s).
2024-02-03 03:30:00 | saved-20240203_033000.tar.gz
Webhook integration
To enable webhook integrations, you need to set the following environment variables in the default.env:
WEBHOOK_ENABLED=true
WEBHOOK_URL="https://your.webhook.url"
After enabling the server should send messages in a Discord-Compatible way to your webhook url.
You can find more details about these variables here.
Supported events
- Server starting
- This even is not server started. Just add like 5 seconds on top and the server is online
- Server stopped
- Server updating
- Server updating and validating
Deploy with Helm
A Helm chart to deploy this container can be found at palworld-helm.
FAQ
Does this image support Xbox Dedicated Servers?
Yes just change the value from ALLOW_CONNECT_PLATFORM from Steam to Xbox. See here for more documentation: https://tech.palworldgame.com/getting-started/for-xbox-dedicated-server
How can I use the interactive console in Portainer with this image?
You can run this `docker exec -ti palworld-dedicated-server bash’ or you could navigate to the “Stacks” tab in Portainer, select your stack, and click on the container name. Then click on the “Exec console” button.
How can I look into the config of my Palworld container?
You can run this docker exec -ti palworld-dedicated-server cat /palworld/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini and it will show you the config inside the container.
I’m seeing S_API errors in my logs when I start the container?
Errors like [S_API FAIL] Tried to access Steam interface SteamUser021 before SteamAPI_Init succeeded. are safe to ignore.
I’m using Apple silicon type of hardware, can I run this?
You can try to insert in your docker-compose file this parameter platform: linux/amd64 at the palworld service. This isn’t a special fix for Apple silicon, but to run on other than x86 hosts. The support for arm exists only by enforcing x86 emulation, if that isn’t to host already. Rosetta is doing the translation/emulation.
I changed the BaseCampWorkerMaxNum setting, why didn’t this update the server?
This is a confirmed bug. Changing BaseCampWorkerMaxNum in the PalWorldSettings.ini has no effect on the server. There are tools out there to help with this, like this one: https://github.com/legoduded/palworld-worldoptions
Adding WorldOption.sav will break PalWorldSetting.ini. So any new changes to the settings (either on the file or via ENV VARS), you will have to create a new WorldOption.sav and update it every time for those changes to have an effect.
Planned features in the future
- Feel free to suggest something. Under
Issues there is a Feature Request issue-type.
Software used
评论