apfelwurm/csgo-get5-docker-dev repository overview

⁠

⁠ csgo-get5-docker-dev

Development container for get5

⁠ ⁠ ⁠ ⁠

⁠1. Introduction

This image aims to provide a CS:GO server to develop and test get5⁠.

Do not use this in production to run your matches!

Everything that can be changed about the server can be set using environment variables passed to Docker on container creation.

If you want to use your local build you have to build it first using this instructions⁠

For further information please read the docs⁠.

⁠2. Using the image

⁠2.1 Quickstart

1. Download the image from Docker hub⁠:

docker pull apfelwurm/csgo-get5-docker-dev:latest

1. Launch a container:

docker run --rm -it --network=host apfelwurm/csgo-get5-docker-dev:latest

⁠2.2 Recommended Docker launch arguments

At minimum, you'll probably want to launch the container with the following environment variables set:

• -it: run the container interactive. There will be problems if you don't run it interactiveley.

• --network=host: use the host machine's ports and IP address, rather than running within an isolated Docker network that's not visible to the outside world.

• -e RCON_PASSWORD=<some other password>: set the RCON (admin) password.

If you want to start the server with a loaded config, set:

• -e MATCH_CONFIG=<your match config>: start the server with the given JSON config loaded with Get5.

⁠2.3 Examples

⁠2.3.1 Starting a server with no match config with your local get5 development build

Start a server with:

• The host machine's IP address
• The specified port, GOTV port, password, RCON password, GOTV password

docker run --rm -it --network=host \
 -e GOTV_ENABLE=1 \
 -e PORT=1234 \
 -e GOTV_PORT=1235 \
 -e GOTV_DELAY=15 \
 -e PASSWORD=mypass \
 -e RCON_PASSWORD=adminpass \
 -e GOTV_PASSWORD=gotvpass \
 -e GET5_VER=LOCAL\
 -v $PWD/builds/get5:/localmounts/get5 \
 apfelwurm/csgo-get5-docker-dev:latest

⁠2.3.2 Starting a server with a match config

Start a server with:

• The host machine's IP address
• The specified port, GOTV port, password, RCON password, GOTV password
• The given Get5 config loaded

docker run --rm -it --network=host \
 -e GOTV_ENABLE=1 \
 -e PASSWORD=mypass \
 -e RCON_PASSWORD=adminpass \
 -e GOTV_PASSWORD=gotvpass \
 -e GOTV_DELAY=15 \
 -e MATCH_CONFIG="{'matchid': '81a99ef9a2844c278c2bda2f5a77a793', \
                   'num_maps': 3, \
                   'maplist': ['de_dust2', 'de_inferno', 'de_mirage', 'de_nuke', 'de_overpass', 'de_train', 'de_vertigo'], \
                   'skip_veto': False, \
                   'team1': {'name': 'Astralis', \
                             'tag': 'AST', \
                             'players': {698652696634933762: 'gla1ve', \
                                         234783204182937471: 'Magisk', \
                                         389371614622221912: 'dev1ce', \
                                         951311418417028314: 'dupreeh', \
                                         369417162788295143: 'Xyp9x'}}, \
                   'team2': {'name': 'Natus Vincere', \
                             'tag': 'NAVI', \
                             'players': {875407653610178066: 's1mple', \
                                         979550479724346962: 'Boombl4', \
                                         186841562108230104: 'electronic', \
                                         726408891643982724: 'Perfecto', \
                                         512316566954794515: 'flamie'}}}" \
 apfelwurm/csgo-get5-docker-dev:latest

⁠3. Environment variables

Setting environment variables when starting a container allows you to manipulate the launch options of the server.

For example, docker run -it -e PASSWORD=1234 apfelwurm/csgo-get5-docker-dev:latest will start a new server with password 1234 by launching the server with +sv_password 1234.

All possible environment variables are displayed in the table below.

Launch options are appended to the following set of basic launch options that are passed as arguments to srcds, the dedicated server program:

-game csgo -console -usercon -steam_dir $STEAMCMD_DIR -steamcmd_script $STEAMCMD_DIR/steamcmd.sh -ip 0.0.0.0

⁠4. Mountpoints

⁠5. Keeping the image up to date

⁠5.1 Updates on launch

By default, when a container is started from the image, it checks for CS:GO updates and installs them. Note that this will not modify your local copy of the image, so future containers will also have to download the update. To disable checking for updates on launch, set the environment variable UPDATE_ON_LAUNCH to be 0.

⁠5.2 Scheduled and manual updates

For ensuring that an image contains the latest CS:GO version, two scripts are provided, one for local images and one for the image in the DockerHub repo. These can be run manually or at scheduled intervals. They run the following steps:

1. Check the version of CS:GO installed on the image
2. If the version differs from the latest version of CS:GO according the Steam Web API, then a container is spawned running server-scripts/server-update.sh, which installs CS:GO updates
3. The changes to the container are committed to the image and the image label updated to show the version of CS:GO installed
4. The image is pushed to the registry (image_update/update-image-remote.sh only)

The image updater scripts use jq to parse JSON objects from the Steam Web API. Install it using sudo apt install jq.

⁠5.2.1 Local version

To keep your local image up to date, you can schedule a cron job to run updated-local-image.sh at given intervals. For example:

1. Run crontab -e to edit the crontab for the current user
2. Add the following line to the opened file:

10 * * * * /home/myuser/csgo-get5-docker-dev/update-local-image.sh > /home/myuser/csgo-get5-docker-dev/cron.log

This will run the script /home/myuser/csgo-get5-docker-dev/update-local-image.sh at 10 minutes past the hour every hour, and log the output to /home/myuser/csgo-get5-docker-dev/cron.log.

⁠5.2.2 Version on DockerHub

The workflow "Uses latest CS:GO version"⁠ checks that the version of CSGO on the image in the DockerHub registry matches the latest CS:GO patch released on Steam. If the versions missmatch, a issue is created here.

I run the image_update/update-image-remote.sh locally if nessecary and as soon as the docker hub is updated, i'll close the corresponding issue.

So if the image is already updated (which should happen soon after the release), you can simply run docker pull apfelwurm/csgo-get5-docker-dev:latest again to update.