Don't Starve Together Dedicated Server Docker Image

This is the Docker image for DST dedicated server, based on debian:latest.

Project Status

It's been proved working on at least 2 servers with customized settings. There is currently no automated tests or CI.

Functions:

Tested environments:

Antergos (an Arch Linux based distro)
- System inside a Hyper-V Virtual Machine of Windows 8.1
- 8GB RAM
- running the latest tag of Docker Hub image, i.e. the most recent code from master of this Github repo
DaoCloud (a docker hosting platform)
- 1GB RAM
- running the most recent tagged code in this Github repo
- image built from DaoCloud custom mechanism

Known Issues

There is currently no easy way to set up Cave server using this. Work in progress.
Don't expect this to be done so soon -- the cave guide on the offical forum has a terribly low SNR.
On Docker environment which doesn't support UDP port forwarding, LAN only server cannot be used. (Still you can enable Steam punchthrough and search for your server in Online catalog. )
It should be cross-platform, but OS X and Windows haven't been fully tested.

Install Using Docker Compose

It's the recommended way for those who are not familiar with Docker.

Create a folder for storing DST server files, then put a docker-compose.yml inside it, paste the following content:

overworld-server:
  image: jamesits/don-t-starve-together-dedicated-server:latest
  restart: always
  ports:
  - 10999:10999/udp
  volumes:
  - ./server_config:/data/DoNotStarveTogether

Then use docker-compose up to bring up the server. You can change server config in ./server_config.

To update image, use docker-compose pull to update automatically.

Manual Installation

Do this only if you know how to use Docker and know exactly what every command means. Data is invaluable.

Install from Docker Hub

docker pull jamesits/don-t-starve-together-dedicated-server

Install from DaoCloud

Chinese users may experience a faster download speed in this way. I can't promise it will be available in a long time.

docker pull daocloud.io/codevs/dst_server

Note: If you use Docker the VM way (i.e. running the image without /data/DoNotStarveTogether mounted to a volume or host), please be cautious:

All data (server settings, saved game status, etc.) will be DELETED PERMANATELY when deleting or updating image
You have to use the default server configuration or pass command line arguments by yourself

More Information please refer to Docker Hub page.

Build Docker image locally

git clone https://github.com/Jamesits/Don-t-Starve-Together-Dedicated-Server.git dst_server
cd dst_server
docker build --build-arg HTTP_PROXY=$HTTP_PROXY --build-arg HTTPS_PROXY=$HTTP_PROXY --build-arg https_proxy=$HTTP_PROXY --build-arg http_proxy=$HTTP_PROXY .

Entrypoint Script Arguments

start: the default CMD to start server
reset: delete saved game (you should start twice after that to prevent any errors)
update: update server program and mods

Server Settings

All persist server settings can be found under ./server_config by default.

save/*list.txt will be copied to ./server_config automatically so they won't be removed on server reset.

Instructions on Obtaining Server Token

Launch a steam client on a system with GUI, install Don't Starve Together, log in, press ~ button then type TheNet:GenerateServerToken() then press enter. You'll find a server_token.txt under your client config directory. (See "References" section below for more detailed instructions. )

If you use the Docker Compose way, or have /data/DoNotStarveTogether mounted to your host machine, copy the FILE server_token.txt (not its content) to that folder. Also you may set token in settings.ini.

In other cases, you can set ENV DST_SERVER_TOKEN using the content of your server_token.txt. Just open it use any text editor and copy the CONTENT. Please note that if server_token.txt already exists, it won't be changed by startup script.

Modify Settings on a Volume You Don't Have Access To

Create or use a Docker container which have SSH Daemon service (Like rastasheep/ubuntu-sshd, but for security issues I recommend using your own image and use pubkey authencation. )
Mount your server config volume to some place of our SSH Daemon container
SSH into daemon container and change settings
Restart game server using docker-compose restart

Sample docker-compose.yml which can be appended after original one:

manager:
  image: rastasheep/ubuntu-sshd
  restart: always
  ports:
  - 22
  volumes:
  - ./server_config:/mnt/DoNotStarveTogether

Maintainer

Thanks

License

Don't Starve Together Dedicated Server Docker Image
Copyright (C) 2015 James Swineson (Jamesits)
Copyright (C) 2015 Mingye Wang (Arthur2e5)

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

References

Guides/Don’t Starve Together Dedicated Servers
[GUIDE] How to setup server dedicated cave on Linux
Run dedicated server in Docker (This post was written by me)

GolfenGuo / DST-Dedicated-Server-Docker