Skip to content

Christian/live view docs update #12

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
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Christian/live view docs update #12

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8b523e2
live view docs update
heyglassy Jul 18, 2025
29ee072
correct example
heyglassy Jul 18, 2025
f4be482
mesa
heyglassy Jul 21, 2025
6d30d88
default
heyglassy Jul 21, 2025
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
14 changes: 11 additions & 3 deletions observability/live-view.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,23 @@ If using Kernel's [app platform](/build/develop), you can tail the logs to print
kernel logs <your-app> --follow
```

## Query parameters
## Live view configuration

The `browser_live_view_url` supports additional query parameters to customize the live view:
Configuring the live view by setting query parameters on your `browser_live_view_url`.

```
https://api.onkernel.com/browser/live?w=1024&h=768&r=60readOnly=false&jwt=
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example URL is missing an ampersand (&) between the r=60 and readOnly=false parameters. It should be:

Suggested change
https://api.onkernel.com/browser/live?w=1024&h=768&r=60readOnly=false&jwt=
https://api.onkernel.com/browser/live?w=1024&h=768&r=60&readOnly=false&jwt=

Type: Logic | Severity: Medium

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

```

- `w` / `width` (num): sets the width of the VM's screen in pixels.
- `h` / `height` (num): sets the height of the VM's screen in pixels.
- `r` / `rate` (num): sets the live view frame rate in frames per second. The default is 30.
- `r` / `rate` (num): sets the live view framerate in frames per second. The default is 30.
- `readOnly` (bool): when set to `true`, the view will be non-interactive.

### Framerate

We support framerates between 30 - 60 fps on increments of 10.

## Browser persistence

If you [marked](/launch/browser-persistence) a browser for persistence, `browser_live_view_url` remains active after the invocation ends. It remains active until you [terminate the browser](/launch/browser-termination).
Expand Down