Skip to content

max-pfeiffer/rust-game-server-docker

Repository files navigation

Poetry Ruff codecov Code Quality Test Image Build publish workflow helm-release workflow Docker Image Size (latest semver) Docker Pulls

Rust Dedicated Game Server - Docker Image and Helm chart

This Docker image provides a Rust dedicated game server. You will find here also a Helm Chart for running a Rust dedicated server on Kubernetes container orchestration system.

Facepunch releases an update for Rust monthly every first Thursday. Also, there are irregular updates every now and then. Each update requires players and servers to update their versions of the game.

Therefore, an automation checks the Rust release branch every night. If a new release was published by Facepunch, a new Docker image will be built with this new version. Just use the latest tag and you will always have an up-to-date Docker image.

Kudus to:

Docker Hub: https://hub.docker.com/r/pfeiffermax/rust-game-server

GitHub Repository: https://github.com/max-pfeiffer/rust-game-server-docker

Oxide

Since v1.1.0 I provide an Oxide variant of this image. The automation checks for a new Oxide release on GitHub every night and builds a new image based on the latest version of my Rust Docker image.

The tag of these images is prefixed with oxide-build. So look out for these tags on Docker Hub if you want to run Rust with Oxide. There is also a latest-oxide tag, so you can use this to always run an up-to-date Docker image with Oxide.

This image aims to be a solid base to run any plugin. So please drop me a line if you are missing any Debian package for a plugin.

Rust Websocket Rcon

If you want to connect to Rust server console or want to check on the server statistics, check out my Rust Websocket RCon client companion project. I provide a Docker container with Facepunch's websocket Rcon client. This is already integrated in the docker compose examples.

Usage

Configuration

You can append all server configuration options as commands when running RustDedicated binary. Use the regular syntax like +server.ip 0.0.0.0 or -logfile.

As the Rust server is running in the Docker container as a stateless application, you want to have all stateful server data (map, config, blueprints, etc.) stored in a Docker volume which is persisted outside of the container. This can be configured with +server.identity: you can specify the directory where this data is stored. You need to make sure that this directory is mounted on a Docker Volume.

This is especially important because you need to update the Rust server Docker image every month when Facepunch releases a new software update. When you use a Docker volume to store the +server.identity, all the data is still intact.

Check out the docker compose and the docker compose production examples to learn about the details.

Docker Run

For testing purposes, you can fire up a Docker container like this:

docker run -it --publish 28015:28015/udp --publish 28016:28016/tcp pfeiffermax/rust-game-server:latest +server.ip 0.0.0.0 +server.port 28015 +rcon.ip 0.0.0.0 +rcon.port 28016

Docker Compose

With docker compose you have your own Rust server up and running in no-time. For this, just clone this repo (or just copy and paste the compose.yaml file to your machine) and run the server with Docker compose like this:

git clone https://github.com/max-pfeiffer/rust-game-server-docker.git
cd rust-game-server-docker/examples/docker-compose
docker compose up

You can also run the Rust server in the background with option -d:

docker compose up -d

And show the logs, option -f follows the logs:

docker compose logs -f

Rust Websocket Rcon

When spinning up the containers with Docker compose, an instance of the Rust Websocket RCon client is started as well.

If you want to connect to Rust server console or want to check on the server statistics, point your web browser to: http://localhost

Then enter the address of your server and the Rcon password in the web interface.

Production Deployment

If you want to deploy to a production (Linux) server, have a look at the docker compose production example documentation.

Helm chart

If you would like to run the Rust server in your Kubernetes cluster, I provide a Helm chart you could use: https://max-pfeiffer.github.io/rust-game-server-docker

There is also documentation available for that Helm chart.

If you want to run your Rust server on bare metal Kubernetes, check out my blog article on how to do that using kube-vip.

Additional Information Sources

Other Game Server Projects