Get started
Create a workspace, install the Roomler agent on Windows, macOS or Linux, and reach your first machine from a browser tab.
Getting to a working setup is three things: a workspace, an agent on a machine, and an enrollment token that ties the two together.
- Create a workspace. Sign up and name your organization — the name labels every device and invite.
- Mint an enrollment token. In the dashboard, go to Devices → Enroll device. Tokens are single-use and short-lived.
- Install the agent on the machine you want to reach, pasting the token into the command. One line, or a graphical installer.
- Open the machine from the Devices list. Its screen appears in a browser tab.
Start with the machine you are sitting at
It is the fastest way to see the whole loop work, and you can remove the device afterwards. A browser controlling its own host does produce an infinite mirror effect — that is expected, not a fault.
Pick your operating system
The installers differ enough per platform — service model, permissions, elevation — that each OS has its own page rather than a shared page with footnotes.
Windows
— MSI or one-line PowerShell. Per-user, per-machine, or a SYSTEM service that survives the lock screen.
macOS
— A signed .pkg. Needs two privacy grants, and the mesh needs a second enrollment.
Linux
— .deb or tarball with a systemd unit. Works headless, in containers, and on cluster nodes.
In this section
What is Roomler?
Roomler is a browser-based remote desktop and a private WireGuard-style mesh network on one self-hostable agent, with team chat and video included.
Quickstart
Create a workspace, enroll your first machine with a one-line installer, and open its screen in a browser tab — in about five minutes.
Install on Windows
Install the Roomler agent on Windows with the signed MSI, the setup wizard or one PowerShell line — and pick the right service mode for your machine.
Install on macOS
Install the Roomler agent on macOS, grant the two privacy permissions it needs, and add the root half if you want the machine on the private mesh.
Install on Linux
Install the Roomler agent on Linux with one command — as a root systemd service or a per-user unit — including headless servers, containers and cluster nodes.
Enrollment and device identity
How an enrollment token turns a machine into a device row, what machine identity means, and how re-installing or removing a device behaves.
Install the tunnel CLI only
Install just the roomler command-line client on a machine you sit at, to open port forwards and a SOCKS5 proxy without running the full agent.
Self-hosting Roomler
Run the whole Roomler server yourself with one compose file and a published container image — accounts, signalling, chat, conferencing and relays.
Verify your install
Confirm the Roomler agent is running, enrolled, reachable and on the mesh — and verify the artifact you installed was really signed by us.