Skip to content

Commit b9c9231

Browse files
committed
docs/sc5: revise and publish FAQ section
1 parent d6fb265 commit b9c9231

File tree

2 files changed

+26
-117
lines changed

2 files changed

+26
-117
lines changed

docs/secure-connections/sauce-connect-5/faq.md

Lines changed: 25 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -6,147 +6,57 @@ sidebar_label: FAQ
66

77
import useBaseUrl from '@docusaurus/useBaseUrl';
88

9-
This list of frequently asked questions can help you with what you need to know about Sauce Connect 5 usage and problem solving. Additionaly you can check [Troubleshooting guide](/secure-connections/sauce-connect-5/troubleshooting/).
9+
This list of frequently asked questions covers key information about using Sauce Connect 5 and resolving common issues. You can also refer to the [Troubleshooting guide](/secure-connections/sauce-connect-5/troubleshooting/) for more detailed help.
1010

11-
:::warning
12-
SC4 content below - (CIA) means "Check If Applicable"
13-
:::
14-
15-
## (CIA) What outbound ports do I need open for Sauce Connect 5?
11+
## What outbound ports do I need open for Sauce Connect 5?
1612

1713
Sauce Connect Proxy 5 can only communicate with Sauce Labs via `port 443`. This is not configurable.
1814

1915
For more information, see [Data Center Endpoints](/basics/data-center-endpoints).
2016

21-
## When do I need to use Port 443 and how does it relate to the --proxy flag?
22-
23-
Port 443 is the typical default port for HTTPS traffic. Sauce Connect will use port 443 when sending traffic to your network when trying to reach the site(s) under test.
24-
25-
You can use the [`-x / --proxy`](/dev/cli/sauce-connect-5/run/#proxy) command-line option (or `SAUCE_PROXY` environment variable) to specify the `hostname:port` of the proxy for all Sauce Connect Proxy traffic to the site(s) under test. In some companies you MUST pass traffic through a proxy to reach the internet.
26-
27-
See also [Sauce Connect Proxy Setup with Additional Proxies](/secure-connections/sauce-connect-5/guides/proxies).
28-
29-
## How can I share a Sauce Connect tunnel between multiple accounts?
30-
31-
To share a tunnel, start a tunnel with the [`-s / --shared-tunnel`](/dev/cli/sauce-connect-5/run/#shared) flag or with `SAUCE_SHARED` environment variable set.
32-
33-
(CIA) For most Sauce Labs customers, your access to shared tunnels is determined by the permissions of the user who creates them. Organization admins can create tunnels that any user on any team can use. Team admins can create tunnels that any member of their team can use. Team members cannot share tunnels they create with any other team member.
34-
35-
In order to use a tunnel that an admin or team member shares with you, you'll
36-
need to add [`tunnelOwner`](/dev/test-configuration-options/#tunnelowner)
37-
to your test capabilities and specify that person's username.
38-
39-
## How can I use Sauce Connect to test domain inavailability?
40-
41-
You can use the [`-F / --deny-domains`](/dev/cli/sauce-connect-5/run/#deny-domains) command-line option or `SAUCE_DENY_DOMAINS` environment variable to drop requests for domains matching the regexp. It can be used to simulate non-loading of scripts, styles, or other resources.
42-
43-
This flag can contain a list of regex that will match the domain that wants to be blocked. Example:
44-
45-
Entering this code -- `(www.)?google-analytics.com,(www.)?googletagmanager.com,([a-z0 9]+[.])*google.com,([a-z0-9]+[.])+facebook.com` -- will block the following domains:
17+
## Can Sauce Connect be managed by a service account?
4618

47-
- `www.google-analytics.com`
48-
- `google-analytics.com`
49-
- `google.com` and any subdomain of `google.com`
50-
- Any subdomain of `facebook.com`, but not `facebook.com`
19+
No, [service accounts](/basics/acct-team-mgmt/managing-service-accounts) cannot start or manage Sauce Connect instances. Only user accounts have the permissions required to create and manage tunnels.
5120

5221
## Can I access apps on localhost?
5322

54-
You can access `localhost` through Sauce Connect on Virtual Desktop Browser tests. However, you cannot proxy `localhost` or 127.0.0.1 connections on any Mobile tests, whether they are Emulators, Simulators, or Real Devices.
55-
56-
When using Sauce Connect Proxy, local websites running on commonly used ports are available to test at `localhost` or 127.0.0.1 URLs. The exception is when testing on Real or Virtual Mobile Devices. Real and Virtual Mobile tests require changes to the `/etc/hosts` file where Sauce Connect Proxy is hosted. For more information, see [Testing Mobile Devices Against localhost](/secure-connections/sauce-connect-5/guides/localhost-proxying/#configuring-mobile-devices-for-testing-localhost).
57-
58-
For all platforms, tests may perform better when using a locally defined domain name (which can be set in your [`hosts` file](http://en.wikipedia.org/wiki/Hosts_file)) rather than `localhost`. Using a locally defined domain name also allows access to apps on any port. If you are using a parent proxy with Sauce Connect, you may need the [`--proxy-localhost` flag](/dev/cli/sauce-connect-5/run/#proxy-localhost).
23+
Please refer to our [localhost proxying guide](/secure-connections/sauce-connect-5/guides/localhost-proxying).
5924

6025
## How can I improve tunnel performance?
6126

62-
See [Improving Sauce Connect Proxy Performance](/secure-connections/sauce-connect-5/guides/tunnels/#sc5perf).
63-
64-
## What are the supported ports on localhost?
65-
66-
See [Ports for proxying localhost traffic](/secure-connections/sauce-connect-5/guides/localhost-proxying).
67-
68-
## What are the optimal open file settings? {#sc5openfiles}
69-
70-
The [open file limit](https://www.tecmint.com/increase-set-open-file-limits-in-linux/) on macOS and other Unix-based systems limits the number of open file descriptors. Since a file descriptor is opened for each network connection, the open file limit also restricts the number of open network connections. Under normal usage, Sauce Connect Proxy can easily reach the default limit (1024 in most cases). This causes each new connection to time out, and results in failed tests. Modern systems allow much higher limits without any visible impact on memory, so we **recommend setting the open file limit to 64000** in order to ensure the open file limit is never an issue for tunneled requests.
71-
72-
## (CIA) If we have five users, should we use five instances of Sauce Connect Proxy or set up one shared instance?
73-
74-
Feel free to do either, even if you only have one Sauce account.
75-
76-
If you do decide to use five separate instances, you'll need to create unique identifiers for each. More information: **High Availability Sauce Connect 5 Setup needed**.
27+
To improve Sauce Connect 5 tunnel performance, start by ensuring that the instance running Sauce Connect has sufficient system resources. You can find recommended CPU and memory requirements in [System Requirements](/secure-connections/sauce-connect-5/system-requirements/#cpu-and-memory-resources).
7728

78-
## (CIA) Can I split testing traffic across multiple Sauce Connect Proxy tunnels?
29+
Another effective way to optimize performance is to reduce unnecessary traffic passing through the tunnel. You can use the [-F, --deny-domains](/dev/cli/sauce-connect-5/run#deny-domains) flag to block domains that do not need to be accessed during testing. This helps limit bandwidth usage and reduces load on the tunnel.
7930

80-
Sauce Connect Proxy offers some options for high availability that enable multiple Sauce Connect Proxy tunnels to be grouped into a pool, which is treated like a single tunnel. This has several advantages, including the ability to distribute the load of test traffic. More information: **High Availability Sauce Connect 5 Setup needed**.
31+
## How many tests can I run in each Sauce Connect instance?
8132

82-
## (CIA) Does Sauce Connect Proxy support running XCUITest and Espresso tests?
33+
The number of tests isn't the limiting factor — what matters is the amount of traffic those tests generate. Sauce Connect 5 performance depends on system resources and the number of concurrent HTTP requests.
8334

84-
Yes. More information: [Mobile Testing Frameworks](/mobile-apps/automated-testing/appium).
35+
As noted in the [system requirements](/secure-connections/sauce-connect-5/system-requirements), a single instance with 4 CPU cores can typically handle up to 4096 concurrent HTTP requests. To determine how many tests your instance can support, estimate the expected number of concurrent requests during peak test execution and scale accordingly.
8536

86-
## How many Sauce Connect Proxy tunnels can I keep open simultaneously?
37+
## How many Sauce Connect instances can I keep open simultaneously?
8738

88-
Your options depend on your license type. More information: [System and Network Requirements for Sauce Connect Proxy](/secure-connections/sauce-connect-5/system-requirements).
39+
The number of concurrent Sauce Connect instances you can run depends on your Sauce Labs contract. By default, the limit is 5 active instances, but this can be increased based on your plan. Contact your Sauce Labs representative if you need a higher limit.
8940

90-
## How many tests can I run in each Sauce Connect Proxy tunnel?
41+
## If we have five users, should we use five instances of Sauce Connect or set up one shared instance?
9142

92-
There are currently no limits on how many tests you can run in each tunnel, though we may eventually implement limitations to maintain service quality. More information: [System and Network Requirements for Sauce Connect Proxy](/secure-connections/sauce-connect-5/system-requirements).
43+
It depends on your team’s requirements. You can either run a separate Sauce Connect instance for each user or set up a [shared instance](/secure-connections/sauce-connect-5/guides/sharing-tunnel) — or even a shared [tunnel pool](/secure-connections/sauce-connect-5/guides/tunnel-pool/) — to match your capacity and traffic needs.
9344

94-
## Are there restrictions on who can use Sauce Connect Proxy tunnels for real device testing?
45+
A shared setup can simplify management and reduce resource usage, while individual instances offer isolation and flexibility. Choose the approach that best fits your workflow and performance expectations.
9546

96-
No, tunnels to the Real Device Cloud are automatically shared with all of your team members. More information: [Security Settings for Organizations](/basics/acct-team-mgmt/org-settings).
47+
## Can I run tests on Virtual Devices and Real Devices using the same Sauce Connect instance?
9748

98-
## Can I run tests on Virtual Devices and Real Devices using the same Sauce Connect Proxy tunnel?
49+
Yes, you can use the same Sauce Connect instance to test with the Virtual Device Cloud (VDC) and Real Device Cloud (RDC).
9950

100-
Yes, you can use the same Sauce Connect Proxy tunnel and/or same machine to test with the Virtual Device Cloud (VDC) and Real Device Cloud (RDC).
51+
## How can I use Sauce Connect to test domain unavailability?
10152

102-
## Are there any special parameters when using a PAC file in real device tests?
103-
104-
No, though you cannot use the `localhost` address with iOS and Android.
105-
106-
## Will Sauce Connect Proxy work with dynamic allocation of real devices?
107-
108-
Yes.
109-
110-
## Can you allowlist IP addresses instead of using Sauce Connect?
111-
112-
Testing your internal systems with Sauce Labs requires that our service is able to establish a secure connection. To create a secure connection, we strongly recommend using [Sauce Connect](/secure-connections/sauce-connect-5) or [Sauce IPSec Proxy](/secure-connections/ipsec-vpn) instead of allowlisting IP ranges.
113-
114-
Using our Sauce Connect tool, will provide the following benefits:
115-
116-
### Configurability
117-
118-
Sauce Connect Proxy provides many tools designed to improve the testing experience, from selective traffic routing to bandwidth restriction.
119-
120-
Each Sauce Connect Proxy instance can be assigned different network proxies, run on different hosts, allocated to different users and allowed access to different systems under test. This allows infrastructure teams great control and flexibility over system access.
121-
122-
Allowlisting provides no controls over which systems can be accessed by which users; anyone with the correct URL can access any service.
123-
124-
### Portability
125-
126-
Sauce Connect Proxy can be used in any part of your corporate infrastructure, with relatively minimal setup. It allows you to test systems in different environments, different locations, and different physical hosts. With a flexible Sauce Connect setup, a developer can run tests on their local machine, their staging service, their build server, and anywhere else required.
127-
128-
Allowlisting, in comparison, requires different routes and URLs for each environment under test. This places a maintenance burden on the networking team and leads to configuration problems for testers.
129-
130-
### Reliability and Ease of Maintenance
131-
132-
Once you're up and running with Sauce Connect Proxy, no maintenance is required; you'll only need to update to the new versions of our software, upon release.
133-
134-
Sauce Connect Proxy can be set up for multiple corporate users and multiple systems under test, at the same time.
135-
136-
With Sauce Connect Proxy, our support team can provide greater assistance debugging connectivity and reliability problems, thanks to improved logging and network tracking. Additionally, Sauce Connect Proxy's underlying network tools improve reliability over bad network connections.
137-
138-
### Security
139-
140-
Sauce Labs operates from a wide range of IP addresses, which you could allocate to any test environment at any time. By allowlisting these IP addresses, any Sauce Labs customer could conceivably send requests to your system under test, and your network infrastructure would allow it. Additionally, allowlisting does not provide tools for time-based access controls or easy disconnection.
141-
142-
By using Sauce Connect Proxy instead of allowlisting, your network will be secure. At the end of every Sauce Connect Proxy session, upon terminating the client, the connection between our service and your infrastructure is severed, allowing you fine-grained access control.
143-
144-
For more information about Sauce Connect Proxy™ and its security, see [this white paper](https://saucelabs.com/resources/white-papers/sauce-connect-proxy-security-overview).
53+
You can use the [`-F / --deny-domains`](/dev/cli/sauce-connect-5/run/#deny-domains) command-line option or `SAUCE_DENY_DOMAINS` environment variable to drop requests for domains matching the regexp. It can be used to simulate non-loading of scripts, styles, or other resources.
14554

146-
## Where can I get more in-depth information about Sauce Connect Proxy?
55+
This flag can contain a list of regex that will match the domain that wants to be blocked. Example:
14756

148-
[Sauce Connect Proxy white paper](https://saucelabs.com/resources/white-papers/sauce-connect-proxy-security-overview) contains an in-depth overview of the proxy and its security.
57+
Entering this code -- `(www.)?google-analytics.com,(www.)?googletagmanager.com,([a-z0 9]+[.])*google.com,([a-z0-9]+[.])+facebook.com` -- will block the following domains:
14958

150-
:::note
151-
Additional most frequent questions from customers will be put belo
152-
:::
59+
- `www.google-analytics.com`
60+
- `google-analytics.com`
61+
- `google.com` and any subdomain of `google.com`
62+
- Any subdomain of `facebook.com`, but not `facebook.com`

sidebars.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1005,6 +1005,7 @@ module.exports = {
10051005
items: [
10061006
'secure-connections/sauce-connect-5',
10071007
'secure-connections/sauce-connect-5/quickstart',
1008+
'secure-connections/sauce-connect-5/faq',
10081009
'secure-connections/sauce-connect-5/troubleshooting',
10091010
'secure-connections/sauce-connect-5/migrating',
10101011
{
@@ -1052,8 +1053,6 @@ module.exports = {
10521053
'secure-connections/sauce-connect-5/advanced/architecture',
10531054
],
10541055
},
1055-
// DO NOT include these sections before checked and improved
1056-
//'secure-connections/sauce-connect-5/faq',
10571056
],
10581057
},
10591058
{

0 commit comments

Comments
 (0)