Skip to main content

Quick Start

This walks through a first connection. It assumes Waylo is installed and an OpenSSH server is running on the host.

1. Start the server​

The installer sets Waylo up as a systemd user service, so it is already running:

systemctl --user status waylo     # check
systemctl --user restart waylo    # after changing options

If you installed with --no-service, run the server out of the install prefix instead:

~/.local/share/waylo/runtime/node ~/.local/share/waylo/server/index.js

Either way you'll see a banner confirming the server is listening, e.g. https://localhost:8080 — TLS is on by default.

2. Open a browser​

Navigate to the host on the chosen port:

https://<host>:8080/

For local testing that's https://localhost:8080/. The certificate is self-signed, so the browser warns the first time — accept it to continue, or use the desktop client, which pins the fingerprint instead. For remote access, reach the host over SSH port-forwarding or a VPN rather than exposing the port directly — see Security.

3. Log in​

On the login screen:

  • Enter the Linux username and password of the host's desktop user. Only the session owner (with sudo) can connect; credentials are verified over SSH.
  • Pick a frame rate and quality to match your link (both can be changed later from the toolbar). See Performance.
  • Optionally tick Set up unattended access to configure auto-login and the locked-screen extension — see Unattended Access.

Click Login. The desktop appears within a second or two.

4. Take control​

  • Click the video to capture the pointer.
  • Press Esc (or Ctrl+M) to release it.
  • Type, scroll, and click as normal while the pointer is captured.
  • Use the toolbar (slides down from the top center) to switch monitors, toggle fullscreen, mute audio, lock the screen, or disconnect.

That's it — you're driving the real GNOME session. See Input & Monitors for pointer capture, multi-monitor, and touch details, and Clipboard, Audio & Files for copy/paste, sound, and file transfer.