Skip to content

Commit feb743b

Browse files
committed
Use signalingInsecure option for no-TLS TypeScript connections
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
1 parent ba33c36 commit feb743b

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

docs/reference/sdks/connectivity.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ When connecting to a machine using the connection code from the [**CONNECT** tab
2020

2121
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.
2222

23-
For the TypeScript SDK, you must disable TLS verification for your `viam-server` and change the sinaling address for the connection code:
23+
For the TypeScript SDK, you must disable TLS verification for your `viam-server` and set `signalingInsecure: true` in the connection code:
2424

2525
{{< tabs >}}
2626
{{% tab name="Command-line" %}}
@@ -44,9 +44,9 @@ Restart `viam-server` with the `-no-tls` flag.
4444
{{% /tab %}}
4545
{{< /tabs >}}
4646

47-
Update the signaling address in your connection code:
47+
Update your connection code to set `signalingInsecure` to `true` and point the signaling address at your machine's local address:
4848

49-
```ts {class="line-numbers linkable-line-numbers" data-line="1,12"}
49+
```ts {class="line-numbers linkable-line-numbers" data-line="1,12,13"}
5050
const host = "mymachine-main.0a1bcdefgi.viam.cloud";
5151

5252
const machine = await VIAM.createRobotClient({
@@ -58,7 +58,8 @@ const machine = await VIAM.createRobotClient({
5858
authEntity: "<API-KEY-ID>",
5959
/* Replace "<API-KEY-ID>" (including brackets) with your machine's API key ID */
6060
},
61-
signalingAddress: `http://${host}.local:8080`,
61+
signalingAddress: `${host}.local:8080`,
62+
signalingInsecure: true,
6263
});
6364
```
6465

0 commit comments

Comments
 (0)