Skip to content

Commit a7dac2d

Browse files
committed
dosc/sc5: rework installation docs
This patch makes install section for each of the platforms. This gives a nice structure. Linux, macOS, and Windows instructions were rewritten. Docker and Kubernetes instructions were only moved, the content needs to be reworked. Fixes SC-4583
1 parent 5c090b6 commit a7dac2d

File tree

9 files changed

+403
-229
lines changed

9 files changed

+403
-229
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,22 @@
11
---
22
id: installation
3-
title: Downloading Sauce Connect Proxy 5
4-
sidebar_label: Install
3+
title: Install Sauce Connect
4+
sidebar_label: Installation
55
---
66

7-
import useBaseUrl from '@docusaurus/useBaseUrl';
8-
import ScTable from '../../../src/components/scTable.jsx';
9-
import Tabs from '@theme/Tabs';
10-
import TabItem from '@theme/TabItem';
7+
### Installation Instructions (recommended)
118

12-
:::caution
13-
See [this document](/secure-connections/sauce-connect/installation/) for the most recent Sauce Connect 4.x.x version download instructions.
14-
:::
9+
Visit the following pages for installation instructions for your platform:
10+
- [Linux](/secure-connections/sauce-connect-5/installation/linux)
11+
- [MacOS](/secure-connections/sauce-connect-5/installation/macos)
12+
- [Windows](/secure-connections/sauce-connect-5/installation/windows)
13+
- [Docker](/secure-connections/sauce-connect-5/installation/docker)
14+
- [Kubernetes](/secure-connections/sauce-connect-5/installation/kubernetes)
1515

16-
This topic describes how to install Sauce Connect Proxy version 5 to your machine.
16+
### Download Links
1717

18-
## What You’ll Need
18+
If you prefer to do custom installation, you can download Sauce Connect binaries from the following links.
1919

20-
- 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)).
21-
22-
## Downloading Sauce Connect Proxy
23-
24-
Download the latest Sauce Connect Proxy 5 to your local machine by clicking the link below corresponding to your OS and the CPU architecture.
2520
SHA256 checksums are available [here](https://saucelabs.com/downloads/sauce-connect/5.0.0/checksums).
2621

2722
<table>
@@ -64,154 +59,21 @@ SHA256 checksums are available [here](https://saucelabs.com/downloads/sauce-conn
6459
</td>
6560
</tr>
6661
<tr>
67-
<td>Windows x86_64</td>
62+
<td>macOS</td>
6863
<td>
69-
<a href="https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect-5.0.0_windows.x86_64.zip">https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect-5.0.0_windows.x86_64.zip</a>
64+
<a href="https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect-5.0.0_darwin.all.zip">https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect-5.0.0_darwin.all.zip</a>
7065
</td>
7166
</tr>
7267
<tr>
73-
<td>Windows arm64</td>
68+
<td>Windows x86_64</td>
7469
<td>
75-
<a href="https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect-5.0.0_windows.aarch64.zip">https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect-5.0.0_windows.aarch64.zip</a>
70+
<a href="https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect-5.0.0_windows.x86_64.zip">https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect-5.0.0_windows.x86_64.zip</a>
7671
</td>
7772
</tr>
7873
<tr>
79-
<td>macOS</td>
74+
<td>Windows arm64</td>
8075
<td>
81-
<a href="https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect-5.0.0_darwin.all.zip">https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect-5.0.0_darwin.all.zip</a>
76+
<a href="https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect-5.0.0_windows.aarch64.zip">https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect-5.0.0_windows.aarch64.zip</a>
8277
</td>
8378
</tr>
8479
</table>
85-
86-
## Installing Sauce Connect Proxy
87-
88-
<Tabs
89-
defaultValue="Linux"
90-
  values={[
91-
    {label: 'Linux', value: 'Linux'},
92-
    {label: 'macOS', value: 'macOS'},
93-
    {label: 'Windows', value: 'Windows'},
94-
  ]}>
95-
<TabItem value="Linux">
96-
97-
#### Binary
98-
99-
```bash title="Download binary"
100-
mkdir $HOME/sauce-connect-5.0.0 && cd $HOME/sauce-connect-5.0.0
101-
curl -sLO https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect-5.0.0_linux.x86_64.tar.gz
102-
tar xzf sauce-connect-5.0.0_linux.x86_64.tar.gz && rm sauce-connect-5.0.0_linux.x86_64.tar.gz
103-
```
104-
105-
<details><summary>What's in the folder?</summary>
106-
107-
#### Sauce Connect folder contents
108-
109-
```bash
110-
├── LICENSE
111-
├── LICENSE.3RD_PARTY
112-
├── completions
113-
│   ├── sc.bash
114-
│   ├── sc.fish
115-
│   └── sc.zsh
116-
└── sc
117-
```
118-
119-
</details>
120-
121-
#### Debian
122-
```bash title="Install a Debian package"
123-
arch=$(dpkg --print-architecture)
124-
sc_version=5.0.0
125-
curl -sLO https://saucelabs.com/downloads/sauce-connect/${sc_version}/sauce-connect_${sc_version}.linux_${arch}.deb
126-
sudo dpkg --skip-same-version --install sauce-connect_${sc_version}.linux_${arch}.deb
127-
rm sauce-connect_${sc_version}.linux_${arch}.deb
128-
```
129-
130-
<details><summary>What does the Sauce Connect Debian package install</summary>
131-
132-
- Sauce Connect Proxy binary is in `/usr/bin/sc`
133-
- The enviroment variables file template is in `/etc/default/sauce-connect`. The file may be modified to include your configuration, , see [Running systemd service on Debian-based Linux](/secure-connections/sauce-connect-5/operation/systemd/)
134-
```bash
135-
cat /etc/default/sauce-connect
136-
# Default values for Sauce Connect Proxy
137-
#SAUCE_CONFIG_FILE=/etc/sauce-connect/config.yaml
138-
# Required values
139-
#SAUCE_USERNAME=
140-
#SAUCE_ACCESS_KEY=
141-
#SAUCE_REGION=
142-
#SAUCE_TUNNEL_NAME=
143-
# Options
144-
#SAUCE_SHARED=all
145-
#SAUCE_TUNNEL_POOL=
146-
# See https://docs.saucelabs.com/dev/cli/sauce-connect-5/ for all environment variable values
147-
```
148-
- Systemd service is enabled, see [Running systemd service on Debian-based Linux](/secure-connections/sauce-connect-5/operation/systemd/)
149-
150-
</details>
151-
152-
#### RPM
153-
154-
```bash title="Install an RPM package"
155-
sudo rpm -i https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect-5.0.0_linux.x86_64.rpm
156-
```
157-
158-
</TabItem>
159-
160-
<TabItem value="macOS">
161-
162-
#### Homebrew
163-
164-
```bash title="Homebrew (recommended)"
165-
brew install saucelabs/tap/sauce-connect
166-
```
167-
168-
#### Binary
169-
170-
```bash title="Download binary"
171-
mkdir $HOME/sauce-connect-5.0.0 && cd $HOME/sauce-connect-5.0.0
172-
curl -sLO "https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect-5.0.0_darwin.all.zip"
173-
unzip sauce-connect-5.0.0_darwin.all.zip && rm sauce-connect-5.0.0_darwin.all.zip
174-
```
175-
176-
<details><summary>What's in the folder?</summary>
177-
178-
#### Sauce Connect folder contents
179-
180-
```bash
181-
├── LICENSE
182-
├── LICENSE.3RD_PARTY
183-
├── completions
184-
│   ├── sc.bash
185-
│   ├── sc.fish
186-
│   └── sc.zsh
187-
└── sc
188-
```
189-
190-
</details>
191-
192-
</TabItem>
193-
194-
<TabItem value="Windows">
195-
196-
```bash title="Using Powershell (Windows)"
197-
Invoke-RestMethod -Uri https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect-5.0.0_windows.x86_64.zip -OutFile sauce-connect-5.0.0.zip
198-
Expand-Archive -Force -Path ./sauce-connect-5.0.0.zip
199-
```
200-
201-
</TabItem>
202-
</Tabs>
203-
204-
## Running Sauce Connect in Docker
205-
206-
See [this guide](/secure-connections/sauce-connect-5/operation/docker/)
207-
208-
## Running Sauce Connect in Kubernetes
209-
210-
See [this guide](/secure-connections/sauce-connect-5/operation/kubernetes/)
211-
212-
## More Information
213-
214-
- [Sauce Connect Proxy Changelog](https://changelog.saucelabs.com/en?category=sauce%20connect)
215-
- [Sauce Connect Proxy 5 Administration](/secure-connections/sauce-connect-5/operation/overview/)
216-
- [Sauce Connect Proxy 5 CLI Reference](/dev/cli/sauce-connect-5/)
217-
- [Sauce Connect Proxy Architecture](/secure-connections/sauce-connect-5/advanced/architecture/)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,186 @@
1+
---
2+
id: linux
3+
title: Install Sauce Connect on Linux
4+
sidebar_label: Linux
5+
---
6+
7+
import useBaseUrl from '@docusaurus/useBaseUrl';
8+
import Tabs from '@theme/Tabs';
9+
import TabItem from '@theme/TabItem';
10+
11+
## Debian/Ubuntu
12+
13+
Sauce Connect provides `.deb` package with Systemd service for [Sauce Connect run](/dev/cli/sauce-connect-5/run.md) command.
14+
Other commands are available as well, but you will need to start them manually.
15+
16+
### Install package
17+
18+
<Tabs
19+
defaultValue="ARM64"
20+
  values={[
21+
    {label: 'ARM64', value: 'ARM64'},
22+
    {label: 'x86-64', value: 'x86-64'},
23+
  ]}>
24+
<TabItem value="ARM64">
25+
26+
```bash
27+
curl -L -o sauce-connect.deb https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect_5.0.0.linux_arm64.deb
28+
sudo dpkg -i sauce-connect.deb
29+
```
30+
</TabItem>
31+
32+
<TabItem value="x86-64">
33+
34+
```bash
35+
curl -L -o sauce-connect.deb https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect_5.0.0.linux_amd64.deb
36+
sudo dpkg -i sauce-connect.deb
37+
```
38+
39+
</TabItem>
40+
</Tabs>
41+
42+
### Edit config file
43+
44+
```bash
45+
sudo vim /etc/sauce-connect/sauce-connect.yaml
46+
```
47+
48+
### Enable and start Sauce Connect service
49+
50+
```bash
51+
sudo systemctl enable sauce-connect
52+
sudo systemctl start sauce-connect
53+
```
54+
55+
### Check Sauce Connect Status
56+
57+
```bash
58+
sudo systemctl status sauce-connect
59+
```
60+
61+
## RedHat/CentOS/Fedora
62+
63+
Sauce Connect provides `.rpm` package with Systemd service for [Sauce Connect run](/dev/cli/sauce-connect-5/run.md) command.
64+
Other commands are available as well, but you will need to start them manually.
65+
66+
67+
### Install package
68+
69+
<Tabs
70+
defaultValue="ARM64"
71+
  values={[
72+
    {label: 'ARM64', value: 'ARM64'},
73+
    {label: 'x86-64', value: 'x86-64'},
74+
  ]}>
75+
<TabItem value="ARM64">
76+
77+
```bash
78+
sudo rpm -i https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect-5.0.0_linux.aarch64.rpm
79+
```
80+
</TabItem>
81+
82+
<TabItem value="x86-64">
83+
84+
```bash
85+
sudo rpm -i https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect-5.0.0_linux.x86_64.rpm
86+
```
87+
88+
</TabItem>
89+
</Tabs>
90+
91+
### Edit config file
92+
93+
```bash
94+
sudo vim /etc/sauce-connect/sauce-connect.yaml
95+
```
96+
97+
### Enable and start Sauce Connect service
98+
99+
```bash
100+
sudo systemctl enable sauce-connect
101+
sudo systemctl start sauce-connect
102+
```
103+
104+
### Check Sauce Connect Status
105+
106+
```bash
107+
sudo systemctl status sauce-connect
108+
```
109+
110+
## Generic
111+
112+
### Unpack the tarball
113+
114+
<Tabs
115+
defaultValue="ARM64"
116+
  values={[
117+
    {label: 'ARM64', value: 'ARM64'},
118+
    {label: 'x86-64', value: 'x86-64'},
119+
  ]}>
120+
<TabItem value="ARM64">
121+
122+
```bash
123+
curl -L -o sauce-connect.tar.gz https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect-5.0.0_linux.aarch64.tar.gz
124+
sudo mkdir -p /opt/sauce-connect
125+
sudo tar -C /opt/sauce-connect -xzf sauce-connect.tar.gz
126+
```
127+
</TabItem>
128+
129+
<TabItem value="x86-64">
130+
131+
```bash
132+
curl -L -o sauce-connect.tar.gz https://saucelabs.com/downloads/sauce-connect/5.0.0/sauce-connect-5.0.0_linux.x86_64.tar.gz
133+
sudo mkdir -p /opt/sauce-connect
134+
sudo tar -C /opt/sauce-connect -xzf sauce-connect.tar.gz
135+
```
136+
137+
</TabItem>
138+
</Tabs>
139+
140+
141+
### Link the binary
142+
143+
```bash
144+
sudo ln -s /opt/sauce-connect/sc /usr/local/bin/sc
145+
```
146+
147+
### Add bash completion
148+
149+
<Tabs
150+
defaultValue="User"
151+
  values={[
152+
    {label: 'User', value: 'User'},
153+
    {label: 'System', value: 'System'},
154+
  ]}>
155+
<TabItem value="User">
156+
157+
```bash
158+
echo 'source <(sc completion bash)' >>~/.bash_profile
159+
```
160+
</TabItem>
161+
162+
<TabItem value="System">
163+
164+
```bash
165+
sudo mkdir -p /etc/bash_completion.d
166+
sudo ln -s /opt/sauce-connect/completions/sc.bash /etc/bash_completion.d/sc
167+
```
168+
169+
</TabItem>
170+
</Tabs>
171+
172+
### Edit config file
173+
174+
This step is optional. You can use default configuration or configure Sauce Connect with flags or environment variables.
175+
See [CLI reference](/dev/cli/sauce-connect-5/) for more details.
176+
177+
178+
```bash
179+
vim /opt/sauce-connect/sauce-connect.yaml
180+
```
181+
182+
### Start Sauce Connect
183+
184+
```bash
185+
sc run --config-file /opt/sauce-connect/sauce-connect.yaml
186+
```

0 commit comments

Comments
 (0)