https://github.com/mayniklas/docker-csgo-server
https://github.com/mayniklas/docker-csgo-server
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mayniklas/docker-csgo-server
- Owner: MayNiklas
- Created: 2020-06-10T10:31:14.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2021-07-02T15:21:47.000Z (almost 5 years ago)
- Last Synced: 2025-02-09T10:09:40.120Z (over 1 year ago)
- Language: Shell
- Size: 26.4 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# docker-csgo-server
---
## Quick Start
**NOTE**: The Docker command provided in this quick start is given as an example
and parameters should be adjusted to your need.
Launch the csgo-server docker container with the following command:
```
docker run --rm -d \
-p "27015:27015/udp" \
-p "27015:27015/tcp" \
-e TOKEN= \
-v $(pwd)/cs-server:/home/cs \
--name csgo-server \
mayniki/csgo-server
```
Where:
- `$(pwd)/cs-server:/home/cs`: This is where the application get's installed. In this case, your current directory is used.
- `TOKEN`: Insert your API token
You can also use the following, in case you don't want persistant data on your system:
```
docker run --rm -d \
-p "27015:27015/udp" \
-p "27015:27015/tcp" \
-e TOKEN= \
--name csgo-server \
mayniki/csgo-server
```
## Motivation
Since I haven't found a CS GO container I liked, I wrote my own.
Since the install is really big, the Container just contains the instructions to download and install the game. The install is stored within a mounted volume instead of a temporary one. This has the advantage of the game not redownloading every time you
restart the container or change a parameter. The first time you star the container the game is getting installed and starts afterwards. Afterwards, it just starts the allready installed game.
Feel free to fork the repository and change it to your liking.
## Updates
As soon there is a new version of the game, the server will wait untill the current game finishes. It will automatically update the game before restarting itself.
## Environment Variables
| Variable | Description | Default |
|----------------|----------------------------------------------|---------|
|`TICKRATE`| The servers tickrate. You can set it to 64 if you want to | `32` |
|`UID`| ID of the user the application runs as. See [User/Group IDs](#usergroup-ids) to better understand when this should be set. | `1000` |
|`GID`| ID of the group the application runs as. See [User/Group IDs](#usergroup-ids) to better understand when this should be set. | `1000` |
|`TOKEN`| Your API KEY - needed for publicly hosting a CS server | 'NULL' |
|`WORKSHOPTOKEN`| Your Steam workshop API KEY - needed for accessing Workshop maps | 'NULL' |
|`CSGO_HOSTNAME`| Enter the name of your CS server | 'NULL' |
|`MAXPLAYERS`| Enter the maximum number of players beeing able to join | '10' |
|`GAMETYPE`| Gametype - take a look at the CS wiki | '0' |
|`GAMEMODE`| Gamemode - take a look at the CS wiki | '1' |
|`MAPGROUP`| Default mapgroup | 'mg_bomb' |
|`STARTMAP`| Default map | 'de_dust' |
|`RCONPW`| Enter a RCON pw to controll the servers console in game | 'NULL' |
|`PW`| Enter a pw being needed to join | 'NULL' |
|`REGION`| Enter servers region | '3' |
## docker-compose.yml
Here is an example of a `docker-compose.yml` file that can be used with
[Docker Compose](https://docs.docker.com/compose/overview/).
Make sure to adjust according to your needs.
The file can be found within the repository and is getting cloned within it.
Therefore: docker-compose up should work out of the box.
```
version: '3'
services:
csgo-server:
container_name: csgo-server
image: mayniki/csgo-server
# volumes:
# - "./cs:/home/cs"
ports:
- "27015:27015/udp"
- "27015:27015/tcp" # Needed for RCON
environment:
- TICKRATE=128 # Set to 64 ticks by default
# - UID=
# - GID=
# - TOKEN= # Include your CS:GO API key
# - WORKSHOPTOKEN= # Needed to download workshop content
# - CSGO_HOSTNAME=
# - MAXPLAYERS=
# - GAMETYPE=
# - GAMEMODE=
# - MAPGROUP=
# - STARTMAP=
# - RCONPW= # Set your RCON password here!
# - PW= # Set if password should be requiered to join
# - REGION=
restart: unless-stopped
stdin_open: true
tty: true
```
## Configuration template
Use `server.cfg.template` to add anything you'd like to include in the server
configuration. Variables will be replaced accordingly. This requires you to build the container yourself from this repository.