The server can be configured with many options, either from a terminal or with the help of the launcher.
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:
Path to a session file (.json). All clients connecting the server will load it.
Path to a state file (.state). All clients connecting the server will load it.
Path to a custom module file (.js).
WARNING: custom module can access the file system, use at your own risk.
HTTP port for the server (default:
OSC (UDP) input port (default:
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:
Print sent and received messages in the console. This may impact performance and should not be enabled in production.
Disable built-in client window.
Start the built-in client window in fullscreen.
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 expression.
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
Set file browsing root folder. Prevent writing files outside of this 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)
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
Define the built-in client window position, must be a pair of integers separated by a comma (
Define the built-in client window size, must be a pair of integers separated by a comma (
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.
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]