mornedhels/enshrouded-server repository overview

⁠Enshrouded-Dedicated-Server

Docker image for the game Enshrouded. The image is based on the steamcmd⁠ image and uses supervisor to handle startup, automatic updates and cleanup.

⁠Environment Variables

All environment Variables prefixed with SERVER, are the available enshrouded_server.json options (see Enshrouded Docs⁠)

⚠️: Work in Progress

⁠Additional Information

• During the update process, the container temporarily requires more disk space (up to 2x the game size).
• Server role configuration can be done via the enshrouded_server.json file directly or the SERVER_ROLE_<index>_XYZ environment vars. The file is located in the game/server folder. More information can be found in the official documentation⁠.

⁠Hooks

The scripts will wait for the hook to resolve/return before continuing.

⚠️: Work in Progress

⁠Image Tags

⁠Ports (default)

⁠Volumes

Note: By default the volumes are created with the UID and GID 4711 (that user should not exist). To change this, set the environment variables PUID and PGID.

⁠Recommended System Requirements

• CPU: >= 6 cores
• RAM: >= 16 GB
• Disk: >= 30 GB (preferably SSD)

Official Docs⁠

⁠Usage

⁠Docker

docker run -d --name enshrouded \
  --hostname enshrouded \
  --restart=unless-stopped \
  -p 15637:15637/udp \
  -v ./game:/opt/enshrouded \
  -e SERVER_NAME="Enshrouded Server" \
  -e UPDATE_CRON="*/30 * * * *" \
  -e PUID=4711 \
  -e PGID=4711 \
  mornedhels/enshrouded-server:latest

⁠Docker Compose

services:
  enshrouded:
    image: mornedhels/enshrouded-server:latest
    container_name: enshrouded
    hostname: enshrouded
    restart: unless-stopped
    stop_grace_period: 90s
    ports:
      - "15637:15637/udp"
    volumes:
      - ./game:/opt/enshrouded
    # only add ntsync device if your kernel supports it (6.14 or newer)
    devices:
      - /dev/ntsync:/dev/ntsync
    environment:
      - SERVER_NAME=Enshrouded Server
      - UPDATE_CRON=*/30 * * * *
      - PUID=4711
      - PGID=4711

Note: The volumes are created next to the docker-compose.yml file. If you want to create the volumes, in the default location (eg. /var/lib/docker) you can use the following compose file:

services:
  enshrouded:
    image: mornedhels/enshrouded-server:latest
    container_name: enshrouded
    hostname: enshrouded
    restart: unless-stopped
    stop_grace_period: 90s
    ports:
      - "15637:15637/udp"
    volumes:
      - game:/opt/enshrouded
    # only add ntsync device if your kernel supports it (6.14 or newer)
    devices:
      - /dev/ntsync:/dev/ntsync
    environment:
      - SERVER_NAME=Enshrouded Server
      - UPDATE_CRON=*/30 * * * *
      - PUID=4711
      - PGID=4711

volumes:
  game:

⁠Security Hardening

For information on how to run the Enshrouded server more securely, please refer to the Security Hardening⁠ guide.

⁠Backup

The image includes a backup script that creates a zip file of the last saved game state. To enable backups, set the BACKUP_CRON environment variable. To limit the number of backups, set the BACKUP_MAX_COUNT environment variable.

To restore a backup, stop the server and simply extract the zip file to the savegame folder and start the server up again. If you want to keep the current savegame, make sure to make a backup before deleting or overwriting the files.

⁠Commands

• Force Update:

  docker compose exec enshrouded supervisorctl start enshrouded-force-update
  

  Copy
• Reset Server Roles: (Restarts the whole docker container) ⚠️

  docker compose exec enshrouded supervisorctl start enshrouded-reset-roles
  

  Copy
• Restart Enshrouded Server: (can be used for periodic restarts)

  docker compose exec enshrouded supervisorctl restart enshrouded-server
  

  Copy

⁠Known Issues

• The server doesn't start (not logging 'HostOnline' (up)!) or the update fails with following error:

  Error! App '2278520' state is 0x202 after update job.
  

  Copy
  This means there is probably something wrong with your file permissions, or you don't have enough disk space left. Make sure the UID and GID are correct and the files are owned by the correct user.
• The (auto-)update fails with the following error:

  Error! App '2278520' state is 0x6 after update job.
  

  Copy
  Officially this means the updater has no connection to the content servers.
  But there could also be something wrong with the steam appmanifest (#119⁠). To fix this, you can use the force update command.