An installation key is what you use to install the HyperView Server. It determines the owner and folder of the installed system, which version installs, and the settings the system runs with. Each console user should generally have their own.
Before you start
An admin role.
A plan for which systems share a key. Every system installed with a key gets its own settings, so create one key for each group of systems that should be set up differently. See Designing your keys below.
Step 1 - Name the key and choose where systems go
Go to Admin > Installation Keys and click Actions > Create key.
Name: how you'll recognise the key.
Owner: the user who will own the systems installed with it.
Folder: where the systems are assigned. Leave None to assign later.
Target version: leave Current recommended unless you need every system on one exact version.
Step 2 - Choose the settings
Scroll down to Settings:
Audio mode: sends the system's sound to the viewer. On Windows, Enable also installs the virtual audio device.
Automation action log: how much detail about automation is kept in the activity log. Detail is the default. Choose Off for short-lived systems, such as test VMs, to keep the log readable.
Inactivity timeout: disconnects a viewer after the number of minutes you set.
Virtual video driver: fits the desktop to the viewer's browser window. Turn it on for systems people use through the desktop. See The virtual video driver.
Click Create.
NOTE: Settings apply when a system installs. Changing a key later doesn't change systems already installed with it. Change those one at a time from the system's Edit panel.
Step 3 - Copy the key
The new key. You don't normally need it on its own, because the Installation screen builds the full install command from it.
Copy copies it if you do.
Unlike an API key, you can copy an installation key again at any time from the list.
The Installation Keys list
Active keys: switch to see keys you've deactivated.
Actions: create a key.
Owner. A red Needs owner means the owner was deleted. Set a new one.
Installation Key, with a copy button.
Installs: how many systems have registered with the key.
Designing your keys
One key per folder. New systems land in the right place automatically.
One key per environment. Separate keys for production, staging and lab, each with its own folder and settings.
One key per customer. For managed service providers. It also lets Session Usage show time per customer.
A short-lived key per rollout. The Installs count tells you exactly how many machines came from it.
Avoid installing everything with one key. Moving systems to the right folder and owner afterwards has to be done one system at a time.
Retire a key
Deactivate a key to stop new installs with it. Systems already installed with it keep working.
Troubleshooting
New systems have no folder. The key has no folder. Set one, then move the systems already installed with Assign to folder.
A setting you changed hasn't taken effect. Key settings only apply at install. Change existing systems from their Edit panel.