Skip to content

newReadMe

N0rimaki edited this page Dec 30, 2021 · 22 revisions

DockerHub Badge

Insurgency Sandstorm – customisable dedicated server

This repository contains a docker image with a dedicated server for Insurgency Sandstorm (vanilla) that you can fully customise to your need for coop and PVP servers.

This image will be build daily (since July 2020) so you don’t have to update anything inside a container. I tried to build the image as “best-practice” as possible and to document everything for you. If you have any questions or suggetions please feel free open an issue. shortened URL to the Project: https://git.io/Jyujj

Here you can check the last update on the container (yes, the project is still maintained) https://hub.docker.com/r/snickch/insurgencysandstormdedicatedserver


Quick Start - tl;dr

All you need to know for the quick start, read the rest another day. It's okay!

1. You need a Linux Host for the docker container

For this example the Linux-user ist gameadmin and the game-root-folder is /home/gameadmin/insurgeny/
Server requirements

2. Copy the Example

Copy all files from the Example in your home folder.

/home/gameadmin/insurgeny/

3. Make the script executable

Use chmod +x on start_survival.sh
chmod +x start_survival.sh

4. Change permissions

You will need to adjust the Permissions

replace user and usergroup with your setup. Normaly both are just your username. If your user is "gameadmin" you use "gameadmin:gameadmin"

chown user:usergroup Game.ini Mods Engine.ini Admins.txt Mods.txt MapCycle.txt

5. Change the values of the variables

in start_survival.sh
GSLTTOKEN
GAMESTATSTOKEN
GAMEPORT
QUERRYPORT

in Engine.ini
mod.io API-Key https://mod.io/apikey/

in Game.ini
Password for Rcon
ServerHostname

6. make a Port Fowarding

Setup a Port Fowarding for these Ports GAMEPORT QUERRYPORT

7. Start the Server

Type start_survival.sh in your linux console


Where to run the Docker Container

How to get the image

Update(s)

Game

Game Tokens

You need 3 Tokens to run the Server properly.

GSLTTOKEN

This Token comes from Steam and verify you as Insurgency Sandstorm Server https://steamcommunity.com/dev/managegameservers
App-ID:581320
GSLTTOKEN="XXXXXXXX"

GAMESTATSTOKEN

This Token enables official XP gain https://gamestats.sandstorm.game/
GAMESTATSTOKEN="XXXXXXXX"

mod.io

For running custom Mods or Maps you need to Login to https://mod.io The API-Key from https://mod.io/apikey/ goes to the Engine.ini

Examples

You can use these Examples for running different Game Modes.

Rcon

Files

Game.ini

Engine.ini

Mods.txt

Admins.txt

MapCycle.txt


Troubleshooting

File and Folder permissions

If your server doesn't start with Mods or without settings, make sure that all the files (Game.ini etc.) and the "Mods" Folder have the correct user permission. You can change the permissions with the chwon command. Make sure you replace USER and GROUP with your information.

chown USER:GROUP Game.ini Mods Engine.ini Admins.txt Mods.txt MapCycle.txt

Example how it should look, if your user is debian with the group debian

-rw-r--r-- 1 debian debian   87 Dec 13 17:10 Admins.txt
-rw-r--r-- 1 debian debian 1.8K Dec 14 15:20 Engine.ini
-rw-r--r-- 1 debian debian  22K Dec 21 19:12 Game.ini
-rw-r--r-- 1 debian debian 5.5K Dec 14 17:22 MapCycle.txt
-rw-r--r-- 1 debian debian   82 Dec 14 17:22 Mods.txt

How it looked when it was wrong, because I created the Admins.txt with root

-rw-r--r-- 1 root   root     87 Dec 13 17:10 Admins.txt
-rw-r--r-- 1 debian debian 1.8K Dec 14 15:20 Engine.ini
-rw-r--r-- 1 debian debian  22K Dec 21 19:12 Game.ini
-rw-r--r-- 1 debian debian 5.5K Dec 14 17:22 MapCycle.txt
-rw-r--r-- 1 debian debian   82 Dec 14 17:22 Mods.txt

Project status

This is my first docker project. If you need more information, find a bug or mistakes in the documentation it is very appreciated if you contact me. If you need support it would be the best if you create a new thread in the steam discussion for dedicated servers and first check that it is not an general server issue (related to steamcmd or the game). If you think it is a container related issue (based on my image) feel free to contact me.

Timeline

30.December 2021 - n0ri; activate the wiki and remove the Wall of text from the Readme. 29.December 2021 - n0ri; Added the RCON with ISRT, Remove RCON from start script, added it to the Game.ini 28.December 2021 - n0ri joined as a contributor. Thank you very much for updating the documentation, all the testing and for your inputs. The documentation is now cleaner and easier to get startet. Now documented watchtower run command and beginner friendly info on how to manage the container 27.December 2021 - I made the script a bit easier (I will continue to make it easier and document a simpler version for watchtower) 19.December 2021 - Updated the docker-compose.yml for watchtower 26.November 2021 - I added a howto for Watchtower, so the container is automatically updated. No need for any scripts and cron jobs.

23.March 2021 - Thanks to jcoker85 I corrected the path in the readme to the .ini files. Now they should be correct and can be copied 1:1 from the example.

24.July 2020 - I started on working on a baseline image for steamcmd. The testing branche (:test) is already using it. So new images can build up on this image and will reduce the build time. On the other hand verybody can now use my daily updated steamcmd image for any kind of dedicated servers. On the test branch I'm now working on optimizing the image to get less layers to improve the container space and layer usage. https://hub.docker.com/r/snickch/steamcmd

20.July 2020 - The images are now created on a daily base to make sure that on new updates the image is ready (so I don't have to check it manually any more).

18.May 2020 - Mods are now supported, as long as they work on Linux. To support this, I had to add an empty folder "Mods".Make sure your mods work with Linux before you use them with this container.

15.May.2020 - The base image has been changed to debian:buster-slim When creating the image, the latest libraries are now used (no longer attached to a version)

11.May 2020 – official public release

11.May 2020 – official project created

10.May 2020 – autobuild activated

05.May 2020 – first build

Known issues

At the moment there are no known issues

Future considerations

The image works as planned. There is a lot of documentation. In my opinion there is nothing to consider at the moment. The only thing that could follow in the future is a docker-compose example, as soon as I have to change my VM where the server runs. If you have a working docker-compose example, feel free to open an issue so I can add it to the decription.

Clone this wiki locally