Skip to content

Server configuration

The server can be configured with many options, either from a terminal or with the help of the launcher.

Options

Defines the default osc/midi targets. These will be added to the widget's individual targets. Targets must be separated by a space and formatted as follows:

  • ip_address:port
  • host_name:port
  • midi:device_name

Path to a session file. All clients connecting the server will load it.

Path to a state file. All clients connecting the server will load it.

Path to a custom module file. Additional options can be passed after the path, they'll be accessible in the custom module's context.

HTTP port for the server (default: 8080).

OSC (UDP) input port (default: port).

OSC (TCP) input port.

TCP servers to connect to. When sending osc messages, if the target matches one of these, TCP protocol will be used instead of UDP. Targets must be separated by a space and formatted as follows:

  • ip_address:port
  • host_name:port

MIDI options separated by spaces, MIDI support must be enabled, see MIDI configuration.

Print sent and receiced messages in the console. This may impact performances and should not be enabled in production.

Disable built-in client window.

Start the built-in client window in fullscreen.

Theme names or paths. See Themes.

Default client options, separated by spaces.

Disable built-in client window's vertical synchronization.

Disable built-in client window's gpu blacklist (may improve rendering performance in some cases).

Disable session editing, and file saving.

Disable file saving for hosts that don't match the regular expresion.

Sessions are saved and opened on the server's filesystem. It is possible to limit this feature to specific client with a regular expression. For example, "127.0.0.1|192.168.0.10" disables remote saving except for clients with ip addresses 127.0.0.1 (the server's local address) and 192.168.0.10.

Set file browsing root folder.

Restrict access to user:password (remote clients will be prompted for these credentials).

Server's name on zeroconf/bonjour network. Incremented automatically if not available.

Use HTTPS protocol instead of HTTP (a self-signed certificate will be created)

Command-line options

The following options can only be set from a terminal.

Disable hardware acceleration for the launcher window and the built-in client window.

Enable node inspector.

Override default cache directory (contains browser cache and localStorage data).

Override default config file location (contains session history and launcher config). Defaults to cache-dir/config.json.

Show help.

Serve documentation website locally and open it with the system\'s default browser

Show version number.

Running in a terminal#

Options name must be prepended with a double dash (--) in a terminal.

Example

open-stage-control --no-gui --load path/to/your/session.json --theme path/to/your/theme.css

Launches the server in headless mode, and makes all clients load provided session and theme automatically.

Running in a terminal on Windows#

Windows users launching the app from a terminal need to add a double dash (--) and a space before their options:

open-stage-control.exe -- --port 5555 [...]

# when running from sources
npm start -- -- [options]