From 7a0ccfd34f2261b42ab9b4cdce88a63856f8335c Mon Sep 17 00:00:00 2001 From: Knut Ahlers Date: Sat, 18 Feb 2017 16:53:12 +0100 Subject: [PATCH] Add README Signed-off-by: Knut Ahlers --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..03e169f --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Luzifer / rust-server + +This repository contains a Docker setup for [Linux Game Server Managers](https://gameservermanagers.com/) [Rust](http://playrust.com/) management script. + +## How to use + +- Choose a directory which will be used to persist downloaded gameserver data, maps, player data, ... (Needs ~6GB disk-space) + This README will use `/data/rust` as chosen directory. So replace that one with your choice in all commands. +- Execute `chown 1000:1000 /data/rust` to enable the unprivileged user in the container to write into that directory +- Do a first installation of the server: (This will require quite a time as it downloads a 5.8GB gameserver) + `docker run --rm -ti -v /data/rust:/home/rustserver --name rust quay.io/luzifer/rust-server auto-install` +- Edit `/data/rust/rustserver` script and exchange RCON password and other configuration variables +- Edit `/data/rust/serverfiles/server/rust-server/cfg/server.cfg` and set the description, image and URL of your server +- Start your server: + +``` +docker run -d -p 28015:28015/udp -p 28016:28016 \ + -v /data/rust:/home/rustserver --name rust \ + quay.io/luzifer/rust-server start +``` + +- To stop the server I recommend using the RCON console and the command `quit`. This will ensure the server has created a proper savegame. +- To update the server stop it and afterwards execute the update: + `docker run --rm -ti -v /data/rust:/home/rustserver quay.io/luzifer/rust-server update` +