TurnKey Linux Virtual Appliance Library

Virtualization notes

Supported virtualization platforms

TurnKey works well with all the major virtualization platforms (e.g., VMWare, VirtualBox, Parallels, Xen and KVM).

If you don't already have virtualization software installed, VirtualBox is available in a free open source edition for most major OSs. VMWare Player and Server products are proprietary but free to download.

Supported build types

For your convenience, TurnKey appliances are available in multiple build types:

  • The default VM build is recommended for users of VirtualBox and low-end VMWare products (Player, Workstation, Server). These work on KVM too.
  • The OVF VM build is recommended for users of high-end VMWare products (ESX, vSphere).
  • Specialized VM builds - these are designed for specific virtualisation technologies and are probably self explanatory. Note: All of these builds are used in headless deployments (without an interactive console). As such, they include an inithook which preseeds default values and passwords. These can be set prior to firstboot, or the 'turnkey-init' command can be used to manually initiate the firstboot scripts to run interactively. See relevant Announcement for full details.
    • The OpenStack build is for use on OpenStack virtualization (or implementations which use OpenStack, such as StackOps). Announcement and details.
    • The OpenVZ build is for use on OpenVZ container virtualization (or implementations which use OpenVZ, such as ProxmoxVE - note that the 'Turnkey channel' via the WebUI is included by default from PVE v2.0 on). Announcement and details.
    • The Xen build is for running on Xen virtualization (note that these builds are not compatible OOTB with the proprietry XenServer product). Announcement and details.
  • The generic ISO image is recommended for bare metal hardware deployments and for any virtualization platform that does not support OVF or the VMDK disk image format used in the VM builds.


The basic principles shown in the VirtualBox appliance installation tutorial should apply to other virtualization platforms not specifically mentioned above.

Note re OpenVZ templates: As discussed elsewhere, Appliances running in OVZ containers do not have a proper console. As such, the normal interactive firstboot scripts can not be triggered to automatically run on first boot. Default values are preseeded (as detailed in the OVZ build announcement) but custom values can be set via the interactive firstboot scripts manually by using the 'turnkey-init' command.
Note that as of v13.0 this is no longer relevant. Firstboot scripts launch on first login to the console.

VirtualBox reminder: enable the PAE/NX option in Settings > System > Processor. Otherwise your VM may fail to boot.