diff --git a/SignallingWebServer/platform_scripts/bash/common.sh b/SignallingWebServer/platform_scripts/bash/common.sh index 578282a90..225705f9c 100644 --- a/SignallingWebServer/platform_scripts/bash/common.sh +++ b/SignallingWebServer/platform_scripts/bash/common.sh @@ -6,8 +6,8 @@ NODE_VERSION=$(<"${SCRIPT_DIR}/../../../NODE_VERSION") function print_usage() { echo " Script usage: - ${0} [--help] [--publicip ] [--turn ] [--stun ] -- [server options...] - Where: + start.sh [script options...] -- [server options...] + Script options: --help Print this message and stop this script. --debug Run all scripts with --inspect --nosudo Run all scripts without \`sudo\` command useful for when run in containers. @@ -28,7 +28,7 @@ function print_usage() { --build-wilbur Force build of wilbur --deps Force reinstall of dependencies - Other options: stored and passed to the server. All parameters printed once the script values are set. + Anything after -- is passed directly to the signalling server. Command line options might be omitted to run with defaults and it is a good practice to omit specific ones when just starting the TURN or the STUN server alone, not the whole set of scripts. " if [[ -d "${SCRIPT_DIR}/../../dist/" ]]; then diff --git a/SignallingWebServer/platform_scripts/cmd/common.bat b/SignallingWebServer/platform_scripts/cmd/common.bat index f4527aa44..062326849 100644 --- a/SignallingWebServer/platform_scripts/cmd/common.bat +++ b/SignallingWebServer/platform_scripts/cmd/common.bat @@ -14,8 +14,8 @@ GOTO :eof :Usage echo. echo Usage: -echo %0 [--help] [--publicip ^] [--turn ^] [--stun ^] -- [server options...] -echo Where: +echo start.bat [script options...] -- [server options...] +echo Script options: echo --help Print this message and stop this script. echo --publicip Define public ip address (using default port) for turn server, syntax: --publicip ; it is used for echo Default value: Retrieved from 'curl https://api.ipify.org' or if unsuccessful then set to 127.0.0.1. It is the IP address of the server and the default IP address of the TURN server @@ -32,7 +32,7 @@ echo --rebuild Force a rebuild of everything echo --build-libraries Force a rebuild of shared libraries echo --build-wilbur Force build of wilbur echo --deps Force reinstall of dependencies -echo Other options: stored and passed to the server. +echo Everything after -- is passed directly to the signalling server executable. IF exist "%SCRIPT_DIR%..\..\dist" ( pushd %SCRIPT_DIR%..\.. call %NPM% run start --- --help