Package `vnc`

VNC WebSocket URL resolution. Resolves WebSocket URLs for VNC sessions running inside containers, enabling remote desktop access to sandbox environments.

Interface

type VNC interface {
    URL(ctx context.Context, containerID string) (string, error)
    Ping(ctx context.Context, containerID string) error
}

Implementations

Implementation	Constructor	Mode	URL Pattern
Remote	`NewRemote(host, port, hc)`	Via Tai VNC router	`ws://tai-host:6080/vnc/{containerID}/ws`
Local	`NewLocal(sb)`	Direct host port lookup	`ws://127.0.0.1:{hostPort}/ws`

Constructors

NewRemote

func NewRemote(host string, port int, hc *http.Client) VNC

Creates a VNC that routes through Tai's VNC WebSocket router.

host — Tai server hostname/IP
port — Tai VNC router port (default 6080)
hc — custom HTTP client for Ping, nil uses http.DefaultClient

NewLocal

func NewLocal(sb sandbox.Sandbox) VNC

Creates a VNC that resolves URLs by inspecting the container's port mappings. Looks for container port 6080 (the standard noVNC port) in the port mappings.

Returns an error if port 6080 is not mapped. On macOS and Windows (Docker Desktop), the Local sandbox automatically maps port 6080 when CreateOptions.VNC is true.

Methods

URL

URL(ctx context.Context, containerID string) (string, error)

Returns a WebSocket URL for connecting to the container's VNC session.

Remote: ws://tai-host:6080/vnc/abc123/ws Local: ws://127.0.0.1:32769/ws

Ping

Ping(ctx context.Context, containerID string) error

Checks if the VNC endpoint is reachable by making an HTTP GET request to the WebSocket URL. Useful for verifying that the VNC server inside the container is ready before connecting a client.

Remote: sends GET to http://tai-host:6080/vnc/{containerID}/ws
Local: resolves the host port via Inspect, then sends GET

Example

c, _ := tai.New("tai://192.168.1.100")
defer c.Close()

// Create a sandbox with VNC enabled
id, _ := c.Sandbox().Create(ctx, sandbox.CreateOptions{
    Name:  "desktop",
    Image: "yaoapp/sandbox-claude:latest",
    VNC:   true,
})
c.Sandbox().Start(ctx, id)

// Wait for VNC to be ready
for i := 0; i < 10; i++ {
    if err := c.VNC().Ping(ctx, id); err == nil {
        break
    }
    time.Sleep(time.Second)
}

// Get the WebSocket URL for a noVNC client
url, _ := c.VNC().URL(ctx, id)
fmt.Println(url) // ws://192.168.1.100:6080/vnc/desktop/ws

2.5 KiB Raw Blame History

Package vnc