Documentation

A Relay is the public entry you create for a service. Choose its entry protocol, connect a local target through a Connector, and select an access policy.

The current target type is Local service. Remote URL targets, general-purpose proxying, and bring-your-own infrastructure (BYO) are not available.

Before you create a Relay

Have a service running on the same machine as an approved Connector. For example, an HTTP service might listen on 127.0.0.1:3000. Check the service on that machine before using it as a target.

Connectors make outbound connections from your machine. A Site groups those machines; it does not change the Relay's entry, target or policy. Use the Connectors section when you need to install or approve a machine. Installation depends on the deployment's download host and enrollment services being configured.

Viastead is a product preview. A saved configuration does not by itself mean that traffic is flowing. The console shows the prerequisites and availability for your workspace.

1. Choose the entry

Open Relays and choose Create relay. Give it a name that identifies the service, then choose an available entry protocol.

• HTTP uses a managed public web address. The workspace needs an available HTTP domain.
• TCP uses an assigned public hostname and port. It requires an eligible paid workspace, an available TCP allowance, and a ready deployment. Free does not include TCP.

The entry is where visitors connect. Its availability is separate from the local target being reachable.

2. Connect a Local service target

Choose the Connector on the machine running your service, then enter the local host and port.

For the current creation flow, use a loopback address such as 127.0.0.1 and the port your service listens on. The target is resolved from the Connector's machine, so 127.0.0.1 refers to that machine, not the visitor's computer.

This flow does not accept a remote URL as a target. It does not configure an arbitrary upstream proxy, a LAN target, or BYO relay infrastructure. A Local service target also requires a Connector; it is not a direct connection from Viastead to any URL you enter.

3. Choose an access policy

Select who should be allowed to use the Relay. Create a compatible policy in the Access section if you do not have one yet.

TCP supports Public and IP allowlist policies. Passcode, OAuth and Consent-only policies apply to HTTP; HTTP policy enforcement is not live yet. Do not treat a saved HTTP policy as evidence that visitors are being checked.

An access request remains a separate decision made by the invited person. A Relay label does not change what that person is being asked to approve.

Review before publishing

Creation saves a draft. Review the local target and proposed public address, then explicitly confirm exposure. Creating a Relay does not skip that confirmation, approve a Connector, or make an unavailable deployment ready.

If an entry or target is unavailable, resolve the prerequisite shown in the console before continuing. Traffic remains subject to the workspace plan, quota and operational state.

Names in the API and earlier guides

The earlier Quickstart, CLI reference, FAQ and product reference remain available. They retain their original terminology and preview limitations; this guide describes the current Relay workflow.