Product Documentation

Deploy

Nov 01, 2017

Deploying Citrix Receiver for HTML5

To enable Citrix Receiver for HTML5 on StoreFront

You must enable Citrix Receiver for HTML5 on the Receiver for Web site for the StoreFront store that provides the desktops and applications you want to make available to Citrix Receiver for HTML5 users.

Important: In multiple-server StoreFront deployments, use only one server at a time to make changes to the configuration of the server group. Ensure that the Citrix StoreFront management console is not running on any of the other servers in the deployment. Once complete, propagate your configuration changes to the server group so that the other servers in the deployment are updated.

  1. If you have not already done so, deploy StoreFront and create a store aggregating the desktops and applications you want to make available to Citrix Receiver for HTML5 users.

    A Receiver for Web site is created automatically for new stores. For more information about creating StoreFront stores, see Create a store.

  2. In the Citrix StoreFront management console, select the Receiver for Web node in the left pane. From the results pane, select the site providing resources for Receiver for HTML5 users and, in the Actions pane, click Deploy Citrix Receiver.
  3. Enable Citrix Receiver for HTML5 by selecting one of the following options.
    • If want users to access desktops and applications from the site using a locally installed version of Citrix Receiver, where available, select Use Receiver for HTML5 if local install fails. Users who already have Citrix Receiver installed cannot use Citrix Receiver for HTML5 to access resources from the site. Windows and Mac OS X users without Citrix Receiver are prompted to install it every time they log on to the site, but can use Citrix Receiver for HTML5 if they are unable to install Citrix Receiver.
    • If you want all users to access desktops and applications from the site through Citrix Receiver for HTML5 regardless of whether they have a locally installed version of Citrix Receiver, select Always use Receiver for HTML5.
  4. If you changed the port used when you allowed WebSocket connections on XenDesktop or XenApp, complete the following steps to change the WebSocket port for the Citrix Receiver for Web site.
    1. Use a text editor to open the web.config file for the Citrix Receiver for Web site, which is typically located in the C:\inetpub\wwwroot\Citrix\storenameWeb directory, where storename is the name specified for the store when it was created.
    2. Locate the following element in the file.

      <html5 ... preferences="" ... />

    3. Set the value of the preferences attribute to wsPort:portnumber;, where portnumber is the port that you configured in the policy.

To enable direct connections to XenApp and XenDesktop

Citrix Receiver for HTML5 uses the WebSocket protocol to access virtual desktops and hosted applications. By default, WebSocket connections are prohibited on XenDesktop and XenApp. If you plan to enable users to access desktops and applications from the local network without connecting through NetScaler Gateway, allow WebSocket connections on XenApp and XenDesktop.

WebSocket connections are also disabled by default on NetScaler Gateway. For remote users accessing their desktops and applications through NetScaler Gateway, you must create an HTTP profile with WebSocket connections enabled and either bind this to the NetScaler Gateway virtual server or apply the profile globally. For more information about creating HTTP profiles, see HTTP Configurations.

Warning

Editing the registry incorrectly can cause serious problems that may require you to reinstall your operating system. Citrix cannot guarantee that problems resulting from the incorrect use of Registry Editor can be solved. Use Registry Editor at your own risk. Be sure to back up the registry before you edit it.

Note

If you are using SecureICA to encrypt communications between users' devices and your XenDesktop or XenApp servers, Citrix Receiver for HTML5 supports Basic encryption only.

To enable connections to XenApp and XenDesktop using Provisioning Services

To deploy provisioned (non-persistent) machines using Provisioning Services, create the machine catalog and delivery group on which you want to enable Citrix Receiver for HTML5 connections. Ensure that the configured WebSocket policies apply to your machine catalog.

Restart the machine to apply the WebSocket policies. For Provisioning Services-based machines configured to use persistent write cache files and machines deployed using MCS (which have separate identity disks), the policies are persisted when the machines restart. However, for Provisioning Services-based machine catalogs configured to use temporary write cache files, these policies must be applied to the vDisk or they will not be implemented successfully on target devices.

Complete the following steps to ensure that the policies are correctly applied to the vDisk.

  1. Using the Provisioning Services console, shut down a target device that is part of the machine catalog and delivery group. Change the access type of the target device from Production to Maintenance.

    For details, see Managing Target Devices. You must use a target device that is part of the machine catalog and delivery group or the policies will not be applied.
  2. Create a new version of your vDisk and set the  Access to Maintenance. For details, see Manually Updating a vDisk Image.
  3. Start the maintenance target device, selecting the maintenance vDisk version from the boot menu. Verify that the following keys are added to the registry.
    1. HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Citrix\ICAPolicies\AcceptWebSocketsConnections 
    2. HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Citrix\WebSocketsPort 
    3. HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Citrix\WSTrustedOriginServerList
  4. Shut down the target device, change the target device access type back to Production, and promote the new vDisk version to production. Then, start the target device and restart any other target devices currently running from the existing vDisk.

If you do not use vDisk versioning, you can apply the policies to your base vDisk image by shutting down all the target devices that use the vDisk, placing the vDisk in Private Image mode, and then starting the target device to update the image.