Get your setup working faster. Join our Discord for optimisation tips from elite testers.

Configure proxy settings to run Appium tests

Establish a Local Testing connection to execute Appium tests behind proxies on BrowserStack App Automate. Test apps on 3000+ real browsers and devices.

This page explains how to set up a Local Testing connection for Appium tests when your local machine is behind a proxy.

Proxy

Proxies are commonly set up for office networks, remote servers, and sometimes on local machines. Contact your network/IT team to obtain the ‘Proxy Host’ and ‘Proxy Port’ to setup Local Testing for this implementation. Once you obtain the Host and Port, you can establish a Local Testing connection using one of two ways:

If you are using the BrowserStack SDK, add the following snippet to your browserstack.yml file:

Copy

If your proxy requires authentication, use the following code snippet:

Copy

Add the following snippet to your test scripts:

bsLocalArgs.put("proxyHost", "127.0.0.1");
bsLocalArgs.put("proxyPort", "8000");

If your proxy requires authentication, use the following code snippet:

bsLocalArgs.put("proxyHost", "127.0.0.1");
bsLocalArgs.put("proxyPort", "8000");
bsLocalArgs.put("proxyUser", "user");
bsLocalArgs.put("proxyPass", "password");

Use the --proxy-host and --proxy-port flags while establishing a Local Testing connection:

Run the binary using the following command:

OS X and Linux
Windows

./BrowserStackLocal --key YOUR_ACCESS_KEY --proxy-host  --proxy-port

If your proxy requires authentication, add --proxy-user and --proxy-pass to the above command.

Run the binary using the following command:

OS X and Linux
Windows

./BrowserStackLocal --key YOUR_ACCESS_KEY --proxy-host  --proxy-port  --proxy-user --proxy-pass

To resolve all requests on our remote browsers and mobile devices through your proxy, add --force-proxy and --force-local flags to the command. Without these flags, Local binary tries to connect directly for better performance.

MITM Proxy

If your proxy type is MITM (like BrowserMob), you will need the ‘Proxy Host’ and ‘Proxy Port’. Once you have the Host and Port, you can establish a Local Testing connection using one of two ways:

Add the following snippet to your browserstack.yml file:

Copy

If your proxy requires authentication, use the following code snippet:

Copy

Add the following snippet to your test scripts:

bsLocalArgs.put("localProxyHost", "127.0.0.1");
bsLocalArgs.put("localProxyPort", "8000");

If your proxy requires authentication, use the following code snippet:

bsLocalArgs.put("localProxyHost", "127.0.0.1");
bsLocalArgs.put("localProxyPort", "8000");
bsLocalArgs.put("-localProxyUser", "user");
bsLocalArgs.put("-localProxyPass", "password");

Use the following command to establish the Local Testing connection:

Run the binary using the following command:

OS X and Linux
Windows

./BrowserStackLocal --key YOUR_ACCESS_KEY --local-proxy-host <proxy_host> --local-proxy-port <proxy_port> 

If your local proxy requires authentication, add --local-proxy-user and --local-proxy-pass to the above command.

OS X and Linux
Windows

./BrowserStackLocal --key YOUR_ACCESS_KEY --local-proxy-host <proxy_host> --local-proxy-port <proxy_port> --force-proxy --force-local

To resolve all requests on our remote browsers and mobile devices through your local proxy, add --force-proxy and --force-local flags to the command as demonstrated. Without these flags, Local binary tries to connect directly for enhanced performance.

Did this page help you?

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback

Is this page helping you?

Yes

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback!