Docker - Sons of the Forest Dedicated Server

Tip

Do you want to chat with the community?

Join us on Discord

Warning

Update Jan-2025: This Docker-Image had a major refactoring including breaking changes in downwards-compability. This was done for removing dependency of "root" in the image, which caused various SteamCMD, NAS, QNAP, Synology and Portainer problems. Also the Docker-Base-Image was switched and there was better process-handling added to make sure the process exits cleanly, no matter how Docker or the User stops the server.

It is recommended to do a fresh install, via the new readme in a fresh directory to understand what changed and work backwards to adapt the changes, or migrate the savegame from the old server to the new one, up to you. If you need help, feel free to join the Discord server and ask in the right channel for the game.

Note

If you are looking for the TheForest version, please look here: https://github.com/jammsen/docker-the-forest-dedicated-server

This repository includes a Sons of the Forest Dedicated Server based on Docker with Wine and an example config.

---

Table of Contents

• Docker - Sons of the Forest Dedicated Server
  • Table of Contents
  • How to ask for support for this Docker image
  • Requirements
  • Minimum system requirements
  • Changelog
  • Wiki
  • Getting started
    • Docker-Compose - Example
  • 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

Resource	Minimum (2-4 Players)	Recommended (4 Players)
CPU	2-4 CPU-Cores @ Mid GHz	4+ CPU Cores @ High GHz
RAM	8GB+ RAM	16GB+ RAM
Storage	12GB+	20GB+ (SSD prefered)

Changelog

You can find the changelog here

Wiki

Tip

Currently out-dated, because of Major refactoring, with breaking changes!

We have very detailed instruction in our Wiki page.

Getting started

If you already hosted some containers, just follow these steps:

1. Go to the directory you want to host your gameserver on your Dockernode
2. Create a sub-directory called game
3. Download the docker-compose.yml or use the following example
4. Review the file and setup the settings you like
5. Setup Port-Forwarding or NAT for the ports in the Docker-Compose file
6. Start the container via Docker Compose
7. (Tip: Extended config settings, which are not covered by Docker Compose, can be setup in the config-file of the server - You can find it at game/userdata/dedicatedserver.cfg)

Docker-Compose - Example

version: '3.9'
services:
  sons-of-the-forest-dedicated-server:
    container_name: sons-of-the-forest-dedicated-server
    image: jammsen/sons-of-the-forest-dedicated-server:latest
    restart: always
    environment:
      PUID: 1000
      PGID: 1000
      ALWAYS_UPDATE_ON_START: true
      SKIP_NETWORK_ACCESSIBILITY_TEST: true
    ports:
      - 8766:8766/udp
      - 27016:27016/udp
      - 9700:9700/udp
    volumes:
      - ./game:/sonsoftheforest

Planned features in the future

• Feel free to suggest features in the issues

Software used

• Debian Stable and SteamCMD via cm2network/steamcmd:root image as base-image
• gosu
• procps
• winbind
• wine
• xvfb
• SonsOfTheForest Dedicated Server (APP-ID: 2465200)