Skip to content

Tweaks to script help output. #669

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 4, 2025
Merged

Tweaks to script help output. #669

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a9c6b74
chore(platform_scripts): Updating windows help text.
mcottontensor Jun 3, 2025
9ae5042
chore(platform_scripts): Updating helper script help text.
mcottontensor Jun 3, 2025
b0ebf0a
chore(platform_scripts): Removed accidental commit.
mcottontensor Jun 3, 2025
18283e5
chore(platform_scripts): Trying to fix windows line endings.
mcottontensor Jun 3, 2025
2b51035
Merge branch 'ongoing_scripts' of github-work:mcottontensor/PixelStre…
mcottontensor Jun 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions SignallingWebServer/platform_scripts/bash/common.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ NODE_VERSION=$(<"${SCRIPT_DIR}/../../../NODE_VERSION")
function print_usage() {
echo "
Script usage:
${0} [--help] [--publicip <IP Address>] [--turn <turn server>] [--stun <stun server>] -- [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.
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions SignallingWebServer/platform_scripts/cmd/common.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ GOTO :eof
:Usage
echo.
echo Usage:
echo %0 [--help] [--publicip ^<IP Address^>] [--turn ^<turn server^>] [--stun ^<stun server^>] -- [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
Expand All @@ -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
Expand Down
Loading