Skip to main content

Configuration

Server

Server can be configured with the following parameters using command-line arguments or environment variables.

Port

The network port Server binds to for the API and UI.

Command-Line ArgumentEnvironment VariableDefault ValuePossible Values
--portSW_SERVER_PORT9091Any valid port number

Media Storage Root

The root folder on-disk under which recordings are stored.

Command-Line ArgumentEnvironment VariableDefault ValuePossible Values
--default-media-storage-rootSW_SERVER_DEFAULT_MEDIA_STORAGE_ROOT%APPDATA%\Second Wave Holdings Pty Ltd\Server\mediaAny valid path

Local IP

The externally accessible IP of the machine Server is running on. While the default case will try and get this from the OS APIs, there are cases where that fails (e.g. networks without DHCP) and in those cases this configuration is required.

Specifying the local IP can also be used to select the network interface that should be used for streaming when there are multiple valid NICs on a machine.

Command-Line ArgumentEnvironment VariableDefault ValuePossible Values
--local-ipSW_SERVER_LOCAL_IPThe machine's IP as retrived from OS APIs.Any valid IPv4 address

Streaming Ports

Limit the port range used for live-streaming.

Command-Line ArgumentEnvironment VariableDefault ValuePossible Values
--streaming-min-portSW_SERVER_STREAMING_MIN_PORT49152Any valid port number
--streaming-max-portSW_SERVER_STREAMING_MAX_PORT65535Any valid port number

Log Level

The level of detail in the log output.

Command-Line ArgumentEnvironment VariableDefault ValuePossible Values
--log-levelSW_SERVER_LOG_LEVELinfoerror, warn, info, debug, trace

Streamer

Streamer can be configured with the following parameters using command-line arguments or environment variables.

Server URL

The network address for Server.

Command-Line ArgumentEnvironment VariableDefault ValuePossible Values
--server-urlSW_STREAMER_SERVER_URLhttp://localhost:9091Any valid URL

Application Identifier

A unique identifier used to manage this Streamer in Server.

danger

The Application Identifier should remain consistent. Changing it will cause Server to register a new Streamer.

Command-Line ArgumentEnvironment VariableDefault ValuePossible Values
--application-idSW_STREAMER_APPLICATION_IDhostnameAny combination of letters and numbers

Display Name

The name shown in the Server UI for this Streamer.

Command-Line ArgumentEnvironment VariableDefault ValuePossible Values
--display-nameSW_STREAMER_DISPLAY_NAMEhostnameAny combination of letters and numbers

Streaming Ports

Limit the port range used for live-streaming.

Command-Line ArgumentEnvironment VariableDefault ValuePossible Values
--streaming-min-portSW_SERVER_STREAMING_MIN_PORT49152Any valid port number
--streaming-max-portSW_SERVER_STREAMING_MAX_PORT65535Any valid port number

Log Level

The level of detail in the log output.

Command-Line ArgumentEnvironment VariableDefault ValuePossible Values
--log-levelSW_STREAMER_LOG_LEVELinfoerror, warn, info, debug, trace