SecureTunnel Command Line

• The SecureTunnel executable is available in form of a command-line utility, a desktop application, and the Enterprise Connection Manager.

  The command-line utility is helpful when you need to automate the tunnel start and stop.

• The utility works on Windows, Linux and Mac OS systems.

• It works with both HTTP and HTTPS traffic.

• The utility is resource friendly. It doesn’t have any specific requirements and can run on almost any machine, even on a “weak” one.

• For details of the tunnel functioning, see Local Testing — Secure Tunnels.

1. You can download the SecureTunnel command-line utility from the product UI.

   See instructions

   See instructionsSee instructions

   1. Log in to CrossBrowserTesting and click Secure Tunnel in the toolbar.

   2. In the subsequent dialog box, switch to the Command Line tab and click the link to download the Secure Tunnel executable:

      

      Click the image to enlarge it.

      Note:

      CrossBrowserTesting automatically provides the package that matches your operating system: Windows, Linux, or MacOS.

   – OR –

   You can use these links to download the utility:

   Windows:	https://sbsecuretunnel.s3.amazonaws.com/cli/windows/SBSecureTunnel.exe
   Linux:	https://sbsecuretunnel.s3.amazonaws.com/cli/linux/SBSecureTunnel
   MacOS:	https://sbsecuretunnel.s3.amazonaws.com/cli/macos/SBSecureTunnel

2. That’s all. You can run the downloaded executable as it is.

   Depending on the security settings, the operating system may ask your permission to run it. Grant the permission.

In general case, you can start the tunnel from the CrossBrowserTesting website or on your computer (see SecureTunnel Desktop App). Using the command-line utility implies that you start the tunnel  from your computer. Open the command line window and enter the command like this:

Here, --username is your CrossBrowserTesting account (email address), and --authkey is your authentication key (also called API key). --acceptAllCerts commands the tunnel to accept security certificates. For detailed information on supported command-line parameters, see below.

Tip: You can get the needed command line at any time on the CrossBrowserTesting website: open the Secure Tunnel dialog box and select the needed options on the Command Line tab. The dialog will update the sample command line respectively:

Click the image to enlarge it.

The tunnel connects to the geo.tunnel.smartbear.com server through port 443. It is important that proxies and firewalls running in your network allow connection to this URL and port.

However, if your organization uses the Enterprise Connection Manager, then the connection to this URL and port is needed for that Manager. The tunnels that users set up on their machines don’t need it.

After the tunnel is up and running, you can create or run your tests as you regularly do. For details, see the following links:

Important notes:

• When you have the tunnel up and running, tests of all types — live, screenshots, automated (Record and Replay, Selenium, and others) — will send their traffic through that tunnel.

• It’s important to check if the tunnel is on before you start testing. See how you can do this.

• Due to specifics of some operating systems and browsers, the URLs that include localhost, local or 127.0.0.1 may not open through the tunnel. For information on possible workarounds, see How to refer to local resources.

Option 1 – From the web site

Regardless of the way you started the tunnel, you can close it on the CrossBrowserTesting website: open the Secure Tunnel dialog box and click Disconnect.

Click the image to enlarge it.

Option 2 – From your computer

The utility supports special parameters to enable you to configure every aspect of tunnel functioning. The parameters can be organized into the following logical groups:

By using the SBSecureTunnel command-line utility, you can start SecureTunnel in various configurations. In every call, you should specify these parameters:

• --username is the name of your CrossBrowserTesting account (for example, [email protected]).

• --authkey is your authentication key (also called API key).

  How to get the authentication key

  How to get the authentication keyHow to get the authentication key

  1. Log in to CrossBrowserTesting, click the user icon in the top-right corner, and select Manage Account.

  2. From the User Profile section, copy the Authkey value:

     

     Click the image to enlarge it.

  — OR —

  1. Log in to CrossBrowserTesting and go to Automation > Getting Started.

  2. Expand the Username / Auth Key block and copy the Authkey value:

     

     Click the image to enlarge it.

In most cases, you will run the utility with the following parameters:

This call initiates the tunnel of the Internal Websites type with the the Accept all SSL certificates and Bypass tunnel for public URLs settings enabled (for more information on them, see Tunnel Settings).

Note that the Internal Websites mode is used by default and doesn’t require any command-line argument for activation. The same is with the Bypass … setting.

By default, the utility runs the tunnel in the Internal Websites mode. If you want to run it in other modes — Local HTML files or Proxy Server — you need to add special parameters to the command line.

Run in Local HTML Files mode

Run in Proxy Server mode

Bypass tunnel for public URLs

Accept all SSL certificates