- The Platform Configurator
- Getting Started with Selenium for Automated Website Testing
- Getting Started with Appium for Mobile Native Application Testing
- Selenium Bootcamp by Dave Haeffner
- Appium Bootcamp by Dave Haeffner and Matthew Edwards
The basic Sauce Connect setup is best suited to situations in which you, or a small team of people, need to set up a connection between the Sauce Labs browser cloud and a website that you want to test that's hosted on your local machine or behind a firewall. There are no proxies between the Internet and the machine where you want to install Sauce Connect, and though there may be situations in which you want to set up multiple Sauce Connect tunnels, in most cases you only need a single tunnel.
This the basic configuration for Sauce Connect. The SC Host has a direct connection to the internet, and the SUT is on the same local network as the SC Host machine. In this configuration, if you're unable to connect, the most likely culprit are the firewall settings on the SC Host machine.
|SC Host||Machine in your network that the Sauce Connect application is running on.|
|SUT||Site Under Test, the site that you're testing.|
The virtual machine that hosts Sauce Connect on the Sauce Labs side.
Different Machine, But Same Network
The most important thing to understand about setting up Sauce Connect is that while it doesn't need to be set up on the same machine as the site or application you're testing, it must be on the same network. What Not to Do: Dysfunctional Sauce Connect Proxy Network Configurations illustrates some examples of network architectures in which Sauce Connect will not be able to create a tunnel, or will be too slow to carry out effective testing.
Sauce Connect IP and Virtual Machine Range
188.8.131.52/21(this is equivalent to the range
184.108.40.206 – 220.127.116.11)
18.104.22.168/21(this is equivalent to the range
22.214.171.124 - 126.96.36.199)
188.8.131.52/22(this is equivalent to the range
184.108.40.206 - 220.127.116.11)
For saucelabs.com certificate authentication, the server hosting Sauce Connect may need to connect to Online Certificate Status Protocol (OCSP) or Certificate Revocation List (CRL) services as well. Check out Sauce Connect Certificate Handling for more info.
IP Ranges and Data Center Endpoints
Sauce Labs has data centers in both the US and EU. You can access Sauce Labs services from either location by providing the appropriate URL endpoints, and whitelisting their associated IP ranges.
Virtual Device Cloud: https://ondemand.eu-central-1.saucelabs.com/wd/hub
Sauce Connect Proxy: https://eu-central-1.saucelabs.com/rest
REST API: https://eu-central-1.saucelabs.com/rest/v1
18.104.22.168/21 (this is equivalent to the range
22.214.171.124 – 126.96.36.199)
188.8.131.52/21 (this is equivalent to the range
184.108.40.206 - 220.127.116.11)
- Make sure you've reviewed the System Requirements for Sauce Connect Proxy
- You should read Sauce Connect and Network Security to understand how Sauce Connect uses tunnels to connect your site or application under test to a browser running on a virtual machine in the Sauce Labs data center, and to understand how that tunnel is secured
- You should review the Sauce Connect Best Practices and Sauce Connect Proxy FAQS
Setting Up Sauce Connect
Download the appropriate version of Sauce Connect for your operating system.Latest Stable Release
Download Link SHA1 Checksum Download Sauce Connect v4.5.3 for Mac OS 10.8+
Download Sauce Connect v4.5.3 for Windows 7+
Download Sauce Connect v4.5.3 for Linux
Download Sauce Connect v4.5.3 for Linux 32-bit
1727d35fe9ad10f891aa21f853aaf119f4f43adbClick here to download past stable releases of Sauce Connect Proxy...
Download Link SHA1 Checksum Download Sauce Connect v4.5.2 for Mac OS 10.8+
Download Sauce Connect v4.5.2 for Windows 7+
Download Sauce Connect v4.5.2 for Linux
Download Sauce Connect v4.5.2 for Linux 32-bit
Download Link SHA1 Checksum Download Sauce Connect v4.5.1 for Mac OS 10.8+
Download Sauce Connect v4.5.1 for Windows 7+
Download Sauce Connect v4.5.1 for Linux
Download Sauce Connect v4.5.1 for Linux 32-bit
Download Link SHA1 Checksum Download Sauce Connect v4.5.0 for Mac OS 10.8+
Download Sauce Connect v4.5.0 for Windows 7+
Download Sauce Connect v4.5.0 for Linux
Download Sauce Connect v4.5.0 for Linux 32-bit
Download Link SHA1 Checksum Download Sauce Connect v4.4.11 for OS X 10.12+
Note: Contains a major bug on OS X 10.11 and below, please use SC 4.4.12 instead.
Download Sauce Connect v4.4.11 for Windows 7+
Download Sauce Connect v4.4.11 for Linux
Download Sauce Connect v4.4.11 for Linux 32-bit
Download Link SHA1 Checksum Download Sauce Connect v4.4.10 for OS X 10.8+
Download Sauce Connect v4.4.10 for Windows 7+
Download Sauce Connect v4.4.10 for Linux
Download Sauce Connect v4.4.10 for Linux 32-bit
Download Link SHA1 Checksum Download Sauce Connect v4.4.9 for OS X 10.8+
Download Sauce Connect v4.4.9 for Windows 7+
Download Sauce Connect v4.4.9 for Linux
Download Sauce Connect v4.4.9 for Linux 32-bit
Download Link SHA1 Checksum Download Sauce Connect v4.4.8 for OS X 10.8+
Download Sauce Connect v4.4.8 for Windows 7+
Download Sauce Connect v4.4.8 for Linux
Download Sauce Connect v4.4.8 for Linux 32-bit
Download Link SHA1 Checksum Download Sauce Connect v4.4.7 for OS X 10.8+
Download Sauce Connect v4.4.7 for Windows 7+
Download Sauce Connect v4.4.7 for Linux
Download Sauce Connect v4.4.7 for Linux 32-bit
Download Link SHA1 Checksum Download Sauce Connect v4.4.6 for OS X 10.8+
Download Sauce Connect v4.4.6 for Windows 7+
Download Sauce Connect v4.4.6 for Linux
Download Sauce Connect v4.4.6 for Linux 32-bit
Download Link SHA1 Checksum Download Sauce Connect v4.4.5 for OS X 10.8+
Download Sauce Connect v4.4.5 for Windows 7+
Download Sauce Connect v4.4.5 for Linux
Download Sauce Connect v4.4.5 for Linux 32-bit aa42f7d16a59474efd950c604f996bdcc2d45544
Download Link SHA1 Checksum Download Sauce Connect v4.4.4 for OS X 10.8+
Download Sauce Connect v4.4.4 for Windows 7+
Download Sauce Connect v4.4.4 for Linux
Download Sauce Connect v4.4.4 for Linux 32-bit
Download Link SHA1 Checksum Download Sauce Connect v4.4.3 for OS X 10.8+
Download Sauce Connect v4.4.3 for Windows 7+
Download Sauce Connect v4.4.3 for Linux
Download Sauce Connect v4.4.3 for Linux 32-bit
Download Link SHA1 Checksum Download Sauce Connect v4.4.2 for OS X 10.8+
Download Sauce Connect v4.4.2 for Windows 7+
Download Sauce Connect v4.4.2 for Linux
Download Sauce Connect v4.4.2 for Linux 32-bit
Download Link SHA1 Checksum Download Sauce Connect v4.4.1 for OS X 10.8+
Download Sauce Connect v4.4.1 for Windows 7+
Download Sauce Connect v4.4.1 for Linux
Download Sauce Connect v4.4.1 for Linux 32-bit
- On the machine where you want to install Sauce Connect, open outbound port 443 for sending Selenium commands from Sauce Connect to the Sauce Labs virtual machine, and inbound port 4445 for receiving Selenium commands (inbound port 4445 only needs to be open for connections within your network from the machine where your test scripts are running, and only if you use Sauce Connect's Selenium Relay, which by default listens on port 4445).
After extracting the Sauce Connect files onto your machine, go to the install directory and run the -u and -k commands to authenticate against your Sauce Labs account and establish the Sauce Connect tunnel.
Finding Your Username and Access KeyYou can find your Sauce Labs username and access key in the User Profile > User Settings section of your Sauce Labs dashboard. You should also check out our topic on setting your username and access key as environment variables.
- When you see
connected, log in to your Sauce Labs account and click the Tunnels dashboard link.
Under Active Tunnels, you should see the tunnel you just started.
Using the tunnelIdentifier Option for Automated Tests
Once you have launched a Sauce Connect Proxy tunnel, you need to use the
tunnelIdentifier option in the desired capabilities of your automated tests to run your tests through that tunnel. For example, if your tunnel is named
myTunnel01, you would need to set this option as
"tunnelIdentifier": "myTunnel01". If you are starting and stopping Sauce Connect Proxy programmatically, you can make sure your tunnel always launches with the same name by passing the identifier flag,
-i, with your authentication credentials, for example:
bin/sc -u YOUR_USERNAME -k YOUR_ACCESS_KEY -i myTunnelO1
After Setting Up Sauce Connect
- You can set up monitoring for your Sauce Connect tunnels
- You can set up multiple tunnels by using tunnel identifiers
Command Line Examples
In its simplest form, Sauce Connect can be started from the command line with these commands.
Starting Sauce Connect Programmatically
To start Sauce Connect programmatically, there are many options, such as launching it via Maven when using Java. The Sauce Connect Maven plugin will do this for you automatically, and you can also check out an example of how to set this up in a testing script.