Support new messaging port (#408) + validate ports at runtime

Author: wolveix

.github/ISSUE_TEMPLATE/bug_report.md

@@ -17,7 +17,7 @@ A clear and concise description of what the bug is.
 Please censor anything sensitive. Your runtime command might look like this:
 
 ```shell
-docker run --name="satisfactory" -p 7777 -v ./satisfactory:/config wolveix/satisfactory-server:latest
+docker run --name="satisfactory" -p 7777 -p 8888 -v ./satisfactory:/config wolveix/satisfactory-server:latest
 ```
 
 ### Debug Output

Dockerfile

@@ -17,6 +17,7 @@ ENV AUTOSAVENUM="5" \
     PGID="1000" \
     PUID="1000" \
     SERVERGAMEPORT="7777" \
+    SERVERMESSAGINGPORT="8888" \
     SERVERSTREAMING="true" \
     SKIPUPDATE="false" \
     STEAMAPPID="1690800" \
@@ -51,6 +52,6 @@ ARG VERSION="DEV"
 ENV VERSION=$VERSION
 LABEL version=$VERSION
 STOPSIGNAL SIGINT
-EXPOSE 7777/udp 7777/tcp
+EXPOSE 7777/udp 7777/tcp 8888/tcp
 
 ENTRYPOINT [ "/init.sh" ]

README.md

@@ -50,8 +50,9 @@ docker run \
 --env STEAMBETA=false \
 --memory-reservation=4G \
 --memory 8G \
---publish 7777:7777/udp \
 --publish 7777:7777/tcp \
+--publish 7777:7777/udp \
+--publish 8888:8888/tcp \
 wolveix/satisfactory-server:latest
 ```
 
@@ -84,8 +85,9 @@ services:
     hostname: 'satisfactory-server'
     image: 'wolveix/satisfactory-server:latest'
     ports:
-      - '7777:7777/udp'
       - '7777:7777/tcp'
+      - '7777:7777/udp'
+      - '8888:8888/tcp'
     volumes:
       - './satisfactory-server:/config'
     environment:
@@ -165,7 +167,8 @@ helm install satisfactory k8s-at-home/satisfactory -f values.yaml
 | `MULTIHOME`             |   `::`    | set the server's listening interface (usually not needed) |
 | `PGID`                  |  `1000`   | set the group ID of the user the server will run as       |
 | `PUID`                  |  `1000`   | set the user ID of the user the server will run as        |
-| `SERVERGAMEPORT`        |  `7777`   | set the game's port                                       |
+| `SERVERGAMEPORT`        |  `7777`   | set the game's server port                                |
+| `SERVERMESSAGINGPORT`   |  `8888`   | set the game's messaging port                             |
 | `SERVERSTREAMING`       |  `true`   | toggle whether the game utilizes asset streaming          |
 | `SKIPUPDATE`            |  `false`  | avoid updating the game on container start/restart        |
 | `STEAMBETA`             |  `false`  | set experimental game version                             |
@@ -202,7 +205,8 @@ services:
     command: 'your-ftp-user:your-ftp-password:1000'
 ```
 
-With this, you'll be able to SFTP into your server and access your game files via `/home/your-ftp-user/satisfactory-server/gamefiles`.
+With this, you'll be able to SFTP into your server and access your game files via
+`/home/your-ftp-user/satisfactory-server/gamefiles`.
 
 ## How to Improve the Multiplayer Experience
 
@@ -245,8 +249,9 @@ services:
         GID: 1001  # Your desired GID
     user: "1001:1001"  # Must match UID:GID above
     ports:
-      - '7777:7777/udp'
       - '7777:7777/tcp'
+      - '7777:7777/udp'
+      - '8888:8888/tcp'
     volumes:
       - './satisfactory-server:/config'
     environment:

cluster/service.yaml

@@ -13,13 +13,17 @@ spec:
 # might be necessary for your cluster:
 #  loadBalancerIP: <external-IP>
   ports:
+    - name: "api"
+      port: 7777
+      protocol: TCP
+      targetPort: 7777
     - name: "game"
       port: 7777
       protocol: UDP
       targetPort: 7777
-    - name: "api"
-      port: 7777
+    - name: "messaging"
+      port: 8888
       protocol: TCP
-      targetPort: 7777
+      targetPort: 8888
   selector:
     app: satisfactory

cluster/statefulset.yaml

@@ -37,6 +37,9 @@ spec:
             - name: "game"
               containerPort: 7777
               protocol: UDP
+            - name: "messaging"
+              containerPort: 8888
+              protocol: TCP
           volumeMounts:
             - name: satisfactory-config
               mountPath: /config

docker-compose.yml

@@ -4,8 +4,9 @@ services:
     hostname: 'satisfactory-server'
     image: 'wolveix/satisfactory-server:latest'
     ports:
-      - '7777:7777/udp'
       - '7777:7777/tcp'
+      - '7777:7777/udp'
+      - '8888:8888/tcp'
     volumes:
       - './satisfactory-server:/config'
     environment:

run.sh

@@ -2,6 +2,19 @@
 
 set -e
 
+# Port validation
+if ! [[ "$SERVERGAMEPORT" =~ $NUMCHECK ]]; then
+    printf "Invalid server port given: %s\\n" "$SERVERGAMEPORT"
+    SERVERGAMEPORT="7777"
+fi
+printf "Setting server port to %s\\n" "$SERVERGAMEPORT"
+
+if ! [[ "$SERVERMESSAGINGPORT" =~ $NUMCHECK ]]; then
+    printf "Invalid messaging port given: %s\\n" "$SERVERMESSAGINGPORT"
+    SERVERMESSAGINGPORT="8888"
+fi
+printf "Setting messaging port to %s\\n" "$SERVERMESSAGINGPORT"
+
 # Engine.ini settings
 if ! [[ "$AUTOSAVENUM" =~ $NUMCHECK ]]; then
     printf "Invalid autosave number given: %s\\n" "$AUTOSAVENUM"
@@ -135,7 +148,7 @@ fi
 cd /config/gamefiles || exit 1
 
 chmod +x FactoryServer.sh || true
-./FactoryServer.sh -Port="$SERVERGAMEPORT" "${ini_args[@]}" "$@" &
+./FactoryServer.sh -Port="$SERVERGAMEPORT" -ReliablePort="$SERVERMESSAGINGPORT" "${ini_args[@]}" "$@" &
 
 sleep 2
 satisfactory_pid=$(ps --ppid ${!} o pid=)

ssl/README.md

@@ -11,8 +11,9 @@ services:
     hostname: 'satisfactory-server'
     image: 'wolveix/satisfactory-server:latest'
     ports:
-      - '7777:7777/udp'
       - '7777:7777/tcp'
+      - '7777:7777/udp'
+      - '8888:8888/tcp'
     volumes:
       - './satisfactory-server:/config'
       - './certs/live/${DOMAIN}/fullchain.pem:/config/gamefiles/FactoryGame/Certificates/cert_chain.pem'

ssl/docker-compose.yml

@@ -4,8 +4,9 @@ services:
     hostname: 'satisfactory-server'
     image: 'wolveix/satisfactory-server:latest'
     ports:
-      - '7777:7777/udp'
       - '7777:7777/tcp'
+      - '7777:7777/udp'
+      - '8888:8888/tcp'
     volumes:
       - './satisfactory-server:/config'
       - './certs/live/${DOMAIN}/fullchain.pem:/config/gamefiles/FactoryGame/Certificates/cert_chain.pem'