Skip to main content
Version: 1.0.3

Appium Config Generator

Generate Appium/WebDriver capabilities for automated testing with Device Farm.

Overview​

The Config Generator helps you create Appium capabilities for connecting to Device Farm. It generates code examples in multiple languages with proper authentication.

Server URL​

Use this URL as your Appium server endpoint:

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

This endpoint supports the standard WebDriver protocol and is compatible with Appium clients in all languages.

Device Farm Capabilities​

In addition to standard Appium capabilities, Device Farm supports these custom capabilities:

CapabilityTypeDefaultDescription
df:apiKeystring-API key for authentication (required)
df:deviceIdstring-Specific device ID (or use appium:udid)
df:resignbooleantrueRe-sign iOS apps before install
df:liveViewbooleanfalseEnable live video streaming during automation
df:recordVideobooleanfalseRecord video of the test
df:recordLogsbooleantrueCapture device logs during test

App Installation​

Use df:// URLs to install apps from your uploaded files:

{
"appium:app": "df://file-uuid-here"
}

The file ID can be found in the Files section or by using the Config Generator which shows your uploaded apps.

Platform Version Matching​

Use wildcards for flexible version matching:

platformVersionMatchesDoes NOT match
"13"1313.0, 13.0.1, 14
"13.0"13.013, 13.0.1, 13.1
"13.*"13, 13.0, 13.0.1, 13.114, 12.x
"17.1.x"17.1, 17.1.0, 17.1.217, 17.0, 17.2

Tips​

tip

df:// URLs Use df://fileId in appium:app to install uploaded apps automatically.

tip

iOS Re-signing Set df:resign: false if your IPA is already signed with the correct profile.

tip

Device Selection Use df:deviceId or appium:udid for specific device, or leave empty for auto-selection.

tip

Auto Bundle ID If you provide appium:app, we'll extract and set bundleId/appPackage automatically.