Home › Tutorials › Upstream & Remote
Upstream & Remote

Connecting to Upstream

#095 0:14 Part of the Rysh video series

Point Rysh at a workspace URL and an API key -- now your session can join the hub.

Connecting to Upstream — 0:14 walkthrough

What you'll see

  1. cat rysh.config to show the [upstream] block: enabled, url, api_key.
  2. Launch rysh --shared to auto-share the first pane on boot.
  3. Double-Escape into rysh mode and run ##upstream status to see config and live connection state.
  4. ##upstream my-shares lists what this session has published; the client connects over NATS-over-WebSocket to rysh-server.
  5. Note env overrides: RYSH_UPSTREAM_ENABLED, RYSH_UPSTREAM_URL, RYSH_UPSTREAM_API_KEY.

Commands shown

cat rysh.config
rysh --shared
##upstream status
##upstream my-shares
##share status

Keys used

EnterEscape

Transcript

0:00Point Rysh at a workspace URL and an API key -- now your session can join the hub.

0:03Upstream lives in your rysh.config under the [upstream] section: enabled, the server url, and your api_key.

0:11Start rysh with --shared and it auto-shares the first pane to the workspace as soon as it boots.

0:19Double-Escape into rysh mode. ##upstream status shows your configuration and whether the connection is live.

0:28The client connects over NATS-over-WebSocket to rysh-server. ##upstream my-shares lists what this session has published.

0:38Prefer env vars? RYSH_UPSTREAM_ENABLED, RYSH_UPSTREAM_URL, and RYSH_UPSTREAM_API_KEY override the config at launch.

0:46Config or flags, you're connected to the workspace -- ready to share and subscribe.

Key takeaway
The [upstream] config (or env overrides plus --shared) connects a session to rysh-server over NATS-over-WebSocket, surfaced by ##upstream status.