WebTTY

WebTTY is a client and server protocol that provides terminal access to remote machines through rstream. It is designed to work well in constrained networks and private environments where inbound connectivity is not available.

WebTTY is typically paired with rstream tunnels so that authentication, encryption, and access controls are enforced by the edge network. This makes WebTTY suitable for fleet management workflows, lab environments, and remote device administration.

Running a server from the CLI

The CLI provides a reference server implementation:

rstream webtty server

By default the server listens locally on :6002.

When started with --web, the server is exposed through a published HTTP tunnel. The CLI creates a tunnel with fixed properties, including publish=true, protocol=http, http_version=http/1.1, and token_auth=true, and it attaches default WebTTY labels.

rstream webtty server --web

Connecting with a client

The CLI provides a WebTTY client that connects to a server URL and runs a remote command or interactive session:

rstream webtty client --url ws://127.0.0.1:6002