4.1 – config.html
After opening the /config.html page, you have the possibility to configure all the important settings in SparkView.
If you access the page from the localhost, no password is required to start the configuration. Outside the localhost, the management password must be entered.
Below you will find a descriptive overview of the different settings areas (tabs here):
Gateway
| Name in config.html | Name | Type | Default | Description |
|---|---|---|---|---|
| SSL (https and wss) | ssl | boolean | false | Enable/disable HTTPS/WSS. Can be true and false |
| Port (Default is 80 or 443) | port | number | 8080 | Port on which SparkView is running |
| Binding Address | bindAddr | string | "localhost" | Bind SparkView to a fixed IP address |
| Network Level Authentication | credSSP | boolean | false | Enable/disable NLA. Can be true, false or auto |
| Path of License File | license | string | "./license" | Full path to license file, including file name. Only for paid version. |
| Upload License File | Upload a license file | |||
| HTML Root Directory | html | string | "./html/" | HTML root directory. Printed files are stored in the "temp" subdirectory. Please make sure that SparkView has read and write permissions. |
| Default Web Page | directoryIndex | string | "rdp.html;index.html" | Default page (inside the HTML directory) that is displayed after opening SparkView. |
| Path of Log File | logfile | string | "gateway.log" | Full path to log file, including file name. |
| Size of Single Log File (bytes) | maxbytes | number | 30720000 | Maximum size of a log file (please specify in bytes) |
| Maximum number of Log Files | maxfiles | number | 99 | Maximum number of log files. |
| Log HTTP header | logHttpHeader | boolean | true | Log HTTP header. This may contain sensitive information such as passwords. |
| PDF Converter | converter | string | [Not set] | Full path to the Postscript to PDF converter. Ghostscript (https://ghostscript.com/releases) is recommended. |
| PDF Converter Arguments | arguments | string | "-dBATCH -dNOPAUSE -dPDFSETTINGS=/printer -sDEVICE=pdfwrite -q -sOutputFile=%1 %2" | Arguments for the Postscript to PDF converter. %1 is the name of the output PDF file. %2 is the name of the input PS file. |
| Plugin Class | plugin | string | [Not set] | Class name for a custom plugin. |
| Administration Password (for reporting API etc) | password | string | "password" | Management password for configuration, reporting and API. |
| Enable Remote Management/Configuration | remoteManage | boolean | false | Enable/disable remote management from outside the localhost. |
| Temporary directory (for downloading/uploading) | tmpdir | string | [Not set] | Parent directory for temporary files. |
| Days of temporary files are kept | keepDays | number | 1 | How many days temporary files should be kept by the system. |
| RD Web Access Webfeed | webfeed | string | [Not set] | Remote desktop web feed URL, for RD web access integration. |
| Session Recording | recording | number | [Not set] | Enable/disable session recording. Can be 1 (record graphics only) or 2 (record graphics and sound) |
| Directory for saving session recordings | recdir | string | [Not set] | Directory for saved session recordings. |
| Warn user about session recording | recwarning | boolean | true | Warn users about session recording. |
| Access Not-In-List computers after logged in | accessNotInList | boolean | false | Whether users can reach computers and servers that are not shared with them or in the web feed. |
| Name of Redirected Drive | disk | string | [Not set] | Name for the shared disk, used for file upload/download. |
| Name of Redirected Printer | printer | string | "Remote Printer from Client" | |
| Connections are queued (Backlog) | backlog | number | 50 | How many client connections can be queued. |
| User Definition File | user | string | "./data/users.json" | Full path of the users definition file, including file name. |
| Server Definition File | server | string | "./data/servers.json" | Full path of the servers definition file, including file name. |
| Gateway Web Address | webAddress | string | [Not set] | HTTP address of the web server for OpenID login (redirect). Also in use for client side to get the real gateway address (in case of multiple gateways and load balancing). |
| Host Name of Client User | clientHost | string | [Not set] | Customize the host name of the client user. For more information and possible parameters see section 3.1, "clientHost". |
| Rdp Session Performance Flags | performanceflags | number | 111 | RDP performance flags. Please see section 3.4 for more information. |
| RemoteFX | remotefx | boolean | false | Enable/disable RemoteFX. Works only with LAN and 32 bit. |
| DNS Lookups | enableLookups | boolean | false | Enable to make calls perform DNS lookups to get the actual hostname of the remote client. Disable to skip DNS lookups and instead return the IP address in the form of a string (which improves performance). |
| Session cache time (minutes, 0 = disable session cache) | maxCacheTime | number | 0 | How long sessions should be cached on the gateway (in minutes). 0 disables the RDP session cache. |
| Email SMTP Host | mail.smtp.host | string | [Not set] | SMTP host for outgoing emails. You can use java -cp SparkGateway.jar com.toremote.gateway.Mailer title message to send a test email. |
| Email SMTP Port | mail.smtp.port | number | [Not set] | SMTP port for outgoing emails |
| Email User | mail.user | string | [Not set] | SMTP user for outgoing emails |
| Email Password | mail.password | string | [Not set] | SMTP password for outgoing emails |
| Email From | mail.from | string | [Not set] | Outgoing emails: From |
| Email to | mail.to | string | [Not set] | Outgoing emails: To |
| Email SMTP Authentication | mail.smtp.auth | boolean | [Not set] | Server requires authentication |
| Email TLS | mail.smtp.starttls.enable | boolean | [Not set] | Enable/disable STARTTLS |
| Symlink | symlink | string | [Not set] | Full path of the symlink definition file, including file name. |
| License Usage Alert (Email) | licenseAlert | number (float) | [Not set] | Receive an alert by email when the license usage value reaches this value: Value < 1: Usage value as a percentage of the current license. (e.g.: 0.75 = when 75% usage is reached). Value > 1: When 100% of the usage is reached. |
| Interval of thumbnail (milliseconds) | thumbnail.interval | number | 0 | Interval for receiving thumbnails of the RDP session (in milliseconds). If 0, the client will not send a thumbnail to the server if there are no changes. |
| Width of thumbnail | thumbnail.width | number | 0 | Thumbnail width (in pixels), must be smaller than 640. 0 = no thumbnail. |
| Copy timeout (milliseconds) | copyTimeout | number | 3000 | Timeout for clipboard redirection (in milliseconds). This value should be increased if you need to copy very large data in your application. |
| Path of Key Store | keyStore | string | [Not set] | Full path of the keystore file, including file name. Set up keystore or certificate name when ssl is true. For example keystore.jks or cert.pfx.If you are using a certificate (i.e. cert.pfx), a password is required (see keyStorePassword).If you are using a Java keystore (i.e. keystore.jks), the password of the keystore must match the one used for the certificate, which is integrated in the keystore. |
| Password of Key Store | keyStorePassword | string | [Not set] | Keystore or certificate password. If you are using a Java keystore (i.e. keystore.jks), the password of the keystore must match the one used for the certificate, which is integrated in the keystore. |
| Password Encryption | passwordEncrypted | boolean | false | Encrypt the keystore, management and reporting password. Please use following command to get encrypted password:java -cp SparkGateway.jar com.toremote.gateway.Encryption MyPassword |
| Remote Assistance | assistance | boolean | false | Enable/disable remote assistance. |
| SSH | ssh | boolean | false | Enable/disable SSH. |
| TELNET | telnet | boolean | false | Enable/disable Telnet. |
| Disable Burst License | disableBurstLicense | boolean | false | Enable/disable burst license model. |
| License status | Displays the current license status. |