Session configuration options

When creating URLs to launch sessions in Browsolate, you can pass various runtime arguments to customize session behavior dynamically. These options allow for flexible control over user interactions, security, and session parameters during runtime.

Below is a detailed explanation of the available runtime arguments and their effects.

Runtime Arguments

Mandatory arguments

URL to Browse

The URL that will be opened in the isolated browser session. This must be a valid web address.

  • URL
    • Type: String
    • Default: ""

Specifies the absolute time when the session link will expire, or -1 for no expiry.

  • linkExpiry
    • Type: Abstime
    • Default: -1

Clipboard Access

Allow Clipboard Read

Specifies whether the session is allowed to read content from the user’s clipboard. If set to true, the session can access clipboard data.

  • clipboardRead
    • Type: Boolean
    • Default: false

Allow Clipboard Write

Specifies whether the session can write content to the user’s clipboard. If set to true, the session can modify clipboard content.

  • clipboardWrite
    • Type: Boolean
    • Default: false

User Interface and Experience

Theme Name

Specifies the theme to use for the session’s user interface.

  • themeName
    • Type: String
    • Default: "default"

Read-Only Mode

Enables or disables read-only mode for the session. When enabled, the session restricts user actions such as input or interaction with web forms.

  • readOnly
    • Type: Boolean
    • Default: false

Allow Navigation

Determines if the user is allowed to navigate to different URLs during the session.

  • navigation
    • Type: Boolean
    • Default: true

URL Editable

Specifies whether the URL bar is editable by the user during the session.

  • urlEditable
    • Type: Boolean
    • Default: false

Session Management

Session Lifetime

Defines the total duration (in seconds) of the session before it is automatically terminated.

  • sessionLifetime
    • Type: Integer
    • Default: 300

Allow Session Extension

Specifies whether the session can be extended beyond its original lifetime.

  • sessionExtensionAllowed
    • Type: Boolean
    • Default: false

Session Extension Time

Defines the amount of time (in seconds) to extend the session when allowed.

  • sessionExtensionTime
    • Type: Integer
    • Default: 30

Screen Settings

Screen Width

Specifies the width of the browser window. Use -1 for automatic sizing.

  • screenWidth
    • Type: Integer
    • Default: -1

Screen Height

Specifies the height of the browser window. Use -1 for automatic sizing.

  • screenHeight
    • Type: Integer
    • Default: -1

Mobile Device Automatic Sizing

Automatically size the screen on mobile devices, ignore any fixed width and height.

  • mobileAutoSize
    • Type: Boolean
    • Default: true

Customization Options

User Agent String

Defines the User-Agent string for the session. This is an advanced option and can be used to modify how the browser identifies itself to websites.

  • userAgent
    • Type: String
    • Default: ""

Custom Request Headers

Allows custom request headers to be sent with each HTTP request. This is an advanced option for customizing how requests are made.

  • customRequestHeaders
    • Type: KeyValue
    • Default: ""

Debugging and Logging

An identifier for the session link, which will be logged with all events generated by the session.

  • linkId
    • Type: String
    • Default: ""

Log Direct URL Navigation

Logs whenever the user navigates directly to a new URL within the session.

  • logDirectUrlNavigation
    • Type: Boolean
    • Default: false

Log Indirect URL Navigation

Logs when URLs are fetched indirectly from within the session, such as through JavaScript.

  • logIndirectUrlNavigation
    • Type: Boolean
    • Default: false

Enable Debug Mode

Turns on debug mode for the session, which may provide additional diagnostic information.

  • debugModeEnabled
    • Type: Boolean
    • Default: false