Skip to content

Commit e4bebd3

Browse files
authored
Merge branch 'main' into fix-local-setup
2 parents f8162ca + 8559d98 commit e4bebd3

File tree

14 files changed

+95
-183
lines changed

14 files changed

+95
-183
lines changed

docs/basics/acct-team-mgmt/managing-service-accounts.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -141,4 +141,4 @@ Jobs run by service accounts are displayed on the [Automated Test Results page](
141141

142142
### Using Sauce Connect Proxy with a Service Account
143143

144-
If you plan to run tests through a [Sauce Connect Proxy tunnel](/secure-connections/), be mindful of tunnel sharing options. Service accounts cannot create or manage tunnels, so you must use a tunnel that has been shared with the service account’s assigned team. For detailed configuration instructions, refer to the [shared tunnels section](/secure-connections/sauce-connect-5/guides/overview/#shared-tunnels).
144+
If you plan to run tests through a [Sauce Connect Proxy tunnel](/secure-connections/), be mindful of tunnel sharing options. Service accounts cannot create or manage tunnels, so you must use a tunnel that has been shared with the service account’s assigned team. For detailed configuration instructions, refer to the [sharing tunnel guide](/secure-connections/sauce-connect-5/guides/sharing-tunnel/).

docs/basics/acct-team-mgmt/sauce-connect-proxy-tunnels.md

-15
This file was deleted.

docs/dev/cli/sauce-connect-5/sc_run.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ This flag is, primarily, used by Sauce Labs to assign custom properties to the t
6666

6767
Share the tunnel within the same org unit.
6868
Only the 'all' option is currently supported.
69-
See [here](/basics/acct-team-mgmt/sauce-connect-proxy-tunnels/).
69+
See [here](/secure-connections/sauce-connect-5/guides/sharing-tunnel/).
7070

7171
### `-t, --tunnel-pool` {#tunnel-pool}
7272

docs/dev/cli/sauce-connect-proxy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ You can view the entire list of CLI options by running the `--help` flag.
9797

9898
<p><small>| OPTIONAL | <span className="sauceGreen">4.8.x</span> <span className="sauceGreen">4.9.x</span> | </small></p>
9999

100-
**Description**: Changes tunnel sharing permissions so that all users in an organization can use Sauce Connect Proxy tunnels, rather than just the tunnel owner (admin). For more information, see [Sharing Sauce Connect Proxy Tunnels](/basics/acct-team-mgmt/sauce-connect-proxy-tunnels).<br/>
100+
**Description**: Changes tunnel sharing permissions so that all users in an organization can use Sauce Connect Proxy tunnels, rather than just the tunnel owner (admin). For more information, see [Sharing Sauce Connect Proxy Tunnels](/secure-connections/sauce-connect-5/guides/sharing-tunnel/).<br/>
101101
**Environment variable**: `SAUCE_SHARED_TUNNEL`<br/>
102102
**Shorthand**: `-s`
103103

docs/secure-connections.md

+7-13
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,15 @@ To determine which solution is best for you, see [Overview of Sauce Labs Securit
1515
See our [Sauce Connect Proxy Security Overview](https://saucelabs.com/resources/white-papers/sauce-connect-proxy-security-overview) white paper for information about optimizing your network and development environment for Sauce Connect Proxy performance.
1616

1717
<div className="box-wrapper" markdown="1">
18-
<div className="box box1 card">
19-
<div className="container">
20-
<h3><a href="/secure-connections/sauce-connect-5">Sauce Connect Proxy Overview</a></h3>
21-
<p>Learn about Sauce Connect Proxy and why we recommend it over allowlisting individual IP addresses.</p>
22-
</div>
23-
</div>
24-
<div className="box box2 card">
25-
<div className="container">
26-
<h3><a href="/secure-connections/sauce-connect-5/quickstart/">Quickstart</a></h3>
27-
<p>Get up and running with Sauce Connect Proxy in minutes.</p>
28-
</div>
29-
</div>
18+
<div className="box box1 card">
19+
<div className="container">
20+
<h3><a href="/secure-connections/sauce-connect-5">Sauce Connect Proxy Overview</a></h3>
21+
<p>Learn about Sauce Connect Proxy and why we recommend it over allowlisting individual IP addresses.</p>
22+
</div>
23+
</div>
3024
<div className="box box3 card">
3125
<div className="container">
32-
<h3><a href="/secure-connections/sauce-connect-5/guides/overview">Setup and Configuration</a></h3>
26+
<h3><a href="/secure-connections/sauce-connect-5/quickstart/">Quickstart</a></h3>
3327
<p>Learn how to launch a basic Sauce Connect Proxy tunnel configuration. Once you’re connected, use our code samples to run your first test.</p>
3428
</div>
3529
</div>

docs/secure-connections/sauce-connect-5/guides/configuration.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ To launch a tunnel using a **config.yml** file option.
302302
<TabItem value="Windows">
303303

304304
```bash
305-
sc.exe run -c %HOMEPATH%\sc\config.yml
305+
sauce-connect.exe run -c %HOMEPATH%\sc\config.yml
306306
```
307307

308308
</TabItem>
@@ -379,7 +379,7 @@ You can persist Sauce Connect Proxy environment variables by adding them to one
379379
6. Confirm that your environment variables have been set by typing `echo %SAUCE_USERNAME%` in your terminal. The response should be your username value. Then do the same for your access key.
380380
7. Starting a new Sauce Connect Proxy will not require adding required flags.
381381
```bash
382-
sc.exe
382+
sauce-connect.exe
383383
```
384384

385385
</TabItem>

docs/secure-connections/sauce-connect-5/guides/logging.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Logs are automatically rotated when running Sauce Connect Proxy 5 as a Linux Sys
1818
For other setups, use the `logrotate` utility.
1919

2020
:::note
21-
The logrotate integration in Linux and macOS is available in **Sauce Connect Proxy 5.1.2** and later.
21+
The logrotate integration in Linux and macOS is available since **Sauce Connect Proxy 5.1.2**.
2222
:::
2323

2424
### Linux

docs/secure-connections/sauce-connect-5/guides/overview.md

-117
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
id: sharing-tunnel
3+
title: Sauce Connect Proxy Sharing Tunnel
4+
sidebar_label: Sharing Tunnel
5+
---
6+
7+
import useBaseUrl from '@docusaurus/useBaseUrl';
8+
import Tabs from '@theme/Tabs';
9+
import TabItem from '@theme/TabItem';
10+
11+
Sauce Connect Proxy supports tunnel sharing within an organization, enabling multiple users or service accounts to access the same tunnel.
12+
13+
To enable sharing, start Sauce Connect Proxy with the [`--shared all`](/dev/cli/sauce-connect-5/run/#shared) flag.
14+
15+
### Access Based on User Roles
16+
17+
The ability to use a Sauce Connect Proxy tunnel depends on the role of the user who starts the tunnel.
18+
19+
| **Role** | **Can Share Tunnels With** | **Can Use Tunnels Created By** | **Can Stop Tunnels Created By** |
20+
|--------------------|----------------------------------|-----------------------------------------------|-----------------------------------|
21+
| Organization Admin | Any user | Any user | Any user |
22+
| Team Admin | All members of their team | Organization admins, team members, themselves | Themselves and other team members |
23+
| Team Member | All members of their team | Organization admins, team members, themselves | Only themselves |
24+
| Service Account | ❌ Cannot create or share tunnels | Organization admins, team members | ❌ Cannot stop any tunnels |
25+
26+
For details about user roles and permissions, see [User Roles](/basics/acct-team-mgmt/managing-user-info/#user-roles).
27+
28+
### Using a Shared Tunnel
29+
30+
To use a shared tunnel in your test, set the [`tunnelOwner`](/dev/test-configuration-options/#tunnelowner) capability in your test configuration to the **username** of the tunnel owner.

docs/secure-connections/sauce-connect-5/guides/tunnel-pool.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ sc run --username $SAUCE_USERNAME --access-key $SAUCE_ACCESS_KEY \
6868
<TabItem value="windows">
6969

7070
```bash
71-
sc.exe run --username %SAUCE_USERNAME% --access-key %SAUCE_ACCESS_KEY% ^
71+
sauce-connect.exe run --username %SAUCE_USERNAME% --access-key %SAUCE_ACCESS_KEY% ^
7272
--tunnel-name tunnel_name_here ^
7373
--tunnel-pool
7474
```

docs/secure-connections/sauce-connect-5/installation/windows.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Sauce Connect provides `.zip` package that can be used on older Windows versions
8484
mkdir C:\sauce-connect
8585
Invoke-WebRequest -Uri https://saucelabs.com/downloads/sauce-connect/5.2.3/sauce-connect-5.2.3_windows.x86_64.zip -OutFile sauce-connect.zip
8686
Expand-Archive -Path sauce-connect.zip -DestinationPath C:\sauce-connect
87-
Rename-Item -Path C:\sauce-connect\sauce-connect.exe -NewName C:\sauce-connect\sc.exe
87+
Rename-Item -Path C:\sauce-connect\sauce-connect.exe -NewName C:\sauce-connect\sauce-connect.exe
8888
```
8989

9090
### Edit Config File
@@ -96,7 +96,7 @@ Get the default configuration file:
9696

9797
```powershell
9898
cd C:\sauce-connect
99-
./sc.exe run config-file > sauce-connect.yaml
99+
./sauce-connect.exe run config-file > sauce-connect.yaml
100100
```
101101

102102
Edit the configuration file with your favorite editor:
@@ -108,5 +108,5 @@ notepad sauce-connect.yaml
108108
### Start Sauce Connect
109109

110110
```powershell
111-
./sc.exe run --config-file sauce-connect.yaml
111+
./sauce-connect.exe run --config-file sauce-connect.yaml
112112
```

0 commit comments

Comments
 (0)