Windows Install Guide SOFTWARE VERSION 1.9

Transcription

1 SOFTWARE VERSION 1.9

2 TABLE OF CONTENTS Welcome to TGX... 1 License Management... 1 System Requirements... 2 Operating System... 2 Hardware/Drivers... 2 TGX Version Compatibility... 3 Sender Installation Options... 3 USB Remoting Component... 3 Allow TGX to overwrite the existing display configuration... 3 Log remote users in automatically after authenticating... 3 Port configuration... 4 Add firewall exceptions... 4 Receiver Installation Options... 4 USB Remoting Component... 4 Add firewall exceptions... 4 Port configuration... 4 Unattended Install... 5 Appendix A: Advanced Administration Configuration... 6 Remote Dekstop Users Group Membership... 6 Windows Session Disconnect... 6 Appendix B: USB Redirection Configuration... 7 USB Configuration File... 7 Technical Support... 9 Web P a g e i

3 DOCUMENT REVISION HISTORY Version Description of Changes Author Date 1.0 Updated formatting C. Joyner 03/22/ Updated for release sections: USB, hardware/drivers table, and unattended install. C. Twine/J. Moder 1.3 Added version compatibility matrix. C. Twine/J. Moder 1.4 Added Appendix A, advanced administration, and updated unattended installation section. 1.5 Added note to unattended install for Windows 7 exception. J.Moder/C. Twine 07/06/ /25/ /22/2017 J. Moder 8/25/2017 P a g e ii

4 WELCOME TO TGX TGX installers are available from the Mechdyne Product Download Center. Contact Mechdyne to receive your login credentials and licenses for the software. TGX provides separate installers for the sender and the receiver. The sender is the remote workstation whose desktop and applications are shared by TGX to a receiver. The receiver is the local computer that displays and interacts with the remote desktop of the sender via TGX. LICENSE MANAGEMENT The TGX Sender requires a valid license to function. On Windows, install a license file (e.g. TGX.lic) to C:\ProgramData\Mechdyne\licenses. To set an alternative license file location, set the LM_LICENSE_FILE or MECHDYNE_LICENSE_FILE environment variable. The environment variable can provide a list of license files using the separator or a list of servers (i.e. port@hostname) using the, separator. To set an environment variable on Windows, press the Windows key and type System to find the System control panel item. Select Advanced system settings, select the Advanced tab, click Environment Variables and add a new variable under System variables. TGX uses FlexLM for license management. To use floating licenses with a FlexLM server, please contact software_support@mechdyne.com for instructions on how to download and configure the FlexLM license server software. P a g e 1

5 SYSTEM REQUIREMENTS OPERATING SYSTEM The TGX Sender and Receiver support Windows 7, 8, 8.1, 10, Server 2008R2 and HARDWARE/DRIVERS Graphics Card Driver TGX Sender NVIDIA Quadro Kepler or better, NVIDIA GRID (pass-thru) NVIDIA GRID (vgpu) NVIDIA GTX R346 (minimum) (recommended) Latest available from NVIDIA website (recommended) Latest available from NVIDIA website (recommended) Intel HD, Iris, Iris Pro XX.XX.XX.4352 or newer (December 23, 2015) TGX Receiver NVIDIA Quadro R346 (minimum) (recommended) NVIDIA GTX Latest available from NVIDIA website (recommended) Intel HD, Iris, Iris Pro XX.XX.XX.4352 or newer (December 23, 2015) AMD (software decode) or newer (May 15, 2015) TGX currently uses software decoding on AMD graphics cards hardware decoding is under development. P a g e 2

6 TGX VERSION COMPATIBILITY The following matrix depicts the TGX software version compatibility. TGX Software Version X 1.7 X X 1.8 X X 1.9 X SENDER INSTALLATION OPTIONS USB REMOTING COMPONENT TGX provides support for USB devices being redirected from the receiver to the sender. This is currently only supported for human interface device (HID) class devices, though others may work. See Appendix B: USB Redirection Configuration for more information on configuring devices. If the USB component is not selected during install, USB redirection will not be available on this sender. The USB Remoting component adds a USB service and drivers to enable the USB redirection. ALLOW TGX TO OVERWRITE THE EXISTING DISPLAY CONFIGURATION TGX provides support for the Sender desktop to be reconfigured to match that of the Receiver. This option is enabled by default on the Sender as part of the installation. To disable this capability, uncheck the box. It is recommended that this option be disabled on Sender s that are physically connected to complex display systems, especially those configured with NVIDIA Quadro Sync or Mosaic mode. LOG REMOTE USERS IN AUTOMATICALLY AFTER AUTHENTICATING TGX provides support to transfer the credentials of the user authenticated on the Receiver to allow automatic login on the Sender. This option is enabled by default on the Sender as part of the installation. To disable this capability, uncheck the box. P a g e 3

7 PORT CONFIGURATION TGX reserves sixteen ports for communication between Sender and Receiver. The default starting port is 40001, however this is configurable as part of the installation. Note, the default port must match between Sender and Receiver. ADD FIREWALL EXCEPTIONS By default, the installation process will create an exception to the standard Windows Firewall rules to allow TGX connections. Uncheck this box if your IT security does not use the Windows Firewall and have your IT group manually configure your firewall system to allow TGX connections. RECEIVER INSTALLATION OPTIONS USB REMOTING COMPONENT TGX provides support for USB devices being redirected from the receiver to the sender. This is currently only supported for human interface device (HID) class devices, though others may work. The USB devices that may be used are restricted based on the sender configuration. If the USB component is not selected during install, USB redirection will not be available on this receiver. The USB Remoting component adds a USB service and drivers to enable the USB redirection. ADD FIREWALL EXCEPTIONS By default, the installation process will create an exception to the standard Windows Firewall rules to allow TGX connections. Uncheck this box if your IT security does not use the Windows Firewall and have your IT group manually configure your firewall system to allow TGX connections. PORT CONFIGURATION TGX reserves sixteen ports for communication between Sender and Receiver. The default starting port is 40001, however this is configurable as part of the installation. Note, the default port must match between Sender and Receiver. P a g e 4

8 UNATTENDED INSTALL Both the sender and receiver can be installed unattended via command-line. The following arguments will hide all message boxes, accept all defaults, and log results to the user s TEMP directory: /SILENT /SUPPRESSMSGBOXES /LOG e.g. # TGX_Sender_ _64-bit.exe /SILENT /SUPPRESSMSGBOXES /LOG An additional flag, /COMPONENTS, is provided to select/de-select the USB redirection features. The TGX components are main, for the main TGX application and usb, for the USB redirection drivers. If the components flag is unspecified the USB redirection features will be installed. e.g. # TGX_Receiver_ _64-bit.exe /SILENT /SUPPRESSMSGBOXES /LOG /COMPONENTS=main (does not install the USB redirection features) For more detailed information and more options consult the Inno Setup documentation, here. With the addition of the USB remoting feature some additional setup is required to get a completely unattended install. Windows security features require manual acceptance, even of signed driver installs, unless the certificate for that publisher is in the Trusted Publisher certificate store. The public certificate can be found in the install directory with the executables, default: C:\Program Files\Mechdyne\TGX <Sender or Receiver>\bin64\MechdynePublicCertificate.pem. Or it can be extracted from the certificate store on a system where TGX and the USB components have been installed. The certificate can be imported with the following command which should be run prior to running the TGX installer for a truly unattended install. This command will add the certificate to the Trusted Publisher store. certutil -addstore TrustedPublisher <path to certificate> If the store does not exist, an additional -f parameter may be required to force creation of the store or use certmgr.msc to verify the store exists. Note: For Windows 7 this also requires two hotfixes (KB , KB ) since the Mechdyne certificate is SHA256 signed. The certificate may need to be removed and reloaded once these hotfixes are installed. P a g e 5

9 APPENDIX A: ADVANCED ADMINISTRATION CONFIGURATION TGX uses a configuration file which provides settings allow TGX to better integrate with an enterprise IT deployment. This configuration file can be found at C:\ProgramData\Mechdyne\TGX\config.ini. This appendix will cover the available options. REMOTE DEKSTOP USERS GROUP MEMBERSHIP TGX can be configured to additional authenticate users membership in the Remote Desktop Users group prior to granting them remote access to the system. This authentication is in addition to ensuring the user has logon rights to the machine. To enable this feature, the following should be added to the TGX configuration file: [ServerSettings] RdpSidCheck=true WINDOWS SESSION DISCONNECT TGX can be configured to put the windows session in a Disconnected state when the user disconnects. This better matches Microsoft RDP sessions and allows for group policy objects related to session state to function normally. Normally, when TGX disconnects it leave the session active but in a locked state, similar to locking a normal desktop. With this additional setting TGX will not only lock the session but move the session off the console and it will look just like a Terminal Services disconnected session. Enabling this feature will slightly increase the amount of time TGX requires to re-connect to a session. [ServerSettings] SessionDisconnect=true P a g e 6

10 APPENDIX B: USB REDIRECTION CONFIGURATION USB redirection must be selected during install and by default, allows only human interface device (HID) class devices to be redirected to the sender. The sender configuration can be configured to whitelist/blacklist other classes or individual devices. This appendix explains how to configure the TGX USB redirection feature. USB CONFIGURATION FILE The TGX USB configuration file can be found at C:\ProgramData\Mechdyne\TGX\usbConfig.ini. The first section of the file, under the [Class] tag configures what USB classes are allowed to be redirected to this sender. Each following key corresponds to a USB class and can be enabled, true, or disabled, false. The next two sections of the file, [whitelist] and [blacklist], allow whitelisting and blacklisting specific devices by Vendor ID (VID) and Product ID (PID). The Class, VID, and PID of a device can be determined a number of ways. 1. Using Device Manager a. Open the Device Manager b. Right click on the target device, select Properties c. Select the Details tab d. Select the following in the Property drop-down field i. Select Class to determine the USB class of the device ii. Select Hardware IDs to determine the VID/PID of the device Note: When looking at the Hardware ID Value, the VID (in hexadecimal) is the number after VID_ and the PID (in hexadecimal) is the number after PID_. E.g. HID\VID_1234&PID_ABCD&REV_0001 This device s VID is 1234 and PID is ABCD. 2. Using a TGX Receiver (only works if the device is currently allowed) a. Connect with TGX b. Open the USB connection dialog c. Hover over the target device to get information on the class, VID, and PID in the tool-tip P a g e 7

11 A sample configuration file can be found below. USB Base Class whitelist/blacklist The following section allows configuration specifying what classes of USB devices are allowed/disallowed. If a class is not represented it will be blacklisted (default: false). To whitelist a class set the respective class key equal to true. To blacklist a class set the respective class key equal to false. The settings in this section can be overridden on a device by device basis using the VID/PID whitelist/blacklist section below. By default the only class allowed is HID, mouse/keyboard/etc. Example: Hid=true whitelist all HID devices - except for ones in the VID/PID blacklist MassStorage=false blacklist all MassStorage devices - except for ones in the VID/PID whitelist [Class] Unspecified=false Audio=false Communications=false Hid=true Pid=false Image=false Printer=false MassStorage=false Hub=false CdcData=false SmartCard=false Security=false Video=false Phdc=false Av=false Billboard=false Diagnostic=false Wireless=false Miscellaneous=false Application=false Vendor=false VID/PID Whitelist/Blacklist The following two sections allow for whitelisting and blacklisting specific devices. This will override any class white/blacklisting P a g e 8

12 from above. To whitelist a device put its VID/PID in the Whitelist section. To blacklist a device put its VID/PID in the Blacklist section. The key for each VID/PID can be anything that helps the user identify what the VID/PID represents. Device Formatting: name=<vid>:<pid> name - any unique identifier defined by user VID - the Vendor ID of the device (in hex) PID - the product ID of the device (in hex) Examples: testwhitelistdevice=abcd:1234 genericusbmouse=1bcf:7 Whitelist specific VID/PIDs [Whitelist] Blacklist specific VID/PIDs [Blacklist] TECHNICAL SUPPORT Mechdyne is available for additional technical support. Please submit queries through our support portal on the web. WEB software_support@mechdyne.com P a g e 9