astra/CS2
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update files

Browse source
This commit is contained in:
Astra 2025-03-19 14:55:55 +00:00
parent 38b2938f79
commit 4cfa6d653b
4 changed files with 48 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

54
README.md
View file

@ -1,52 +1,51 @@
[![Docker Image CI](https://github.com/joedwards32/CS2/actions/workflows/docker-image.yml/badge.svg?branch=main)](https://github.com/joedwards32/CS2/actions/workflows/docker-image.yml) [![Docker Build and Publish](https://github.com/joedwards32/CS2/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/joedwards32/CS2/actions/workflows/docker-publish.yml)
# What is Counter-Strike 2?
For over two decades, Counter-Strike has offered an elite competitive experience, one shaped by millions of players from across the globe. And now the next chapter in the CS story is about to begin. This is Counter-Strike 2.
For over two decades, Counter-Strike has offered an elite competitive experience, one shaped by millions of players from across the globe. And now the next chapter in the CS story is about to begin. This is [Counter-Strike 2](https://store.steampowered.com/app/730/CounterStrike_2/).
This Docker image contains the dedicated server of the game.
> [CS2](https://store.steampowered.com/app/730/CounterStrike_2/)
<img src="https://cdn.cloudflare.steamstatic.com/steam/apps/730/header.jpg?t=1696011820" alt="logo" width="300"/></img>
<img src="https://cdn.cloudflare.steamstatic.com/steam/apps/730/header.jpg?t=1696011820" alt="logo" width="600"/></img>
# How to use this image
## Hosting a simple game server
Running using Docker:
Running on the *host* interface (recommended):<br/>
```console
$ SRCDS_TOKEN="..." # check https://steamcommunity.com/dev/managegameservers
$ docker run -d --name=cs2 -e SRCDS_TOKEN="$SRCDS_TOKEN" -p 27015:27015/tcp -p 27015:27015/udp -p 27020:27020/udp joedwards32/cs2
$ docker run -d --net=host --name=cs2 -e STEAMUSER={YOUR_STEAM_USER} -e STEAMPASS={YOUR_STEAM_PASSWD} git.zio.sh/astra/cs2:latest
```
Running using a bind mount for data persistence on container recreation:
```console
$ mkdir -p $(pwd)/cs2-data
$ chown 1000:1000 $(pwd)/cs2-data # Makes sure the directory is writeable by the unprivileged container user with uid 1000, known as steam
$ SRCDS_TOKEN="..." # check https://steamcommunity.com/dev/managegameservers
$ docker run -d --name=cs2 -e SRCDS_TOKEN="$SRCDS_TOKEN" -v $(pwd)/cs2-data:/home/steam/cs2-dedicated/ -p 27015:27015/tcp -p 27015:27015/udp -p 27020:27020/udp joedwards32/cs2
$ chmod 777 $(pwd)/cs2-data # Makes sure the directory is writeable by the unprivileged container user
$ docker run -d \
--net=host \
-v $(pwd)/cs2-data:/home/steam/cs2-dedicated/ \
--name=cs2-dedicated \
-e STEAMUSER=<YOUR_STEAM_USER> \
-e STEAMPASS=<YOUR_STEAM_PASSWD> \
git.zio.sh/astra/cs2:latest
```
or using docker-compose, see [examples](https://github.com/joedwards32/CS2/blob/main/examples/docker-compose.yml):
```console
# Remember to update passwords and SRCDS_TOKEN in your compose file
$ docker compose --file examples/docker-compose.yml up -d cs2-server
```
`STEAMUSER` and `STEAMPASS` **are required as unlike CS:GO, CS2 can not be downloaded anonymously (at time of writing).**
You must have at least **40GB** of free disk space! See [System Requirements](./#system-requirements).
`STEAMGUARD` **must be used to provide your more recent Steam Guard key if Steam Guard is enabled on your account.**
**The container will automatically update the game on startup, so if there is a game update just restart the container.**
# Configuration
## System Requirements
Minimum system requirements are:
* 2 CPUs
* 2GiB RAM
* 40GB of disk space for the container or mounted as a persistent volume on `/home/steam/cs2-dedicated/`
Please note that you need approximately 1.5g of free RAM. If this is not available, container will crash with err 137.
## Environment Variables
Feel free to overwrite these environment variables, using -e (--env):
Feel free to overwrite these environment variables, using -e (--env) or --env-file (recommended):
### SteamCMD
```dockerfile
STEAMUSER="changeme" (Steam User for SteamCMD.)
STEAMPASS="changeme" (Password for Steam User.)
STEAMGUARD="" (Optional, Steam Guard key if enabled. Use your most recent Steam Guard key.)
```
### Server Configuration
@ -63,7 +62,7 @@ CS2_RCON_PORT="" (Optional, use a simple TCP proxy to have RCON liste
Useful for services like AWS Fargate which do not support mixed protocol ports.)
CS2_LAN="0" (0 - LAN mode disabled, 1 - LAN Mode enabled)
CS2_RCONPW="changeme" (RCON password)
CS2_PW="" (Optional, CS2 server password)
CS2_PW="changeme" (Optional, CS2 server password)
CS2_MAXPLAYERS=10 (Max players)
CS2_ADDITIONAL_ARGS="" (Optional additional arguments to pass into cs2)
```
@ -179,9 +178,6 @@ The container can be instructed to download a extract a Tar Gzip bundle, Tar or
CS2_CFG_URL="" (HTTP/HTTPS URL to fetch a Tar Gzip bundle, Tar or Zip archive of configuration files/mods)
```
See [examples](https://github.com/joedwards32/CS2/blob/main/examples/cs2.cfg.tgz) for a correctly formatted Tar Gzip customisation bundle, the same format applies to all archive types.
# Credits
This container leans heavily on the work of [CM2Walki](https://github.com/CM2Walki/), especially his [SteamCMD](https://github.com/CM2Walki/steamcmd) container image. GG!