« Back to docs

Installing and removing VNC

The instructions in this section are valid for installing VNC — comprising VNC Server, VNC Viewer, and ancilliary programs — on supported Mac OS X computers.

Upgrading VNC

If you are upgrading from VNC 5.x, installation should be seamless. You do not need to stop VNC Server, and any configuration changes you have made are preserved. You are informed if you need to apply a new license key.

If you are upgrading from VNC Enterprise Edition 4.x, it is recommended you read the Upgrade Guide (PDF) first, to discover breaking changes. You are informed in the likely event you are required to apply a new license key.

Downloading VNC

Download the appropriate VNC package for the operating system of the computer you want to control.

Note

VNC Viewer is freely available to download as a separate app if required.

Installing VNC

Using desktop tools

Double-click the package to start the Installation Wizard, and follow the instructions. Administrative privileges are required.

At the command line

Installing at the command line or via SSH may be quicker and more convenient providing defaults are acceptable. To do this, run the following command as a user with administrative privileges:

installer -pkg <VNC>.pkg -target /

Alternatively, you can install just VNC Server or just VNC Viewer as follows:

  1. Separate the products into a temporary directory containing separate packages:

    pkgutil --expand <VNC>.pkg <temp-dir>

  2. Flatten the package you want to install to a temporary file:

    pkgutil --flatten <temp-dir/VNCServer>.pkg <temp-file>.pkg

  3. Install the temporary file:

    installer -pkg <temp-file>.pkg -target /

Licensing VNC Server

VNC Server must be licensed. If it is not, users cannot connect.

Note

VNC Viewer does not require a license key.

Using desktop tools

To obtain and apply a license key, start VNC Server, open the VNC Server dialog, and either follow the instructions in the VNC Server is not licensed error, or select More > Licensing.

At the command line

Obtain a license key and then run the following command as a user with administrative privileges:

/Library/vnc/vnclicense -add <license-key>

Setting up the environment for VNC

For best results, disable built-in Screen Sharing or Apple Remote Desktop before starting VNC Server.

Removing VNC

Using desktop tools

To uninstall VNC Server, navigate to the Applications > RealVNC > Advanced folder, and double-click the Uninstall VNC Server program. Administrative privileges are required. To uninstall VNC Viewer, repeat this operation with Uninstall VNC Viewer.

At the command line

Run the following commands sequentially as a user with administrative privileges:

/Applications/RealVNC/Advanced/Uninstall\ VNC\ Server.app/Contents/Resources/uninstaller.sh /Applications/RealVNC/Advanced/Uninstall\ VNC\ Viewer.app/Contents/Resources/uninstaller.sh

Note

To completely remove (benign) configuration and other files or settings that may remain, follow these instructions.

×