Installing and registering the extension

NICE DCV does not determine where extension executables should be located. However, to ensure that file system ACLs protect extensions from unauthorized modification, it is best to follow the guidelines for your specific operating system. On Windows, for instance, use the Program Files folder.

Registering the extension on Windows

On Windows, manifest files can be placed in any directory, including the same directory as extension executables. Add the string value to the registry key outlined below to register the extension. If the key does not exist, create it. If you remove the extension, do not delete the key, since this may break other third-party extensions. Value names must contain the name of the extension, and value data must contain the path to the manifest file.

On the client side, extensions could be registered per user or per machine. On the server side, extensions are registered only per-machine.

The per-machine key is HKEY_LOCAL_MACHINE\SOFTWARE\Amazon\DCV Extensions

The per-user key is HKEY_CURRENT_USER\SOFTWARE\Amazon\DCV Extensions

Registering the extension on Linux

You can register the extension by placing the .json manifest in the folder outlined below. If the folder does not exist, create it. If you remove an extension, you should not remove the folder or any files in it, since that may break other extensions. The manifest file name must be unique to the extension.

On the client side, extensions could be registered per user or per machine. On the server side, extensions are registered only per-machine

The per-machine folder is: /usr/share/dcvextensions/

The per-user folder is: ~/.local/share/dcvextensions

Registering the extension on macOS

You can register the extension by placing the .json manifest in the folder outlined below. If the folder does not exist, create it. If you remove an extension, you should not remove the folder or any files in it, since that may break other extensions. The manifest file name must be unique to the extension.

On the client side, extensions could be registered per user or per machine. On the server side, extensions are registered only per-machine

The per-machine folder is: /Library/DCV Extensions/

The per-user folder is: Library/DCV Extensions/