Skip to content

Commit

Permalink
sauce-connect/quickstart: updating sc4/5 quickstart guides (#2626)
Browse files Browse the repository at this point in the history
  • Loading branch information
waggledans authored Feb 3, 2024
1 parent 62e438a commit 3442d67
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 7 deletions.
25 changes: 21 additions & 4 deletions docs/secure-connections/sauce-connect-5/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,16 @@ See the [installation instructions](/secure-connections/sauce-connect-5/installa
<details><summary>What is this?</summary>
This snippet contains your authentication credentials (username and access key), selects a Sauce Labs Data Center, and applies a name to your tunnel. Optionally, you can rename your tunnel by replacing the value after the <code>--tunnel-name</code> flag.
</details>
5. Paste the snippet into your terminal but **do not run it**. This snippet is not updated for Sauce Connect Proxy 5, it can only be used to get your username and your access key.
5. Paste the snippet into your terminal and run it. This will launch the tunnel.
6. Follow the steps in the [setup instructions](/secure-connections/sauce-connect-5/operation/overview/#running-sauce-connect-proxy) to start Sauce Connect Proxy 5 using the username and the access key obtained in the previous step.

## Verify Connection

To confirm your tunnel is up, look for the confirmation message in your terminal:<br/><img src={useBaseUrl('img/sauce-connect/cli-tunnel-confirmation.png')} alt="Sauce Connect Tunnel Success" width="350"/>
To confirm your tunnel is up, look for the confirmation message in your terminal:

```bash
Sauce Connect is up, you may start your tests
```

Alternatively, you can check your list of active tunnels on the **Tunnel Proxies** page:<br/><img src={useBaseUrl('img/sauce-connect/tunnelsuccess-ui.png')} alt="Sauce Connect Tunnel Success" width="500"/>

Expand Down Expand Up @@ -89,12 +93,25 @@ With your tunnel up and running, try doing a Live <!--or Automated--> local test

## Stop Tunnel

When you've finished testing, you can stop your tunnel from the terminal where Sauce Connect is running by entering Ctrl+C.<br/><img src={useBaseUrl('img/sauce-connect/cli-tunnel-stop.png')} alt="Sauce Connect Proxy Tunnels page snippet" width="500"/>
When you've finished testing, you can stop your tunnel from the terminal where Sauce Connect is running by entering Ctrl+C.
If there are jobs that use Sauce Connect Proxy connection, it will wait for them to finish.

```bash
2024/01/23 15:19:33.152509 [control] [INFO] Sauce Connect is up, you may start your tests
^C
2024/01/23 15:29:12.617959 [control] [INFO] waiting for 1 active job(s) to finish, timeout: 3h0m0s
2024/01/23 15:29:27.622295 [control] [INFO] waiting for 1 active job(s) to finish, timeout: 2h59m45s
2024/01/23 15:29:42.600553 [control] [INFO] waiting for 1 active job(s) to finish, timeout: 2h59m30s
2024/01/23 15:30:00.924115 [control] [INFO] tunnel was shutdown gracefully
```

Alternatively, you can go to the **Tunnel Proxies** page and click one of the **Stop Tunnels** buttons.<br/><img src={useBaseUrl('img/sauce-connect/tunnelstop-ui.png')} alt="Sauce Connect Tunnel Stop" width="800"/>

## More Information

- [Sauce Connect Proxy Overview](/secure-connections/sauce-connect/)
- [Sauce Connect Proxy Overview](/secure-connections/sauce-connect-5/)
- [Sauce Connect Proxy Configuration](/secure-connections/sauce-connect-5/operation/configuration)
- [Sauce Connect Proxy 5 CLI Reference](/dev/cli/sauce-connect-5/)
- [Uploading and Managing Mobile Apps in Sauce Labs](/mobile-apps/app-storage)
- [Live Testing Web Apps](/web-apps/live-testing/live-cross-browser-testing/)
- [Live Testing Mobile Apps](/mobile-apps/live-testing/live-mobile-app-testing/)
19 changes: 16 additions & 3 deletions docs/secure-connections/sauce-connect/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,21 @@ import TabItem from '@theme/TabItem';

Sauce Connect is required to run a local test on an app or website located behind a firewall. Get up and running with a basic Sauce Connect Proxy tunnel in minutes using the steps below.

:::caution Sauce Connect Proxy 5 is released
Please refer to [Sauce Connect Proxy 5 Quickstart Guide](/secure-connections/sauce-connect-5/quickstart/) for the latest quickstart guide.
:::

## What You'll Need

- A Sauce Labs account ([Log in](https://accounts.saucelabs.com/am/XUI/#login/) or sign up for a [free trial license](https://saucelabs.com/sign-up)).
- The localhost URL for your site or app under test.

## Start Tunnel

1. [Download the Sauce Connect Proxy client](/secure-connections/sauce-connect/installation/#downloading-sauce-connect-proxy) on your machine.
1. [Download the Sauce Connect Proxy 4 client](/secure-connections/sauce-connect/installation/#downloading-sauce-connect-proxy) on your machine.
:::caution Always use the latest version
Using older Sauce Connect versions may impact your ability to launch a tunnel or cause other technical issues.
We recommend using the newer [Sauce Connect Proxy 5](/secure-connections/sauce-connect-5/quickstart/) version.
:::
2. Extract the .zip file and move the folder to your machine's [home directory](https://en.wikipedia.org/wiki/Home_directory).
3. Open your terminal and navigate to the Sauce Connect Proxy client bin directory.
Expand Down Expand Up @@ -53,7 +58,14 @@ Sauce Connect is required to run a local test on an app or website located behin

</TabItem>
</Tabs>
4. Run the command
4. Log in to Sauce Labs.
5. Go to the [**Tunnel Proxies**](https://app.saucelabs.com/tunnels) page.<br/><img src={useBaseUrl('img/sauce-connect/tunnelsPage.png')} alt="Sauce Connect Proxy Tunnels page" width="400"/>
6. Under step 2, **Authenticate & connect**, copy the code snippet.<br/><img src={useBaseUrl('img/sauce-connect/configureAuth.png')} alt="Sauce Connect Proxy Tunnels page snippet" width="300"/>
<details><summary>What is this?</summary>
This snippet contains your authentication credentials (username and access key), selects a Sauce Labs Data Center, and applies a name to your tunnel. Optionally, you can rename your tunnel by replacing the value after the <code>--tunnel-name</code> flag.
</details>
7. Paste the snippet into your terminal but **do not run it**. This snippet is for [Sauce Connect Proxy 5](/secure-connections/sauce-connect-5/quickstart/), it can only be used to get your username and your access key.
8. Modify the snippet, see [Sauce Connect Proxy 5 Migration Guide](/secure-connections/sauce-connect-5/migrating/) for more details.

```bash
sc -u <your-user> -k <your access key> --region <us-west|eu-central> --tunnel-name your_tunnel_name
Expand Down Expand Up @@ -117,7 +129,8 @@ Alternatively, you can go to the **Tunnel Proxies** page and click one of the **

## More Information

- [Sauce Connect Proxy CLI](/dev/cli/sauce-connect-proxy/)
- [Sauce Connect Proxy 5 Quickstart Guide](/secure-connections/sauce-connect-5/quickstart/)
- [Sauce Connect Proxy 4 CLI](/dev/cli/sauce-connect-proxy/)
- [Setting Sauce Labs Environment Variables](/secure-connections/sauce-connect/setup-configuration/environment-variables/)
- [Uploading and Managing Mobile Apps in Sauce Labs](/mobile-apps/app-storage)
- [Live Testing Web Apps](/web-apps/live-testing/live-cross-browser-testing/)
Expand Down

0 comments on commit 3442d67

Please sign in to comment.