Usage¶
Shortcuts¶
Fullscreen: Control + Shift + F or Fullscreen Button
Remote (Game) Cursor Lock: Ctrl + Shift + LeftClick
Open Side Menu: Ctrl + Shift + M or Side Button
Fullscreen mode is available with the shortcut Control + Shift + F, or by pressing the fullscreen button in the configuration menu. Press Escape for at least two seconds to exit fullscreen mode.
The cursor can be locked into the web interface using Control + Shift + Left Click in web browsers supporting the Pointer Lock API. Press Escape to exit this remote cursor mode. This remote cursor capability is useful for most games or graphics applications where the cursor must be confined to the remote screen.
The configuration menu is available by clicking the small button on the right side of the interface with the fullscreen turned off, or by using the shortcut Control + Shift + M.
Clipboard¶
Clipboard synchronization works in both directions and is supported across Chromium, Firefox, and Safari (a valid HTTPS context, or localhost, is still required by browsers).
- Paste into the session:
Ctrl + V(Cmd + Von macOS) sends your local clipboard to the remote session. - Copy from the session:
Ctrl + C(Cmd + Con macOS) reads the remote session's current clipboard back to your browser. On Firefox and Safari the client requests the latest server clipboard and writes it once it arrives, falling back to a synchronous copy when the browser blocks the asynchronous clipboard API.
Image (binary) clipboard contents can also be transferred when binary clipboard support is enabled (see enable_binary_clipboard). Larger contents are sent in multiple parts automatically.
Clipboard behaviour is controlled by the server options SELKIES_CLIPBOARD_ENABLED, SELKIES_CLIPBOARD_IN_ENABLED (paste into session), SELKIES_CLIPBOARD_OUT_ENABLED (copy from session), and SELKIES_ENABLE_BINARY_CLIPBOARD (image clipboard). The matching client settings clipboard_in_enabled, clipboard_out_enabled, and enable_binary_clipboard can be toggled per browser.
Command-Line Options and Environment Variables¶
Use selkies --help for all command-line options.
Every command-line option has a matching environment variable, formed by capitalizing the option and prepending SELKIES_ (such as SELKIES_VIDEO_BITRATE for --video-bitrate). The full list of settings, their flags, environment variables, and defaults is defined in src/selkies/settings.py.
SELKIES_VIDEO_BITRATE is in kilobits per second (kbps), range 100-1000000, default 8000 (8 Mbps); no unit multiplier is applied, e.g. 4000 is 4 Mbps. (Prior releases interpreted the same value as megabits per second — existing configs must be multiplied by 1000.)
Configuring Encoders, Display Capture, or Transport Protocols¶
CI/CD Build¶
We use Docker® containers for building every commit. The root directory Dockerfile and Dockerfiles within the addons directory provide directions for building each component, so that you may replicate the procedures in your own setup even without Docker® by copying the commands to your own shell.