1. Splashtop On-Prem - Support
  2. Getting Started
  3. Installation

Quick Setup Guide

Avatar
Splashtop

Splashtop On-Prem builds around the idea to facilitate easy setup, please follow this guide to finish installation. 

Key components:

  • Splashtop Gateway: Performs Gateway, Relay, User, and Device management functions. This is the central server that authenticates, secures, and connects users and devices.  It provides a Web Console to configure (and report of) users and devices.  It is designed to install on a Windows PC server.
  • Splashtop On-Prem app: Application makes it possible to establish remote sessions between local device and the target remote device running Splashtop Streamer.
  • Splashtop Streamer: Software needs to be installed and running on the remote device you would like to access to. It streams audio and video to the On-Prem app device.

oobe_new_diane.png

General guidelines for installation:

The basic steps to get Splashtop software up and running will typically look like the followings. The first five steps should be done by you, the Team Owner or Admin, and the remaining two will be done by members.

  1. Team Owner sets up Splashtop Gateway on the company network.
  2. Team Owner groups the computers as desired, and sets permissions accordingly.
  3. Team Owner creates user accounts
  4. Team Owner notifies users that they have been added to Splashtop Gateway, and provides specific credentials to them such as activation code and password.
  5. Team Owner or Admin deploys the Streamers and install them on all the target computers available for users to remote access.
  6. User downloads the Splashtop On-Prem client app via Splashtop Gateway web console to his/her device and install.
  7. User launches Splashtop On-Prem client app and enter IP address of Gateway, account name and password given by Team Owner or Admin (change later at first web console login). User can then establish secured remote sessions with computer in work environment.

Splashtop Gateway and Splashtop Steamer can be installed on the same Windows server.  In fact, it is a good practice since remote access to that server can be provided in case Team Owner needs to configure Splashtop Gateway settings or restart the Splashtop Gateway service.

 

2. Install Splashtop Gateway

a) Download your program and double click the MSI file to begin installing by going through Windows Install Wizard. 

installer1.PNG

b) After the installation finished, go to Windows Startup menu in which 3 startup shortcuts just created. Click Launch Splashtop Gateway web portal to open Gateway web console from your default browser. (Preferred Google Chrome)

startup.PNG

Note: We highly recommend using Chromium based browser to navigate your Splashtop Gateway web console.

 

3. Splashtop Gateway OOBE Setup

a) Once launched the web console from browser for the first time, an OOBE setup procedure containing Terms of Service will show up. Click next to continue. oobe1.PNG

b) Set up your Splashtop Gateway Database management and access passwords. Please allow about 30 seconds for Database initializing at this step.

Note: Please write down your Gateway Database passwords and saved in a secured place since there will be NO other methods to change DB passwords later on.

oobe3.PNG

 c) Establish your first team and Team Owner by fill up Team Owner E-mail account and credentials to finish the Splashtop On-Prem setups. 

oobe4.PNG

d) Once OOBE setup completed, log in to web console with the credentials just created. You will need to activate online or offline license based on license mode tailored for you. ( See Section 4)

nolicense.PNG

e) When Splashtop On-Prem activated, please navigate System – Network to check your Ethernet/ Wireless IP addresses and port number as shown in below screenshot. The IP address displayed in this page is the Gateway IP address which will be filled up along with your port number (443 by default) when sign in Splashtop On-Prem app as well as Splashtop Streamer.

qs6.png

 

4. Activate Splashtop Gateway

Splashtop Gateway must be activated via a valid license issued by Splashtop or its partners.

Login into https://{gatewayaddress} with System Owner account, navigate System > License page to import a license to activate.

Notice: 

  • Splashtop Gateway provides both Online and Offline license activation.
  • Online activation: Internet access is required to activate online license, once the Gateway is activated, it can be moved to offline environment. 
  • Offline activation: Click Save to download your activation ID and send it to our support. An activation file shortly will be sent back to proceed activation. Please follow the instructions on the web console. (see below)

Capture.PNG

 

5. Deploy Splashtop Streamer

Below instruction taking deploy Splashtop Streamer on Windows as an example, for more deploy info please refers to Deployment related support articles.

On the computers that you'd like to connect to, the Splashtop Streamer must be installed. This can be done in 3 easy steps.

1. Go to Splashtop Gateway Web Console > Management > Deployment. Click +Add Deployment button to create a new deployment package. A deployment package consists of a deployment streamer and an unique 12-digit deployment code.

 qs8.png

2. Select Deploy for the package that was just created.

3. Have your users install the streamer. You can send the deployment package link to your users. By clicking the link, your users can download the streamer installer and run the file. You can also send the streamer installer file and its associated deployment code directly to your users (via Dropbox, email, etc.).

 4. When the Splashtop Streamer App has finished installing, the user can input the Splashtop Gateway server’s IP address with default port number 443 in conjunction with the deploy code obtained from Team Owner or Admin to log in. Users who don’t have this information will need to seek from their IT department.

win.png

 

6. Create user accounts

6.1 Create Remote Support / Remote Access users

System Owner or Team Admin can create user allowing centralized user management in Splashtop Gateway.

1. Go to Splashtop Gateway Web Console > Management > Users. Press +Add User button to create a new user.

 qs10.png

2. Team Owner or Team Admin sets the user role and group type during user creation process.

addusers.PNG

3. Team Owner or Team Admin can assign user access permission to specific devices or groups by clicking Access Permission from context drop-down menu (Gear Button).

qs12.png

6.2 Create users with additional On-Demand Support/SOS capability (*  based on subscription)

a) Team owner or admin can enable a user’s SOS capability either from user creation page or user’s property drop-down.

user-with-sos.png

b) Created remote support user can be granted SOS feature via user property drop-down.

context-sos.png

c) Users with SOS capability can be found in the SOS page on web portal.

sospage.PNG

7. Install client app and access

1. Users granted as Member can only browse limited content when log in to Splashtop Gateway web console compared to Team Owner or Team Admin as shown in below screenshot. Member can log in Splashtop Gateway Web Console and download the latest Splashtop On-Prem Client app via Downloads menu tab and Install desired client applications.

memberview.png

2. When Splashtop On-Prem Client App installed, user simply inputs the Gateway server’s IP address or FQDN with default port number 443, the account name and password obtained from Team Owner or Admin to log in. Users with no such information will need to consult Team owner or Admin.

onpremclient.PNG

3. If a warning message pops during Log In, stating the SSL certificate is not from a trusted certifying authority, it is likely that the SSL certificate is self-generated, and you can choose to ignore it. However, we recommend that users who have encountered this message popping up should consult their IT department for the proper guidelines to be complied.

onpremssl.PNG

4. When you logged in to the On-Prem app, either a list of remote devices ready to be connected will display or you may just engage a screen does not list any specific computers as shown below. In this case please consult your Team Owner or Admin.

clientzero.PNG

5. Below Screenshot reveals one specific Windows PC Test-Device has been successfully deployed so that the user is able to remote access to it by clicking connect button to the right or double clicking the light blue field.

qs17.png

 

 

8. Network Requirement

  1. If cross firewall remote session is needed, please prepare a public IP address for the Splashtop Gateway, or set port forwarding from the public IP to private IP in your firewall.
  2. Only port 443 is required to be open for inbound / outbound traffic to and from Splashtop Gateway server and can’t not be occupied by other services.
  3. Below port numbers are local to Splashtop Gateway and not needed for inbound / outbound communication, but should not be occupied by other services on Gateway server local machine.
  • Port number: 9080
  • Port number: 5432
  • Port number: 7080
  • Port number: 7081
3 out of 4 found this helpful

Articles in this section