Skip to main content

SparkView Admin Manual

Version 6.1.0
May 31, 2022

1. – Overview

2. – Installation

3. – Server configuration

3.1 – Gateway

You can configure the gateway by editing gateway.conf file, here is a list of all options: Key...

3.2 – HTTPS and WSS (WebSocket secure connection)

Recommended to enable HTTPS and WSS. There is a self-signed certificate (keystore.jks) in the ins...

3.3 – Remote Desktop Web Access Portal Integration

A user can log in with his domain user name and password and get the RemtoeApps or desktops publi...

3.4 – RDP, VNC, SSH, Telnet hosts

You can use servers.json file to configure: RDP hosts which can be accessed; RDP options for ever...

3.5 – Users

You can use users.json file to configure: users (name and password), RDP hosts (configured in ser...

3.6 – Easy printing

In a traditional RDP environment, you may have to install drivers for client side printers to mak...

3.7 – RemoteApp and start a program instead of the whole desktop

There are two ways to start a program: Start a program on connection use a program as shell of W...

3.8 – Clipboard redirection and shared clipboard

You can only copy text, image and html between local and remote because of the browser's restrict...

3.9 – Bidirectional audio redirection (RDP)

Audio redirection must be enabled in the RDP server first. For microphone redirection, Chrome 53,...

3.10 – File share (uploading and downloading)

There are two ways to implement file downloading/uploading. One is using temporary directory for ...

3.11 – Session Recording and Playback

Spark View can record your session in RDP stream format (.rdpv) and play it anywhere. This format...

3.12 – Session Shadowing (join or share an active session on gateway)

Unlimited users can join/share one existed session via one click if you know the session id: http...

3.13 – Native RDP shadowing (join any active RDP sessions)

Since 6.0, Spark View can use shadow.html to shadow any active RDP sessions on the RDP server, ev...

3.14 – Touch interface (iOS, Android etc)

Spark View can operate on tablets and smart phone devices if you have an html5 browser available....

3.15 – Touch remoting

Touch Remoting will be enabled automatically when following conditions are met: RDP host is Wind...

3.16 – Hyper-V Console and Enhanced Session Mode

Compared with normal RDP connection, Hyper-V console connection has following pros and cons: Pros...

3.17 – RDP connection cache/pool

RDP session may take minutes to start (booting, login, user profile etc) which is unacceptable so...

3.18 – Symlink (access link)

You can create a symlink for a RDP host (must be configured in servers.json first). After you cre...

3.19 – Macro recording

Macro recording can be used on software testing, automated jobs etc. Please add macro.js into you...

3.20 - Remote assistance

You can provide Remote Assistance with assit.html. With Spark View's cross-platform ability, now ...

3.21 – RFB (VNC) protocol support

You can connect to any VNC server (Linux, Mac etc) with vnc.html. It also supports session shadow...

3.22 – SSH and Telnet

You can connect to SSH server with ssh.html, and connect to Telnet server with telnet.html: Yo...

3.23 – Smart Card Redirection

Since version 5.7, Java applet was deprecated. Smart Card redirection need a small native applica...

3.24 – Scanner redirection

Spark View provides two different method for scanner redirection: Please use the TWAIN Virtual D...

3.25 – USB redirection

USB redirection is based on WebUSB: https://wicg.github.io/webusb/. Please check your browser com...

3.26 – OAuth 2.0/Okta integration

You need to register your application before you use OAuth 2.0 integration. Provider Registeri...

3.27 – Active Directory, LDAP, RADIUS integration

You can authenticate your users against active directory, LDAP or RAIUS server. Please configure ...

4. – Further management and configuration

5. – API and Plug-In

5.1 – Reporting API (query server status, client side JavaScript API)

Include "gateway.js" in your web page: var gw = new Gateway("192.168.9.118"); gw.login("password...

5.2 – RDP library (client side JavaScript API)

Further links to the coresponding subpages: 5.2.1 – RDP parameters 5.2.2 – Passing parameter ...

5.2.1 – RDP parameters

Parameter                                                                                     ...

5.2.2 – Passing parameter via URL

Please use "on" and "off" for Boolean value if you are using URL to pass parameters. Connecting t...

5.2.3 – Passing parameter via object or cookie

Rdp2 class can be used to replace Rdp class. You can pass a object to Rdp2: varobj = {gateway: "1...

5.2.4 – Usage of RDP class

Properties: Name                                                                              ...

5.2.5 – Extend RDP: Virtual Channel and Dynamic Virtual Channel

You can create multiple virtual channels and dynamic virtual channels on client side using JavaSc...

5.2.6 – Extend Gateway: Gateway Channel

You can create multiple gateway channels to create a communication layer between client browser a...

5.3 – Plug-ins (server side Java API)

Your plug-in must implement com.toremote.gateway.plugin.ManagerInterface. With the plugin, you ca...

5.4 – HTTP Request API (server side)

You can use HTTP request to create server, symlink dynamically if you don't want to write a plug-...

Appendices