diff --git a/docs/secure-connections/sauce-connect-5/installation.md b/docs/secure-connections/sauce-connect-5/installation.md index c08328cd08..95906bb0a5 100644 --- a/docs/secure-connections/sauce-connect-5/installation.md +++ b/docs/secure-connections/sauce-connect-5/installation.md @@ -88,20 +88,20 @@ SHA256 checksums are available [here](https://saucelabs.com/downloads/sauce-conn - +  values={[ +    {label: 'Linux/macOS Binary', value: 'Linux/macOS'}, +    {label: 'Linux Debian', value: 'Debian'}, +    {label: 'Linux RPM', value: 'RPM'}, +    {label: 'macOS brew', value: 'brew'}, +    {label: 'Windows (Powershell)', value: 'Windows'}, +  ]}> + - ```bash - mkdir $HOME/sauce-connect-5.0.0-alpha && cd $HOME/sauce-connect-5.0.0-alpha - curl -sLO https://saucelabs.com/downloads/sauce-connect-5.0.0-alpha9/sauce-connect-5.0.0-alpha9_linux.x86_64.tar.gz - tar xzf sauce-connect-5.0.0-alpha9_linux.x86_64.tar.gz - ``` +```bash +mkdir $HOME/sauce-connect-5.0.0-alpha && cd $HOME/sauce-connect-5.0.0-alpha +curl -sLO https://saucelabs.com/downloads/sauce-connect-5.0.0-alpha9/sauce-connect-5.0.0-alpha9_linux.x86_64.tar.gz +tar xzf sauce-connect-5.0.0-alpha9_linux.x86_64.tar.gz +```
What's in the folder? @@ -123,43 +123,69 @@ defaultValue="Linux/macOS" +```bash +arch=$(dpkg --print-architecture) +sc_version=5.0.0-alpha9 +curl -sLO https://saucelabs.com/downloads/sauce-connect-${sc_version}/sauce-connect_${sc_version}.linux_${arch}.deb +sudo dpkg --skip-same-version --install sauce-connect_${sc_version}.linux_${arch}.deb +rm sauce-connect_${sc_version}.linux_${arch}.deb +``` + +
What does the Sauce Connect Debian package install + +- Sauce Connect Proxy binary is in `/usr/bin/sc` +- 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/#running-systemd-service-on-debian-based-linux) ```bash - arch=$(dpkg --print-architecture) - sc_version=5.0.0-alpha9 - curl -sLO https://saucelabs.com/downloads/sauce-connect-${sc_version}/sauce-connect_${sc_version}.linux_${arch}.deb - sudo dpkg --skip-same-version --install sauce-connect_${sc_version}.linux_${arch}.deb - rm sauce-connect_${sc_version}.linux_${arch}.deb + cat /etc/default/sauce-connect + # Default values for Sauce Connect Proxy + #SAUCE_CONFIG_FILE=/etc/sauce-connect/config.yaml + # Required values + #SAUCE_USER= + #SAUCE_ACCESS_KEY= + #SAUCE_REGION= + #SAUCE_TUNNEL_NAME= + # Options + #SAUCE_SHARED_TUNNEL= + #SAUCE_TUNNEL_POOL= + # See https://docs.saucelabs.com/dev/cli/sauce-connect-5/ for all environment variable values ``` +- Systemd service is enabled, see [Running systemd service on Debian-based Linux](/secure-connections/sauce-connect-5/operation/#running-systemd-service-on-debian-based-linux) + +
+
- ```bash - sudo rpm -i https://saucelabs.com/downloads/sauce-connect-5.0.0-alpha9/sauce-connect-5.0.0-alpha9_linux.x86_64.rpm - ``` +```bash +sudo rpm -i https://saucelabs.com/downloads/sauce-connect-5.0.0-alpha9/sauce-connect-5.0.0-alpha9_linux.x86_64.rpm +``` + - :::caution - To be updated - ::: +:::caution +To be updated +::: - ```bash - sudo rpm -i https://saucelabs.com/downloads/sauce-connect-5.0.0-alpha9/sauce-connect-5.0.0-alpha9_linux.x86_64.rpm - ``` +```bash +sudo rpm -i https://saucelabs.com/downloads/sauce-connect-5.0.0-alpha9/sauce-connect-5.0.0-alpha9_linux.x86_64.rpm +``` + - ```bash title="Using Powershell (Windows)" - Invoke-RestMethod -Uri https://saucelabs.com/downloads/sauce-connect-5.0.0-alpha9/sauce-connect-5.0.0-alpha9_windows.x86_64.zip -OutFile sauce-connect-5.0.0-alpha9.zip - Expand-Archive -Force -Path ./sauce-connect-5.0.0-alpha9.zip - ``` +```bash title="Using Powershell (Windows)" +Invoke-RestMethod -Uri https://saucelabs.com/downloads/sauce-connect-5.0.0-alpha9/sauce-connect-5.0.0-alpha9_windows.x86_64.zip -OutFile sauce-connect-5.0.0-alpha9.zip +Expand-Archive -Force -Path ./sauce-connect-5.0.0-alpha9.zip +``` + diff --git a/docs/secure-connections/sauce-connect-5/operation.md b/docs/secure-connections/sauce-connect-5/operation.md index 8e21a930c0..b49a3c5e61 100644 --- a/docs/secure-connections/sauce-connect-5/operation.md +++ b/docs/secure-connections/sauce-connect-5/operation.md @@ -96,15 +96,83 @@ sc run --user --access-key --region > /etc/sauce-connect/env +SAUCE_CONFIG_FILE=/etc/sauce-connect/sc.yaml +EOF +``` + +- Create a configuration file containing your Sauce Connect Proxy configuration + +```bash +cat <> /etc/sauce-connect/sc.yaml +region=us-west +user=xxx +access-key=xxx +tunnel-name=my-systemd-sc +EOF +``` + +3. Customize the systemd unit file + +- Running `systemctl edit sauce-connect` will open an editor that allows adding overrides +- Add your overrides (that systemd will save in `/etc/systemd/system/sauce-connect.service.d/override.conf`) + +```bash +[Service] +EnvironmentFile=/etc/sauce-connect/env +``` + +4. Validate your systemd overrides + +```bash +systemctl cat sauce-connect + # /lib/systemd/system/sauce-connect.service + [Unit] + Description=Sauce Connect Proxy Service + After=network-online.target + + [Service] + EnvironmentFile=/etc/default/sauce-connect + … + + # /etc/systemd/system/sauce-connect.service.d/override.conf + [Service] + EnvironmentFile=/etc/sauce-connect/env +``` + +5. Start the service + +```bash +systemctl start sauce-connect +``` ## More Information