From 0377fdb4a8dfdf7fe72becdbfcb2480ed3f42693 Mon Sep 17 00:00:00 2001 From: Hiro Tamada Date: Wed, 15 Oct 2025 16:11:09 -0400 Subject: [PATCH 1/4] Docs for kiosk mode --- browsers/live-view.mdx | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/browsers/live-view.mdx b/browsers/live-view.mdx index 970825d..547741a 100644 --- a/browsers/live-view.mdx +++ b/browsers/live-view.mdx @@ -15,6 +15,34 @@ To access the live view, visit the `browser_live_view_url` provided when you cre 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. +## Kiosk mode + +You can enable kiosk mode when creating a browser by setting the `kiosk_mode` parameter to `true`. Kiosk mode provides a fullscreen live view experience without browser UI elements like the address bar and tabs. + + + +```typescript Typescript/Javascript +const kernelBrowser = await kernel.browsers.create({ + viewport: { + width: 1920, + height: 1080 + }, + kiosk_mode: true +}); +``` + +```python Python +kernel_browser = client.browsers.create( + viewport={ + "width": 1920, + "height": 1080 + }, + kiosk_mode=True +) +``` + + + ## Browser persistence `browser_live_view_url` becomes invalid once the browser is [deleted](/browsers/termination) manually or via timeout. From fc36507180b2011c2573683c0d367353434f1f0b Mon Sep 17 00:00:00 2001 From: Hiro Tamada Date: Wed, 15 Oct 2025 16:19:47 -0400 Subject: [PATCH 2/4] moar --- browsers/viewport.mdx | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/browsers/viewport.mdx b/browsers/viewport.mdx index 88d8765..475a4ff 100644 --- a/browsers/viewport.mdx +++ b/browsers/viewport.mdx @@ -5,6 +5,10 @@ description: "Configure browser viewport size and refresh rate for your automati Kernel browsers allow you to configure the viewport size and refresh rate when creating a browser session. The viewport configuration determines the initial browser window dimensions and display refresh rate. The refresh rate can be explicitly specified or automatically determined based on the width and height if they match a supported configuration. + +The `refresh_rate` parameter only applies to live view sessions and is ignored for [headless](/browsers/headless) browsers. + + ## Setting viewport configuration You can configure the viewport when creating a browser by specifying the `viewport` parameter with `width` and `height`. The `refresh_rate` is optional and will be automatically determined from the dimensions if they match a supported configuration: @@ -204,4 +208,4 @@ The server will reject any viewport configuration that doesn't exactly match one - Higher resolutions (like 2560x1440) may impact the performance and responsiveness of live view sessions - The viewport size affects how websites render, especially those with responsive designs - Screenshots taken from the browser will match the configured viewport dimensions -- In [headless mode](/browsers/headless), the viewport configuration still applies for rendering and screenshots +- In [headless mode](/browsers/headless), the viewport width and height still apply for rendering and screenshots, but the `refresh_rate` parameter is ignored From 1ac91875dfa7bf4e7b8862d3add4d7759378922a Mon Sep 17 00:00:00 2001 From: Hiro Tamada Date: Thu, 16 Oct 2025 13:40:05 -0400 Subject: [PATCH 3/4] moar --- browsers/live-view.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/browsers/live-view.mdx b/browsers/live-view.mdx index 547741a..337bf8d 100644 --- a/browsers/live-view.mdx +++ b/browsers/live-view.mdx @@ -17,7 +17,7 @@ The `browser_live_view_url` supports additional query parameters to customize th ## Kiosk mode -You can enable kiosk mode when creating a browser by setting the `kiosk_mode` parameter to `true`. Kiosk mode provides a fullscreen live view experience without browser UI elements like the address bar and tabs. +Kiosk mode provides a fullscreen live view experience without browser UI elements like the address bar and tabs. You can enable kiosk mode when creating a browser by setting the `kiosk_mode` parameter to `true`. From d402b05145317166a06c649bd68f185f1f430acd Mon Sep 17 00:00:00 2001 From: Hiro Tamada Date: Thu, 16 Oct 2025 16:16:28 -0400 Subject: [PATCH 4/4] moar --- browsers/viewport.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/browsers/viewport.mdx b/browsers/viewport.mdx index 475a4ff..44eda62 100644 --- a/browsers/viewport.mdx +++ b/browsers/viewport.mdx @@ -5,10 +5,6 @@ description: "Configure browser viewport size and refresh rate for your automati Kernel browsers allow you to configure the viewport size and refresh rate when creating a browser session. The viewport configuration determines the initial browser window dimensions and display refresh rate. The refresh rate can be explicitly specified or automatically determined based on the width and height if they match a supported configuration. - -The `refresh_rate` parameter only applies to live view sessions and is ignored for [headless](/browsers/headless) browsers. - - ## Setting viewport configuration You can configure the viewport when creating a browser by specifying the `viewport` parameter with `width` and `height`. The `refresh_rate` is optional and will be automatically determined from the dimensions if they match a supported configuration: @@ -55,6 +51,10 @@ kernel_browser_auto = client.browsers.create( + +The `refresh_rate` parameter only applies to live view sessions and is ignored for [headless](/browsers/headless) browsers. + + ## Supported viewport configurations Kernel supports specific viewport configurations. The server will reject unsupported combinations. When you provide width and height without specifying refresh_rate, it will be automatically determined if the dimensions match one of the supported resolutions exactly. The following resolutions are supported: