diff --git a/browsers/live-view.mdx b/browsers/live-view.mdx index 62862928..9fc244a8 100644 --- a/browsers/live-view.mdx +++ b/browsers/live-view.mdx @@ -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/?readOnly=true +https://api.onkernel.com/browser/live/?controls=disabled ``` + + `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. + + ## 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. diff --git a/introduction/observe.mdx b/introduction/observe.mdx index 167e470f..21f4abb0 100644 --- a/introduction/observe.mdx +++ b/introduction/observe.mdx @@ -56,7 +56,7 @@ kernel browsers view ``` -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).