lightgun-poc / lib/tunnel / formatTunnelReport

Function: formatTunnelReport()

formatTunnelReport(url, adopted?, key?): string[]

Defined in: lib/tunnel.ts:131

The lines printed once a tunnel is up. Split out so they can be asserted.

The security lines are not decoration: a tunnel puts a socket that moves the mouse and presses keys on the public internet. With a session key the URL's fragment carries the credential — the socket refuses anyone without it, but the full URL is still the key to this machine. Without a key (--key off, or the standalone tunnel command in front of a server whose loopback exemption is on), the URL alone is enough — whoever opens one deserves to be told plainly.

Parameters

url

string

adopted?

boolean = false

key?

string | null

Returns

string[]