linbit-tunl: quickref-brief

linbit-tunl: Quick start

The commands you'll actually type during a support session. For everything else -- relay operations, environment overrides, key paths -- see quickref.html.

Customer: open a session

Support gives you the exact command, including the four-word session ID. It will look like one of these:

# Default share mode: support can type in your shell;
# tunnel requests show a confirmation popup.
linbit-tunl swift-fox-jumps-barrel

# Watch-only: support cannot type in your shell or open a tunnel.
linbit-tunl --restricted swift-fox-jumps-barrel

# Pre-open the reverse tunnel at start (also works without tmux).
linbit-tunl --tunnel swift-fox-jumps-barrel

During the session

Inside the customer-side tmux window:

Keys What it does
Ctrl-b Q End the session (orderly shutdown)
Ctrl-b c Toggle focus between shell and chat
Ctrl-b u Pre-grant tunnel requests (skip the popup)
Ctrl-b U Revoke an active tunnel and remove support keys
Ctrl-b X Auto-reject future tunnel requests
F1 or Ctrl-b Enter Show the action menu
Ctrl-b ? Show the keybinding cheat sheet

Support: join a session

# Create a new session; the relay generates the session ID and
# prints the exact command to read to the customer.
tunl create-session --case CASE-4711 --customer "Acme Corp"

# List active and pending sessions, or pick one interactively.
tunl list
tunl pick

# Join the customer's session (2-window tmux: shell + chat).
tunl join swift-fox-jumps-barrel
tunl join --read-only swift-fox-jumps-barrel

# Once a tunnel is up, reach the customer's machine directly:
tunl ssh swift-fox-jumps-barrel
tunl browser swift-fox-jumps-barrel

Detach vs. close

Keys What it does
Ctrl-b d Detach from your join session. Customer stays connected; you can rejoin later.
Ctrl-b Q Close your local join tmux. Customer stays connected.
Ctrl-b Enter Open the action menu (SSH, browser, proxy shell, resize, zoom, ...)