Skip to main content
Version: Next

Settings

Settings

Module settings at /browser/settings, in three tabs.

TabCovers
API KeysThe keys your test clients authenticate with
Config Generator (Selenium)Generated W3C capabilities and client code
Company ComputersComputers in your company hub that share their own browsers and desktop

Each tab has a direct link: ?tab=api-keys, ?tab=config, and ?tab=local-agents.

API Keys​

The API Keys tab is the same component MobileHub uses, so a key created in either module is the same kind of key. See MobileHub for how keys are created and managed.

Config Generator (Selenium)​

This is the practical starting point for connecting an existing Selenium suite. You choose a target, and the page produces the capabilities and the client code to reach it.

Choose a target​

FieldNotes
Selenium Server URLRead-only, with a copy button. The hub endpoint your client connects to
Operating SystemWindows, macOS, or Linux. Options with no capacity are disabled
OS VersionAppears once an operating system is chosen
BrowserChrome, Firefox, Edge, or Safari. Browsers unavailable on the chosen OS version are disabled
Browser VersionOptional. Omit it to get the latest available version

The options come from the same capability data the Browsers page uses, so the generator only offers combinations the service can actually provide.

The hub endpoint​

The Selenium server lives on the API host, not the application host:

https://api.rabbitqa.com/df/wd/hub

Copy the value from the field rather than typing it, so you get the exact host for your environment.

Generated capabilities​

The right side shows the W3C capabilities for your selection as JSON, with Copy JSON. For example, Chrome 120 on macOS 14.5 produces:

{
"browserName": "chrome",
"browserVersion": "120",
"platformName": "mac",
"df:osVersion": "14.5"
}

platformName is the W3C spelling of the operating system you picked: Windows, mac, or Linux.

The JSON on screen omits df:apiKey; the copied JSON adds it with the placeholder value df_auto_xxxxx, which you replace with your own key. Need an API key? links to the API Keys tab.

Code examples​

Below the capabilities, the same configuration is rendered as working client code in four tabs: Java, Python, Node.js, and cURL. Each example is syntax-highlighted and has a copy button.

The examples authenticate twice over, and both parts matter:

  • df:apiKey is sent as a capability when the session is created.
  • The same key is sent as HTTP Basic auth, as the user apikey, on the hub URL. Selenium repeats it on every command.

That is why the generated code rewrites the server URL to embed the credentials:

https://apikey:[email protected]/df/wd/hub

Replace df_auto_xxxxx with your own key from the API Keys tab.

Capability reference​

The tab also documents the capabilities the hub accepts.

W3C standard​

CapabilityTypeRequiredDescription
browserNamestringYeschrome, firefox, edge, or safari
browserVersionstringNoA specific version. Omit for the latest
platformNamestringNoWindows, mac, Linux, or any

Vendor capabilities​

CapabilityTypeDefaultDescription
df:apiKeystring–API key for authentication. Required
df:osVersionstring–A specific OS version, such as 14.5 for macOS or 22.04 for Ubuntu
df:screenResolutionstring1920x1080Browser window resolution
df:liveViewbooleanfalseStream live video during automation
df:recordVideobooleanfalseRecord video of the session
df:recordLogsbooleantrueCapture browser console logs
df:sessionTimeoutnumber300Idle timeout in seconds

Version matching​

browserVersion matches by prefix, so a partial version selects the newest build under it.

browserVersionMatchesDoes not match
"120"120.0.6099.109121.x, 119.x
"120.0"120.0.6099.109120.1.x
OmittedThe latest available version–
note

All sessions use the W3C WebDriver protocol. The older JSON Wire protocol is not supported.

tip

Sessions end after five minutes of inactivity by default. Raise df:sessionTimeout if your suite has long idle gaps between commands.

Sessions run in parallel, each in its own isolated browser instance.

Company Computers​

Company Computers

This tab connects computers you own to the company hub, so their installed browsers — and optionally the desktop itself — serve sessions alongside the managed pool. It is the same tab MobileHub uses for local devices, with the browser runtime options added.

Connected computers are always private to your company and join its default virtual hub. No workspace is required.

Browser runtime​

Choose how a session gets its browser before you copy the command.

OptionWhat it does
NativeUses the browsers already installed on that computer
DockerStarts an isolated browser container for each session. Needs a Docker image with a pinned tag or digest
Also share the native desktopAdds the signed-in desktop as a target, alongside the browsers

In Docker mode the commands are only generated once you enter a versioned image.

Connect a computer​

The card walks through three one-time steps, then hands you the exact commands to run.

StepWhat happens
Install CLIOne-time setup on the computer with your devices. Install CLI opens the installer instructions
Sign InRun dfctl login and approve your company in the browser
Start AgentThe agent comes online and its browsers join your company hub

Copy Commands copies the generated pair, which already carries your environment's backend URL and the runtime you chose:

dfctl login --backend https://api.rabbitqa.com
dfctl agent start --resources browser --mode native

Sharing the desktop appends it to the resource list (--resources browser,desktop), and Docker mode adds --docker-image.

note

The CLI installs into your user's bin folder. Add that folder to your shell's PATH so dfctl works in new terminals.

Manage connected computers​

The list below the setup card shows every computer registered to your company, with counts of Online, Offline, and Disabled across the top and a Refresh action. Until the first agent connects it reads No computers have been connected yet.

Each computer shows its platform and agent version, with these actions:

ActionEffect
Update AgentQueues an agent update. New sessions are blocked until it finishes; running sessions are not interrupted
Disable / EnableBlocks or restores new sessions on that computer. Existing sessions can finish, and updates still run
Remove AccessDisconnects the computer and revokes its access

A queued update reports its own progress — waiting for active sessions to drain, downloading, installing, restarting — and says so when a computer has not acknowledged it within the usual 30-second check.