Feature: Allow custom ports (#5)

* add variable ports to startup

* Add environment variables for PORT and QUERYPORT

* drop plain `docker` command, add port customization

* Rename docker-compose.example to docker-compose.yml

* Added notes on customizing ports and clarified default port settings.

* fix variable

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

Author: EvilOlaf

README.md

@@ -13,20 +13,43 @@
 
 ### Requirements
 
-- Docker.io, with or without docker compose
+- Docker.io with *docker compose*
 - 8GB memory (absolute bare minimum, COULD work if a swap-file is present but let's be honest, won't be fun. Get 16GB or at least 12GB)
 
 ### How to use
 
-Plain docker command:  
+- Grab the `docker-compose.yml`
+- run `docker compose up -d` and **be patient**[^1]
+- Fire up your SCUM game and connect either without port or port 7779
+
+Note: Don't want to use *docker compose*? Check https://www.decomposerize.com/
 
-```bash
-docker run --name scum-server -p 7777:7777/udp -p 7777:7777/tcp -p 7778:7778/udp -p 7778:7778/tcp -p 7779:7779/udp -p 7779:7779/tcp -p 27015:27015/udp -p 27015:27015/tcp -v ./scumserver-data:/opt/scumserver --restart unless-stopped ghcr.io/evilolaf/scum:latest
-```
 
-**or**
+### How to customize ports
 
-`docker compose` using the example file.
+Defaults:
+- `PORT=7777` and therefore (as per SCUM server's weird way to assign ports) also **7778** and **7779**
+- `QUERYPORT=27015`
+
+When `PORT` or `QUERYPORT` are altered this change MUST reflect the port mapping as well.  
+
+**Example for ports 10000 and 20000**: 
+```yml
+    environment:
+      - PORT=10000
+      - QUERYPORT=20000
+    ports:
+      - "10000:10000/udp"
+      - "10000:10000/tcp"
+      - "10001:10001/udp"
+      - "10001:10001/tcp"
+      - "10002:10002/udp"
+      - "10002:10002/tcp"
+      - "20000:20000/udp"
+      - "20000:20000/tcp"
+```
+
+You SCUM game now needs port **10002** for connection.
 
 
 ## Non-technical
@@ -39,3 +62,8 @@ Reverse-engineered version of j0s0n/scum-wine Docker image...
 ### Who?
 All credit for the initial work goes to j0s0n.
 
+### Footnotes
+I am certain some port exposures are unnecessary. However, I could not find clear documentation on which ports and protocols are required. The SCUM server's port calculation behavior doesn't help either.  
+Exposing additional ports should not cause any harm.
+
+[^1]: Use `docker compose logs` to check the process. Once you see something like `scum-server  | LogBattlEye: Display: Config entry: MasterPort 8037` in the logs, your game server should be ready to accept player connections.

docker-compose.example docker-compose.ymldocker-compose.example renamed to docker-compose.yml

@@ -2,6 +2,9 @@ services:
   scum-server:
     image: ghcr.io/evilolaf/scum:latest
     container_name: scum-server
+    environment:
+      - PORT=7777
+      - QUERYPORT=27015
     ports:
       - "7777:7777/udp"
       - "7777:7777/tcp"

start-server.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 set -e
 
-echo "Installing/updating SCUM dedicated server..."
+echo "Installing/updating steamcmd and SCUM dedicated server..."
 /opt/steamcmd/steamcmd.sh +@sSteamCmdForcePlatformType windows \
   +force_install_dir /opt/scumserver \
   +login anonymous \
@@ -12,6 +12,6 @@ echo "Starting SCUM dedicated server..."
 xvfb-run --auto-servernum --server-args="-screen 0 1024x768x24" \
   wine /opt/scumserver/SCUM/Binaries/Win64/SCUMServer.exe \
     -log \
-    -port=7777 \
-    -QueryPort=27015 \
+    -port=${PORT:-7777} \
+    -QueryPort=${QUERYPORT:-27015} \
     -MaxPlayers=32