Deploy connector

Connectors in Splashtop Secure Workspace enable integration with external systems or services, enhancing the capabilities of the platform. Follow the steps below to deploy a connector.

Step 1: Accessing the Deployment Section

1. Log in to your Splashtop Secure Workspace super admin account or org admin account using your credentials.
2. Once logged in, navigate to the Deployment menu and select Connector.

Step 2: Adding a Connector

1. In the Connector section, locate the Add Connector button.
2. Click on the button to initiate the connector deployment process.

Step 3: Selecting Deployment Method

There are two ways to deploy connectors in Splashtop Secure Workspace:

a. With the SSW Desktop App:

• Install a connector using the SSW Desktop App on Windows, Mac, or Linux machines.

b. Headless / CLI:

• Install a connector using CLI commands for Kubernetes, Helm, or Docker instances.
  
  Choose the appropriate deployment method based on your requirements and proceed with the relevant instructions below.

With the SSW Desktop App

1. Choose your environment
2. Choose an architecture
3. Download and install the SSW Desktop App from the provided link.

4. Install the SSW Desktop App on your machine by following the installation instructions.
5. Run the SSW Desktop App.
6. If required, input your organization name or any other necessary details.
7. Log in using the administrator account credentials.
8. From the left-hand side navigation menu, choose "Connector".
9. Follow the provided instructions to add a connector.

Headless / CLI

1. In the Headless / CLI deployment method, you will need to provide the following details for the connector:
   • Connector Name: Enter a unique name for the connector.
   • Display Name: Optionally, provide a display name for the connector.
   • Network: Select the appropriate network for the connector. You can manage Network here:
     Network Configuration
   • Edge Location: Specify the desired edge location for the connector.
   • "Auto Bandwidth Detection": Choose whether to enable or disable auto bandwidth detection for the connector.
   • Cluster Mode: Enable this option if you want the connector to run in cluster mode, allowing multiple connector instances for high availability.
2. If you want to enable Application Discovery, provide the following information:
   • Scan Interval (in minutes): Specify the interval at which application discovery scans should be performed.
   • IP range: Define the IP range using CIDR format (e.g., 192.168.20.0/24), IP range format (e.g., 192.168.20.0-192.168.20.100), or static IP format (e.g., 192.168.20.0) separated by commas.
   • Protocols: Select from the system's built-in protocols (e.g., DNS/53, HTTP/80), or provide specific ports to scan separated by commas.

3. Using the CLI commands for your specific environment (Kubernetes, Helm, or Docker), execute the necessary commands to install and run the connector.
4. Once the CLI commands are executed, the web page will display the status of the connector deployment. If cluster mode is enabled, you will be able to add up to 5 instances for the connector cluster.

Step 4: Completion and Verification

Once the connector deployment process is complete, you can verify its successful installation and functionality. Ensure that the connector appears in the list of deployed connectors within the Splashtop Secure Workspace Connector section.