Skip to content

docs(teleop): correct broker key and identity guidance #4087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paul-nechifor merged 3 commits into from
Sep 16, 2026
Merged

docs(teleop): correct broker key and identity guidance #4087

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
48be81f
docs(teleop): correct broker key and identity guidance
ruthwikdasyam Sep 12, 2026
3c1f035
fix(teleop): correct hosted key guidance
ruthwikdasyam Sep 13, 2026
a69ec6f
Merge branch 'main' into ruthwik/docs/hosted-broker-guidance
ruthwikdasyam Sep 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions default.env
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ ROBOT_IP=
CONN_TYPE=webrtc

# Hosted teleop — transport blueprints (teleop-hosted-go2-transport / -multicam).
TRANSPORTS__BROKER__BROKER_URL=https://teleop.dimensionalos.com
TRANSPORTS__BROKER__API_KEY=
TRANSPORTS__BROKER__ROBOT_ID=
TRANSPORTS__BROKER__ROBOT_NAME=
WEBRTC_SERVER_HOST=0.0.0.0
WEBRTC_SERVER_PORT=9991
Expand Down
2 changes: 1 addition & 1 deletion dimos/protocol/pubsub/impl/webrtc/providers/broker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ def __init__(self, config: BrokerConfig | None = None) -> None:
"BrokerConfig.api_key required "
"(set --transports.broker.api-key=dimos_sk_... or "
"TRANSPORTS__BROKER__API_KEY=dimos_sk_...; "
"create one in the teleop dashboard: New Key)"
"create one in the Dimensional console: API keys -> Create key)"
)
self._broker_url = config.broker_url.rstrip("/")
self._api_key = config.api_key
Expand Down
2 changes: 1 addition & 1 deletion dimos/protocol/pubsub/impl/webrtc/providers/cloudflare.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

Never deploy this on a robot: it authenticates with the CF *app secret*,
which must not leave server-side/dev environments (robots carry revocable
``dtk_live_*`` keys and go through the dimensional-teleop broker — see
``dimos_sk_*`` keys and go through the dimensional-teleop broker — see
``broker.py``). CF DataChannels are unidirectional, so this provider holds
two CF sessions — one publishing, one subscribing — giving a single process
loopback pubsub through the CF edge: exactly what the integration tests and
Expand Down
4 changes: 2 additions & 2 deletions dimos/protocol/pubsub/impl/webrtc/tool_broker_e2e.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@
-> negotiated cmd_unreliable channel). The robot side is the exact transport
object the teleop-hosted-go2-transport blueprint binds to cmd_vel.

Needs live-broker credentials, so it only runs when all three are set:
Needs live-broker credentials, so it only runs when both are set:

TELEOP_API_KEY dtk_live_... (dashboard -> New Key)
TELEOP_API_KEY dimos_sk_... (Dimensional console -> API keys -> Create key)
TELEOP_OPERATOR_TOKEN Cognito ID token of the key's owner

TELEOP_ROBOT_ID is optional (the broker derives identity from the key).
Expand Down
4 changes: 2 additions & 2 deletions docs/capabilities/teleoperation/hosted.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ The robot registers with the broker. Open
the [console Teleop tab](https://console.dimensional.org/console/teleop), sign in, and your
robot appears under **Available Robots**. Click **Connect** and you're driving.

The API key alone is enough; one key drives the CLI, uploads, and teleop. The
robot identifies itself by `TRANSPORTS__BROKER__ROBOT_ID` (blueprint default).
The API key alone is enough; one key drives the CLI, uploads, and teleop. By
default, the broker derives the robot identity from the API key.
`TRANSPORTS__BROKER__ROBOT_ID` / `TRANSPORTS__BROKER__ROBOT_NAME` are optional
overrides. All broker settings can also be passed on the CLI, e.g.
`--transports.broker.api-key=dimos_sk_...`.
Expand Down
Loading