Skip to content

Latest commit

 

History

History
78 lines (63 loc) · 4.63 KB

README.md

File metadata and controls

78 lines (63 loc) · 4.63 KB
Raw

Code Quality Docker Build Status Docker Stars Docker Pulls Discord

Supported tags and respective Dockerfile links

What is Team Fortress 2?

Nine distinct classes provide a broad range of tactical abilities and personalities. Constantly updated with new game modes, maps, equipment and, most importantly, hats! This Docker image contains the dedicated server of the game.

TF2

logo

How to use this image

Hosting a simple game server

Running on the host interface (recommended):

$ docker run -d --net=host --name=tf2-dedicated -e SRCDS_TOKEN={YOURTOKEN} cm2network/tf2

Running using a bind mount for data persistence on container recreation:

$ mkdir -p $(pwd)/tf2-data
$ chmod 777 $(pwd)/ctf2-data # Makes sure the directory is writeable by the unprivileged container user
$ docker run -d --net=host -v $(pwd)/tf2-data:/home/steam/tf-dedicated/ --name=tf2-dedicated -e SRCDS_TOKEN={YOURTOKEN} cm2network/tf2

Running multiple instances (increment SRCDS_PORT and SRCDS_TV_PORT):

$ docker run -d --net=host --name=tf2-dedicated2 -e SRCDS_PORT=27016 -e SRCDS_TV_PORT=27021 -e SRCDS_TOKEN={YOURTOKEN} cm2network/tf2

SRCDS_TOKEN is required to be listed & reachable; https://steamcommunity.com/dev/managegameservers

SRCDS_WORKSHOP_AUTHKEY is required to use the workshop; https://steamcommunity.com/dev/apikey

It's also recommended to use "--cpuset-cpus=" to limit the game server to a specific core & thread.
The container will automatically update the game on startup, so if there is a game update just restart the container.

Configuration

Environment Variables

Feel free to overwrite these environment variables, using -e (--env):

SRCDS_RCONPW="changeme" (value can be overwritten by tf/cfg/server.cfg) 
SRCDS_PW="changeme" (value can be overwritten by tf/cfg/server.cfg) 
SRCDS_PORT=27015
SRCDS_TV_PORT=27020
SRCDS_NET_PUBLIC_ADDRESS="0" (public facing ip, useful for local network setups)
SRCDS_IP="0" (local ip to bind)
SRCDS_FPSMAX=300
SRCDS_TICKRATE=66
SRCDS_MAXPLAYERS=14
SRCDS_REGION=3
SRCDS_HOSTNAME="New TF Server" (first launch only)
SRCDS_WORKSHOP_START_MAP=0
SRCDS_HOST_WORKSHOP_COLLECTION=0
SRCDS_WORKSHOP_AUTHKEY="" (required to use host_workshop_map)

Config

You can edit the config using this command:

$ docker exec -it tf2-dedicated nano /home/steam/tf-dedicated/tf/cfg/server.cfg

If you want to learn more about configuring a TF2 server check this documentation.

Image Variants:

The tf2 images come in three flavors, each designed for a specific use case.

tf2:latest

This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is a bare-minimum TF2 dedicated server containing no 3rd party plugins.

tf2:metamod

This is a specialized image. It contains the plugin environment Metamod:Source which can be found in the addons directory. You can find additional plugins here.

tf2:sourcemod

This is another specialized image. It contains both Metamod:Source and the popular server plugin SourceMod which can be found in the addons directory. SourceMod supports a wide variety of additional plugins that can be found here.