Skip to content

Document controls=disabled as the live-view no-controls param #655

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

Open
ulziibay-kernel wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −3
Open

Document controls=disabled as the live-view no-controls param #655

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 6 additions & 2 deletions browsers/live-view.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,17 @@ func main() {
## Query parameters

The `browser_live_view_url` supports additional query parameters to customize the live view:
- `readOnly` (bool): when set to `true`, the view will be non-interactive.
- `controls` (string): set to `disabled` to hide the view's interaction controls. `readOnly=true` is supported as a legacy alias.

Example:
```
https://api.onkernel.com/browser/live/<TOKEN>?readOnly=true
https://api.onkernel.com/browser/live/<TOKEN>?controls=disabled
```

<Warning>
`controls=disabled` is a presentation setting, not a security boundary. Anyone who has a live view URL can interact with the browser by removing the parameter. Only share a live view URL with people you trust to control the session.
</Warning>

## Embedding in an iframe

The live view URL can be embedded in an iframe to integrate the browser view into your own application or dashboard.
Expand Down
2 changes: 1 addition & 1 deletion introduction/observe.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ kernel browsers view <session-id>
```
</CodeGroup>

Add `?readOnly=true` for a non-interactive view, or enable [kiosk mode](/browsers/live-view#kiosk-mode) at creation for a fullscreen, cinematic experience. Full reference: [Live View](/browsers/live-view).
Add `?controls=disabled` to hide the interaction controls (a presentation setting — anyone with the URL can still take control by removing it), or enable [kiosk mode](/browsers/live-view#kiosk-mode) at creation for a fullscreen, cinematic experience. Full reference: [Live View](/browsers/live-view).

If a firewall or network policy restricts outbound traffic, allow the [Live View domains and ports](/info/network-access#required-destinations).

Expand Down
Loading