Install

StoreFront

Enable Citrix Workspace app for HTML5 on the Citrix Workspace for Web site for the StoreFront store that provides the desktops and applications you want to make available to Citrix Workspace app for HTML5 users.

Important:

In multiple-server StoreFront deployments, use only one server at a time to change 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 you update the other servers in the deployment.

  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 Workspace app for HTML5 users.

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

  2. In the Citrix StoreFront management console, perform the following steps:

    • On the Windows Start screen or Apps screen, locate and click the Citrix StoreFront tile.
    • In the left pane, select Stores and in the Action pane, select Manage Receiver for Web Sites, and click Configure.
    • Select Deploy Citrix Receiver/Workspace app.
  3. Enable Citrix Workspace app for HTML5 by selecting one of the options.

    Deploy

    • If you want to access desktops and applications from the site using a locally installed version of Citrix Workspace, select Use Receiver for HTML5 if local Citrix Receiver/Workspace app is unavailable. If you already have Citrix Workspace installed, you cannot use the Citrix Workspace app for HTML5 to access resources from the site. Windows and Mac OS X users without Citrix Workspace app for HTML5 are prompted to install it every time they log on to the site. They can use Citrix Workspace app for HTML5 if they are unable to install Citrix Workspace.

      When you select Use Receiver for HTML5 if local Citrix Receiver/Workspace app is unavailable, the Change Citrix Receiver option appears. This option allows you to switch to the light or the native version dynamically based on the application or the desktop that you want to launch. Also, you can view the Change Citrix Receiver option under the Profile option.

    • If you want to use Citrix Workspace app for HTML5 to access applications or desktops from Citrix Virtual Apps and Desktops, select Always use Receiver for HTML5.

WebSocket

  1. Go to the Group Policy Management Console or Citrix Studio and select Policy to configure the policies.

  2. In the middle pane, under Policies, either modify an existing policy or create a policy.

    Policies

  3. To edit an existing policy, in the right pane, under Actions, select Edit Policy….

    Edit Policy

  4. The Edit Unfiltered window appears. Type websoc and select Enter. The three WebSockets related policy settings are filtered.

    Edit Unfiltered

  5. Click Select for each policy, select Allowed, and then click OK.

  6. Leave the default values, select OK, and then click Next.

  7. Enter a policy name or leave the default value. Ensure you select Enable policy and then click Finish.

    Edit Unfiltered Enable

    Note:

    If you modify an existing default (unfiltered) policy, the option Assign policy to user and machine objects is not available. Therefore, we recommend you either modify an existing (not default) policy or create a policy.

  8. To create a policy in Citrix Studio, under Actions, select Policy and then click Create Policy. The Create Policy window opens.

    Create Policy

  9. In the search field, type websoc and select Enter. The search filters all three WebSockets related policy settings.

    Create Policy one

  10. Click Select for each policy, and then select Next.

    Create Policy Select

  11. Assign the permission based on the Delivery Group. Select Delivery Group and click Assign.

    Create Policy Assign

  12. The Assign Policy window appears. Select the appropriate Delivery Group from the list and click OK.

    Assign Policy

  13. Select the Delivery Group type and click Assign. You can select the Delivery Group from the list.

    Assign Policy Delivery Grpup type

  14. If you select Organizational Unit (OU), you can select a specific OU from your Active Directory environment.

    Assign Policy OU

  15. On the Summary window, review your policy settings, and select Finish.

    Create Policy summary

  16. If you changed the port used when you allowed WebSocket connections on Citrix Virtual Apps or Citrix Virtual Apps and Desktops, complete the following steps to change the WebSocket port for the Citrix Workspace for Web site.

    1. Use a text editor to open the web.config file for the Citrix Workspace 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 verify HTML5 by accessing the desktop and applications using a web browser

  1. Log on to the StoreFront using the URL, http://<XDControllerIPaddressorFQDN>/Citrix/StoreWeb using domain credentials based on the permission (users/groups) in the Delivery Group. This page appears when you select Use Receiver for HTML5 if local CItrix Receiver/Workspace app is unavailable. Use the light version to access HTML5.

    You have the following two options:

    • Citrix Receiver Plug-in
    • Receiver for HTML5
  2. Click Log On.

  3. Enter the correct User name and Password.

    User name and password

  4. The page enumerates all the apps and desktops you have access to. You can launch desktops and applications using an HTML5 browser. The desktops and applications are launched in a new tab.

    Apps Desktops

To view Citrix Receiver for HTML5 logs by navigating to the log page

  1. Log on to the Citrix Receiver for Web site.

    • For Citrix Workspace app 1908 for HTML5 and later, open a new tab and navigate to siteurl/Clients/HTML5Client/src/SessionWindow.html#engineType=log, where siteurl is the URL of the Receiver for Web site (http://server.domain/Citrix/StoreWeb).

    • For Citrix Workspace app 1907 for HTML5 and earlier, open a new tab and navigate to siteurl/Clients/HTML5Client/src/ViewLog.html, where siteurl is the URL of the Citrix Receiver for Web site (http://server.domain/Citrix/StoreWeb).

Direct connections to Citrix Virtual Apps and Desktops

Citrix Workspace app for HTML5 uses the WebSocket protocol to access virtual desktops and hosted applications. By default, WebSocket connections are prohibited on Citrix Virtual Apps and Desktops. If you plan to enable users to access desktops and applications from the local network without connecting through Citrix Gateway, allow WebSocket connections on Citrix Virtual Apps and Desktops.

WebSocket connections are also disabled by default on Citrix Gateway. For remote users accessing their desktops and applications through Citrix Gateway, you must create an HTTP profile with WebSocket connections enabled and either bind this to the Citrix 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 Citrix Virtual Apps and Desktops or Citrix Virtual Apps servers, Citrix Workspace app for HTML5 supports Basic encryption only.

Citrix Provisioning Services

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

Restart the machine to apply the WebSocket policies. For Citrix 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 Citrix 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 Citrix Provisioning 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 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.

Upgrade

To upgrade to the new Citrix Workspace app, do any of the following steps:

  • Download the Citrix Workspace app from the Citrix download page and install the app to upgrade from Citrix Receiver to Citrix Workspace app.
  • Upgrade your Citrix Workspace app using your OS app store.
  • On Windows and macOS, auto-update to Citrix Workspace app from Citrix Receiver using Citrix Receiver Updates.

For the documentation of Citrix Receiver for HTML5, see Citrix Receiver.