Merge pull request #431 from mcottontensor/sfu_docker

Dockerfile for SFU

.github/workflows/container-images.yml

@@ -31,3 +31,12 @@ jobs:
           tags: 'ghcr.io/epicgames/pixel-streaming-signalling-server:5.4'
           push: true
           file: SignallingWebServer/Dockerfile
+      -
+        name: Build and push the SFU container image
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          tags: 'ghcr.io/epicgames/pixel-streaming-sfu:5.4'
+          push: true
+          file: SFU/Dockerfile
+

README.md

@@ -45,6 +45,8 @@ The following container images are built from this repository:
 
 - [ghcr.io/epicgames/pixel-streaming-signalling-server](https://github.com/orgs/EpicGames/packages/container/package/pixel-streaming-signalling-server) (since Unreal Engine 5.1)  
 ( This link requires you to join Epic's Github org )
+- [ghcr.io/epicgames/pixel-streaming-sfu](https://github.com/orgs/EpicGames/packages/container/package/pixel-streaming-sfu) (since Unreal Engine 5.4)  
+( This link requires you to join Epic's Github org )
 
 ### NPM Packages
 The following are `unofficial` NPM packages (official ones coming soon):

SFU/Dockerfile

@@ -0,0 +1,13 @@
+# Use the current Long Term Support (LTS) version of Node.js
+FROM node:lts
+
+COPY /SFU /SFU
+
+RUN SFU/platform_scripts/bash/setup.sh
+
+ENV SIGNALLING_URL ws://localhost:8889
+
+EXPOSE 40000-49999/tcp
+EXPOSE 40000-49999/udp
+
+CMD node /SFU/sfu_server.js --signallingURL=${SIGNALLING_URL} 

SFU/README.md

@@ -57,3 +57,11 @@ Launch the streaming app with the following arguments
 This tells the Pixel Streaming plugin to stream simulcast with 3 streams, each one scaling video resolution by half. The sequence of values is as follows, `scale_down_factor,min_bitrate,max_bitrate,...repeating for each stream`
 
 When this streams to the SFU, the SFU will detect these 3 streams and then selectively stream these out to connected peers based on their connection quality.
+
+## Running the Docker image
+
+The Docker image needs to know where the signalling server to connect to is. You will need to set the `SIGNALLING_URL` environment variable to the URL for your signalling server. This URL needs to point to the configured SFU port (default 8889).
+You will also need to use the `host` network driver on docker because of the way the SFU collects and reports its available ports.
+An example for running might be as follows.
+
+```docker run -e SIGNALLING_URL=ws://192.168.1.10:8889 --network="host" ghcr.io/epicgames/pixel-streaming-sfu:5.4```

SFU/package.json

@@ -5,20 +5,20 @@
   "private": true,
   "scripts": {
     "start-local": "run-script-os --",
-      "start-local:windows": ".\\platform_scripts\\cmd\\run.bat",
-      "start-local:default": "./platform_scripts/bash/run_local.sh",
+    "start-local:windows": ".\\platform_scripts\\cmd\\run.bat",
+    "start-local:default": "./platform_scripts/bash/run_local.sh",
     "start-cloud": "run-script-os --",
-      "start-cloud:windows": ".\\platform_scripts\\cmd\\run_cloud.bat",
-      "start-cloud:default": "./platform_scripts/bash/run_cloud.sh",
+    "start-cloud:windows": ".\\platform_scripts\\cmd\\run_cloud.bat",
+    "start-cloud:default": "./platform_scripts/bash/run_cloud.sh",
     "start": "run-script-os",
-      "start:windows": "platform_scripts\\cmd\\node\\node.exe sfu_server.js",
-      "start:default": "if [ `id -u` -eq 0 ]\nthen\n export process=\"./platform_scripts/bash/node/bin/node sfu_server.js\"\nelse\n export process=\"sudo ./platform_scripts/bash/node/bin/node sfu_server.js\"\nfi\n$process "
-
+    "start:windows": "platform_scripts\\cmd\\node\\node.exe sfu_server.js",
+    "start:default": "if [ `id -u` -eq 0 ]\nthen\n export process=\"./platform_scripts/bash/node/bin/node sfu_server.js\"\nelse\n export process=\"sudo ./platform_scripts/bash/node/bin/node sfu_server.js\"\nfi\n$process "
   },
   "dependencies": {
-    "mediasoup-sdp-bridge": "file:mediasoup-sdp-bridge",
-    "ws": "^7.1.2",
     "mediasoup_prebuilt": "^3.8.4",
-    "run-script-os": "^1.1.6"
+    "mediasoup-sdp-bridge": "file:mediasoup-sdp-bridge",
+    "minimist": "^1.2.8",
+    "run-script-os": "^1.1.6",
+    "ws": "^7.1.2"
   }
 }

SFU/sfu_server.js

@@ -2,6 +2,7 @@ const config = require('./config');
 const WebSocket = require('ws');
 const mediasoup = require('mediasoup_prebuilt');
 const mediasoupSdp = require('mediasoup-sdp-bridge');
+const minimist = require('minimist');
 
 if (!config.retrySubscribeDelaySecs) {
   config.retrySubscribeDelaySecs = 10;
@@ -351,6 +352,12 @@ async function createWebRtcTransport(identifier) {
 }
 
 async function main() {
+  var argv = minimist(process.argv.slice(2));
+
+  if ('signallingURL' in argv) {
+    config.signallingURL = argv['signallingURL'];
+  }
+
   console.log('Starting Mediasoup...');
   console.log("Config = ");
   console.log(config);

SignallingWebServer/platform_scripts/bash/common_utils.sh

@@ -75,7 +75,7 @@ function use_args() {
 }
 
 function call_setup_sh() {
- bash "setup.sh"
+ bash "setup.sh" $*
 }
 
 function start_process() {

SignallingWebServer/platform_scripts/bash/run_local.sh

@@ -7,8 +7,8 @@ pushd "${BASH_LOCATION}" > /dev/null
 source common_utils.sh
 
 set_start_default_values "n" "n" # No server specific defaults
-use_args "$@"
-call_setup_sh
+use_args "$*"
+call_setup_sh $*
 print_parameters
 
 process="${BASH_LOCATION}/node/lib/node_modules/npm/bin/npm-cli.js run start:default --"
@@ -33,4 +33,5 @@ start_process $process $arguments
 
 popd > /dev/null # ../..
 
-popd > /dev/null # BASH_SOURCE
+popd > /dev/null # BASH_SOURCE
+

SignallingWebServer/platform_scripts/bash/setup.sh

@@ -7,7 +7,7 @@ pushd "${BASH_LOCATION}" > /dev/null
 
 source common_utils.sh
 
-use_args $@
+use_args $*
 # Azure specific fix to allow installing NodeJS from NodeSource
 if test -f "/etc/apt/sources.list.d/azure-cli.list"; then
 	sudo touch /etc/apt/sources.list.d/nodesource.list