Quick Start¶
This is the shortest path from nothing to a server other players can join. It uses the container image, which is the recommended way of installing a server on linux. You need Docker or Podman installed. Everything else is downloaded for you on the first start.
Running on Windows
If you are trying to run the server on windows, see On Windows
1. Create a folder¶
Pick a location that can hold a few gigabytes and create a folder for your server.
2. Add a compose file¶
services:
server:
image: ghcr.io/replayre/server
restart: unless-stopped
stop_grace_period: 30s
stdin_open: true
tty: true
ports:
# cfg/server.cfg is overruled by these
- "${GAME_PORT:-20770}:${GAME_PORT:-20770}/udp"
- "${GAME_PORT:-20770}:${GAME_PORT:-20770}/tcp"
- "${VOIP_PORT:-20771}:${VOIP_PORT:-20771}/udp"
- "${VOIP_PORT:-20771}:${VOIP_PORT:-20771}/tcp"
environment:
# settings are applied on every start
CHANNEL: "stable"
AUTO_UPDATE: "true"
RESTART_AFTER_UPDATE: "auto"
GAME_PORT: "${GAME_PORT:-20770}"
VOIP_PORT: "${VOIP_PORT:-20771}"
volumes:
- server-data:/srv
- ./cfg:/srv/cfg
- ./logs:/srv/logs
- ./ugc:/srv/data/ugc
volumes:
server-data:
The restart line is important. A server that updates itself has to be
able to stop and come back, and in a container that is the job of the
restart policy. See Updates.
3. Start it¶
The first start downloads the server files into the server-data volume and
creates cfg/server.cfg from a bundled example. When it finishes you can
read the log to confirm the server is up:
Look for a line naming the address the server is listening on. Then rename
your server by editing cfg/server.cfg and restarting:
4. Allow LAN players to join¶
Players on your local network can connect right away. You can connect to server running on the default port on your local machine using the Connect to Local Server button (see Connecting).
If you want to connect to local server on a different machine in your LAN, use the console
You need to open or forward the ports listed in the compose file above. See Networking & Ports.
5. Adding your server to the server list¶
If you want to add your server to the global server list, follow the instructions to obtain a server key here Registering a server.
Edit your server.cfg and add it like:
sv_lan
If you want to temporarely hide your server from the server list you can always specify sv_lan true, even
if you have a sv_server_key configured. This is also useful if a locally hosted server is temporarely not able to reach
the internet, but you want to continue playing.
If you want to keep your server registered but still hide it, use sv_hide
If you want to change the endpoint that is listed in the server list, use:
Warning
When setting sv_endpoint to a local address like 127.0.0.1, your server will appear in the server
list. It cannot be joined except from your local machine in that case, but it is still advertised
Use sv_hide if you want it to not be listed, but still registered in the server list.
This can be useful for a local development server that still gives you access to the user identity system
If you want to enhance your privacy further, use sv_privacy and a generic server name + description
Next steps¶
- Configuration for regions, DLC level and update channel
- Managing to reach the server console and read logs
- Adding bundles to load custom game modes