Sauce Connect Proxy System and Network Requirements
Sauce Connect Proxy system requirements vary, depending on the number of parallel tests you plan to run.
Keep in mind that these are guidelines. Most environments have their own workload requirements for optimal performance. Test and profile your own environment using these recommendations as a baseline.
What You'll Need
- Minimum 2 core x 8 GB Machine.
- We recommend using the cURL command line or an equivalent tool to ensure that any error messages you receive are precise and actionable. If you're not familiar with the tool, review their docs here and then install cURL on your local machine.
- For macOS and other Unix-based systems, set your open file limit to at least 64000. See What are the optimal open file settings?.
Supported Operating Systems
Sauce Connect v4.x.x
Name | Value | CPU Arch | Notes |
Linux | Ubuntu 18.04 or higher
Debian 9 or higher CentOS/RHEL-7 or higher SUSE Linux Enterprise 15.0 and higher | x86_64 arm64 | Unsupported OSes may still be able to run Sauce Connect, but they've not been tested for versions 4.8.x and higher. |
macOS | macOS 10.13 (High Sierra) and higher | x86_64 | |
Windows | Windows 10 and higher | x86 |
Enable your Mac to allow apps from the App Store and identified developers.
- Go to System Preferences > Security & Privacy > General.
- Under Allow apps downloaded from, select the option App Store and identified developers.
Verifying Sauce Connect Network Routes on Your Host Machine
As an important step prior to downloading Sauce Connect Proxy, you or your systems administrator will need to verify that Sauce Connect Proxy can make the required network requests.
-
Log into the machine that will be hosting your Sauce Connect Proxy tunnels. This is the machine where you'll eventually be placing and running the downloaded Sauce Connect Binary.
-
Use cURL (or equivalent tool) to reach your Site Under Test. If you are relying on API to support a website or mobile app, you can cURL that as well. You should get a
200 OK HTTP
response. If you do NOT see a200 OK HTTP
response, then Sauce Connect Proxy will not be able to reach it either. -
Use cURL (or equivalent tool) to reach the below URLs, as needed. For example:
- https://api.us-west-1.saucelabs.com/rest/v1 for US-WEST region
- https://api.eu-central-1.saucelabs.com for EU-Central region
If you can get a
200 OK
response from all URLs above, you are ready to start Sauce Connect! As an alternative, you can just try to start a tunnel and check the console output.
Configuring Your System to Use Sauce Connect
Select a cloud provider from the tables below to view the minimum and recommended system requirements:
Actual system requirements will depend on the number of parallel tests, and amount of data transferred with each test.
Amazon Web Services (AWS)
Machine Type | Memory | Processor | Bandwidth | |
Minimum | EC2 m4.large | 8 GB | 2 | 450 Mbps |
Recommended | EC2 m4.xlarge | 16 GB | 4 | 750 Mbps |
Google Compute Engine (GCE)
Machine Type | Memory | Processor | Bandwidth | |
Minimum | GCE n1-standard-2 | 7.5 GB | 2 | 450 Mbps |
Recommended | GCE n1-standard-4 | 15 GB | 4 | 750 Mbps |
Microsoft Azure
The below recommendations are for Linux VMs.
Machine Type | Memory | Processor | Bandwidth | |
Minimum | Standard_D2a_v4 | 8 GiB | 2 | 2000 Mbps |
Recommended | Standard_D4a_v4 | 16 GiB | 4 | 4000 Mbps |
Optimizing the Sauce Connect Proxy Performance
- If you're running 50 or more parallel tests, we recommend a minimum network bandwidth of 450 Mbps to support the high volume of network traffic.
- If you're running 100 or more parallel tests, we recommend a minimum network bandwidth of 750 Mbps to support the high volume of network traffic.
- For best performance, stability, and security, we recommend using a dedicated server for each tunnel (see Sauce Connect Proxy Network Security).
- If you're running 60 or more parallel tests, we recommend launching more than one tunnel and using the High Availability Sauce Connect Proxy Setup.
These are recommendations for the number of Sauce Connect tunnels by number of tests running in parallel:
Parallel Tests | Recommended SC Tunnels |
0-59 | 1 |
60-119 | 2 |
120-199 | 3 |
200-299 | 4-5 |
400-599 | 6-7 |
600-799 | 8-9 |
800+ | 10 |
Setting Up Sauce Connect on Your Test Device Network
Sauce Connect Proxy must be set up on the same network as your test devices. It does not, however, need to be set up on the same machine as the website or app you're testing.
What Not to Do: Common Mistakes in 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.
Configuring Your Network to Use Sauce Connect
Firewall Restrictions
Before getting started with Sauce Connect, we recommend checking with your network administrator about updating firewall or proxy settings on your organization's network. Firewall restrictions may interfere with testing.
During Sauce Connect Proxy tunnel startup, the Sauce Connect client that runs on your network needs to make three types of outbound connections:
- To request a new Sauce Connect tunnel: Communication to the Sauce Labs REST API tunnels endpoint.
- To validate the REST API certificate: Communication to third-party web sites of Certificate Authorities.
- To establish the tunnel: Communication to Sauce Connect Tunnel VMs in the Sauce Labs cloud.
When your tests are running through a Sauce Connect tunnel, the client on your network needs to make two types of outbound connections:
- To pass status information: Communication to the Sauce Labs REST API tunnels endpoint.
- To connect with the site or app under test: Communication to the sites or apps you specify in your tests.
Allowlisting for Restricted Networks
If you're testing in a restricted network setting, you may need to allowlist the Sauce Labs domains below to allow outbound communication to Sauce Labs Selenium and Appium endpoints. Allowlisting for inbound traffic coming into your network is not necessary. To confirm your setup is successful, try running a test using the basic setup.
You need to use the set of domains for your corresponding Sauce Labs data center: US data center (US West 1) or European data center (EU Central 1). The data center you're connected to is indicated in your navigation.
For more information on our data centers and how to choose the right one for you, see Data Center Endpoints.
REST API Endpoints
The Sauce Labs REST API is a requirement for using Sauce Connect Proxy. Select your relevant Data Center:
- US-West-1
- EU-Central-1
Virtual Device Cloud/Real Device Cloud + Sauce Connect |
---|
https://api.us-west-1.saucelabs.com/rest/v1 |
Virtual Device Cloud/Real Device Cloud + Sauce Connect |
---|
https://api.eu-central-1.saucelabs.com/rest/v1 |
Sauce Connect Tunnel Service Domains
The following domains must be allowlisted for outbound communication from you network in order to make connections to Sauce Connect tunnels. Select your relevant Data Center:
- US-West-1
- EU-Central-1
Virtual Device Cloud/Real Device Cloud + Sauce Connect |
---|
*.miso.saucelabs.com |
Virtual Device Cloud/Real Device Cloud + Sauce Connect |
---|
*.eu-central-1.miso.saucelabs.com |
For US-West-1 (Virtual Device Cloud/Real Device Cloud + Sauce Connect): *.miso.saucelabs.com
Transport Layer Security (TLS) Requirements
Here are the Sauce Connect Proxy network requirements for TLS and SSL traffic:
- TLS version 1.2 or higher
- TLS/SSL library (e.g., OpenSSL)
- Network
port 443
, through which all traffic between your site and a Sauce Labs tunnel endpoint must pass
Certificate Management
Public key certificates are used to manage the security of Sauce Connect Proxy communication to both the Sauce Labs API and to the Virtual Machine hosting your tests in the Sauce Labs cloud. For information on saucelabs.com certificate authentication, see Sauce Connect Proxy Certificate Handling.