Introduction

With VCam's machine licensing system, a private key is used to provide seamless installation and login-free access. This method securely authenticates each installation, allowing end-users and system administrators to quickly and easily set up the application across the organization.

Important Concepts

Workspace Key

The Workspace Key is a unique string that is required by the application during installation to register and associate the machine with your Workspace. You can retrieve your key from the Deployment section on your Dashboard.

For security reasons, do NOT share this key more than is necessary. Bad actors can use this key to install a paid license against your Workspace.

Prefix

While not currently displayed in the Dashboard, this is an optional parameter used during installation (XI_CN) to identify entire groups of machine deployments (for example, "marketing" or "sales".)

Custom Identifier

Custom identifiers are user-supplied values that allow for easier identification of machines. For example, on first launch you can require each user to identify their machine using their employee ID, email address, location, or some other uniquely identifying value. If custom identifiers are not required for your workspace, then your Dashboard will simply fall back to displaying each machine's built-in name in the list of registered Machines.

Windows Installation

Deploying VCam on Windows via Machine License is quick and simple!

Download the .msi installer from the Deployment section on your Dashboard
Using Powershell or similar terminal, run the below command as administrator:

Format

msiexec <VCam.ai app installer filename> XI_ML="<workspace key>" XI_CN="<optional custom prefix>"

Example

msiexec VCam.ai_2.0.157.0.msi XI_ML="42d55b3c-4a62-4b25-acde-1b39ec392905" XI_CN="Marketing"

You can optionally output the result of installation to a log file, where vcamai_installer.log references the path and filename to output to:

msiexec VCam.ai_2.0.157.0.msi XI_ML="42d55b3c-4a62-4b25-acde-1b39ec392905" XI_CN="Marketing" /qn /L*VX vcamai_installer.log

Follow the on-screen instructions and complete installation
Launch the VCam app to confirm successful installation

macOS Installation

Deployment of VCam on macOS using the Machine License is a little more manual, but still quick and simple!

Download the normal .pkg file from the Downloads section on your Dashboard
Before installing, create a file at the following location: /Library/Application Support/VCam.ai/ml.json with the following content (note this will require an administrator account):

Format

{"XI_ML": "<workspace key>", "XI_CN": "<optional custom prefix>"}

Example

{"XI_ML": "42d55b3c-4a62-4b25-acde-1b39ec392905", "XI_CN": "Marketing"}

Follow the on-screen instructions and complete installation
Launch the VCam app and register the required virtual camera extension when asked (this will require an administrator password), then register the machine license

Uninstallation

For macOS, please manually remove /Library/Application Support/VCam.ai/ml.json after uninstalling the application.

For Windows, the uninstaller will handle cleaning up of files for you.

Updates

The application will automatically prompt your users whenever a new version is available. You may also directly run a newer installer with no additional required settings, and it will retain the installed machine license.

Updated on: 17/07/2024