jammsen/palworld-dedicated-server repository overview

⁠Docker - Palworld Dedicated Server

This Docker image includes a Palworld Dedicated Server based on Linux and Docker.

⁠Table of Contents

• Docker - Palworld Dedicated Server⁠
  • Table of Contents⁠
  • How to ask for support for this Docker image⁠
  • Requirements⁠
  • Minimum system requirements⁠
  • Changelog⁠
  • Credits / Shoutout / Contributions⁠
  • Getting started⁠
  • Environment variables⁠
  • Docker-Compose examples⁠
    • Gameserver with REST API⁠
  • Run REST API commands⁠
  • Backup Manager⁠
  • Webhook integration⁠
    • Supported events⁠
  • Deploy with Helm⁠
  • FAQ⁠
    • Does this image support Xbox Dedicated Servers?⁠
    • How can I use the interactive console in Portainer with this image?⁠
    • How can I look into the config of my Palworld container?⁠
    • I'm seeing S_API errors in my logs when I start the container?⁠
    • I'm using Apple silicon type of hardware, can I run this?⁠
    • I changed the BaseCampWorkerMaxNum setting, why didn't this update the server?⁠
  • Planned features in the future⁠
  • Software used⁠

⁠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

⁠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:

• @thejcpalma⁠ - https://github.com/thejcpalma/palworld-dedicated-server-docker⁠ - https://hub.docker.com/r/thejcpalma/palworld-dedicated-server⁠ - ❤️🫡
• @thijsvanloef⁠ - https://github.com/thijsvanloef/palworld-server-docker⁠ - https://hub.docker.com/r/thijsvanloef/palworld-server-docker⁠ - ❤️🫡

⁠Getting started

1. 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!
2. Set up Port-Forwarding or NAT for the ports in the Docker-Compose file
3. Pull the latest version of the image with docker pull jammsen/palworld-dedicated-server:latest
4. Download the compose.yml⁠ and default.env⁠
5. 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
6. 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
7. 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

Usage: docker exec --user steam palworld-dedicated-server backup [command] [arguments]

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.

⁠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?

⁠How can I use the interactive console in Portainer with this image?

⁠How can I look into the config of my Palworld container?

⁠I'm seeing S_API errors in my logs when I start the container?

⁠I'm using Apple silicon type of hardware, can I run this?

⁠I changed the BaseCampWorkerMaxNum setting, why didn't this update the server?

⁠Planned features in the future

• Feel free to suggest something. Under Issues there is a Feature Request issue-type.

⁠Software used

• CM2Network SteamCMD - Debian-based (Officially recommended by Valve - https://developer.valvesoftware.com/wiki/SteamCMD#Docker⁠)
• Supercronic - https://github.com/aptible/supercronic⁠
• jq - https://jqlang.org/⁠
• Palworld Dedicated Server (APP-ID: 2394010 - https://steamdb.info/app/2394010/config/⁠)