dst-admin Documentation

dst-admin is a management backend for the Steam version of Don't Starve Together. It provides a simplified way to deploy and manage servers with the following capabilities:

• Server Control: One-click start/stop for Surface and Cave services.
• Monitoring & Logs: Real-time server resource monitoring and viewing of game running logs.
• Configuration: Manage game room settings, world settings, and MOD configurations.
• Save Management: Manage saves, perform restores, and set up automatic backups. Supports uploading local saves.
• Automation: Automatic game updates during unmanned periods.
• Player Management: Set additional administrators or player blacklists. Remote console support for kicking players, rolling back, or resetting the world.

Before deploying dst-admin, ensure your environment meets these requirements:

• OS: Ubuntu (16.04 and 18.04 are tested).
• Runtime: Java JDK 1.8.

Default Network & Access Settings:

• Admin Web Interface: Listens on port 8080 by default.
• Default Credentials:
  • Username: admin
  • Password: 123456
• Don't Starve Together Ports: The game uses ports 10888, 10998, and 10999. It is recommended to open all related ports to avoid connectivity issues.

You can build your own Docker images using the provided build_image.sh script.

1. Navigate to the dst-admin/docker directory.
2. Execute ./build_image.sh with your desired Docker username and the dst-admin version.
3. Verify the image was created and run it locally.

# Build the image
$ cd docker
$ ./build_image.sh <Docker username> <dst-admin version>
# Example:
$ ./build_image.sh wolfgang 1.5.0

# Verify and run your image
$ docker images
$ docker run --name dst-admin -d -p8080:8080 -p10888:10888/udp -p10998-10999:10998-10999/udp wolfgang/dst-admin:v1.5.0

For a fully automated setup, use the startDst.sh script which handles the deployment process:

wget http://clouddn.tugos.cn/startDst.sh
chmod +x ./startDst.sh
./startDst.sh

Use the provided dstStart.sh script to manage the dst-admin service lifecycle according to the on-screen instructions.

./dstStart.sh

Follow these steps to download and run the dst-admin JAR file:

1. Download the latest package:

   wget http://clouddn.tugos.cn/release/dst-admin-1.5.0.jar -O dst-admin.jar

2. Start the service:

   java -jar dst-admin.jar

3. Install the game client: Once dst-admin starts, it will release an install.sh script. Execute it to install the Steam Don't Starve Together client (you may need to run this multiple times if network issues cause interruptions):

   ./install.sh

# Download
wget http://clouddn.tugos.cn/release/dst-admin-1.5.0.jar -O dst-admin.jar

# Start
java -jar dst-admin.jar

# Install game client
./install.sh

Run the following commands to update your package source and install OpenJDK 1.8:

# Update software sources
sudo apt-get update

# Install OpenJDK 1.8
sudo apt-get install -y openjdk-8-jdk

# Verify installation
java -version

Successful installation is indicated by an output similar to openjdk version "1.8.0_252".

Download the dst-admin JAR file and run it using the Java runtime.

Default Credentials:

• Port: 8080
• Username: admin
• Password: 123456

# Download the newest dst-admin
wget http://clouddn.tugos.cn/release/dst-admin-1.5.0.jar -O dst-admin.jar

# Start dst-admin
java -jar dst-admin.jar

If you need to build your own image, use the build_image.sh script located in the docker directory.

Steps:

1. Navigate to the docker directory.
2. Run the build script providing your Docker username and the desired dst-admin version.
3. Verify the image exists using docker images.
4. Run the newly built image using the docker run command.

Note: Build speed depends on your network connection. If you encounter network errors or slow speeds, consider using a mirror or a proxy.

$ cd docker
$ ./build_image.sh <Docker_Username> <dst-admin_version>
# Example:
$ ./build_image.sh wolfgang 1.5.0

# After building, run it:
$ docker run --name dst-admin -d -p8080:8080 -p10888:10888/udp -p10998-10999:10998-10999/udp wolfgang/dst-admin:v1.5.0

After starting dst-admin, an install.sh script will be released. Run this script to install the Steam client and the Don't Starve Together client. Note that executing the script may require your sudo password and might need to be run several times due to potential internet connectivity issues.

./install.sh

Use the provided dstStart.sh script to manage and control the dst-admin service as prompted by the script's instructions.

./dstStart.sh