Use signalingInsecure option for no-TLS TypeScript connections#4982
Use signalingInsecure option for no-TLS TypeScript connections#4982shannonbradshaw wants to merge 2 commits intomainfrom
Conversation
The TypeScript SDK now supports a signalingInsecure dial option that tells the SDK to connect to the signaling server over plain HTTP. Update the connectivity page to use this option instead of manually constructing an http:// URL for the signaling address. Source: viamrobotics/viam-typescript-sdk#888 https://claude.ai/code/session_01RpYY6JffBD27vcdBPV41vb
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
viambot
added
the
safe to build
There was a problem hiding this comment.
Pull request overview
Updates the TypeScript no-TLS connection guidance to use the new signalingInsecure option rather than manually constructing an http:// signaling URL, aligning docs with the updated TypeScript SDK connection configuration.
Changes:
- Replaces the “manual
http://signaling address” approach withsignalingInsecure: true. - Updates the surrounding explanatory text and highlighted lines in the TypeScript snippet.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| To connect directly to your local machine, you can use the connection code from the **CONNECT** tab if you are using the Python SDK, Go SDK, Flutter SDK, or C++ SDK. | ||
|
|
||
| For the TypeScript SDK, you must disable TLS verification for your `viam-server` and change the sinaling address for the connection code: | ||
| For the TypeScript SDK, you must disable TLS verification for your `viam-server` and set `signalingInsecure: true` in the connection code: |
There was a problem hiding this comment.
Wording issue: viam-server doesn't do “TLS verification”; in this section you're disabling TLS on the server (via -no-tls / no_tls: true). Consider rephrasing to “disable TLS on viam-server” or “run viam-server without TLS” to avoid implying a client-side verification setting.
| For the TypeScript SDK, you must disable TLS verification for your `viam-server` and set `signalingInsecure: true` in the connection code: | |
| For the TypeScript SDK, you must disable TLS on your `viam-server` and set `signalingInsecure: true` in the connection code: |
There was a problem hiding this comment.
Fixed in 86b6f0b. Rephrased to "disable TLS on your viam-server" as suggested.
Generated by Claude Code
| signalingAddress: `${host}.local:8080`, | ||
| signalingInsecure: true, |
There was a problem hiding this comment.
signalingAddress: ${host}.local:8080`` is confusing given host is set to a `*.viam.cloud` hostname in this example. As written, it produces `…viam.cloud.local`, which doesn't match the local hostname pattern shown elsewhere in the docs (for example `my-robot.local`). Consider using a separate `localSignalingAddress`/`localHost` variable (or updating the sample `host` value) so the resulting address is unambiguous for readers.
There was a problem hiding this comment.
Fixed in 86b6f0b. Replaced the confusing ${host}.local:8080 pattern with a separate localAddress variable set to my-machine.local:8080, making clear that the signaling address should be the machine's local hostname, not the cloud hostname.
Generated by Claude Code
Source changes
7c9c1cf): AddedsignalingInsecureoption toDialWebRTCConfandDialWebRTCOptions. Whentrue, the SDK connects to the signaling server over plain HTTP instead of HTTPS, for use with machines runningno_tls: true.Docs changes
docs/reference/sdks/connectivity.md: Updated the TypeScript no-TLS connection example to usesignalingInsecure: trueinstead of manually constructing anhttp://signaling address URL. Updated the intro text and the code sample's highlighted lines.How I found these
signalingInsecurefield in the TypeScript SDK diff (src/robot/client.ts,src/rpc/dial.ts)signalingInsecure,no_tls, andDialWebRTCacross the docs repo identified the connectivity page as the location that describes this exact use casehttp://to the signaling address, which the new option replacesGenerated by daily docs change agent