DRC's TurboVNC Build Scripts

These scripts are used to build the "official" TurboVNC binaries, which work on any Linux platform with GLIBC 2.17 and later, as well as Windows 7 and later and OS X/macOS 10.9 and later.

See BUILDING.md in the TurboVNC source for basic build requirements. Additional build requirements for these scripts are listed below.

Build Environment: Linux

Recommended distro: Red Hat or CentOS Enterprise Linux 7 x86-64

Complete Linux build environment requirements are best understood by examining the official Docker recipe at https://github.com/TurboVNC/docker.

Build Environment: macOS

macOS 10.15 (Catalina) or later required

CMake should be installed somewhere in the PATH. The version in MacPorts (http://www.MacPorts.org) works, or just install the CMake application from the DMG (http://www.cmake.org) and add /Applications/CMake.app/Contents/bin to the PATH.

Xcode 12.0 or later (available at https://developer.apple.com/downloads -- Apple ID required.)

The libjpeg-turbo SDK (v2.1.x or later) should be installed in its default location.

Build Environment: Windows

Windows 7 64-bit or later required

CMake (the Windows native version, not the Cygwin version) should be installed somewhere in the PATH.

Ninja should be installed somewhere in the PATH.

The directory containing the 64-bit Visual C++ compiler should be listed in the PATH environment variable. The directory containing the 64-bit Windows SDK libraries should be listed in the LIB environment variable. The directories containing the Visual C++ and Windows SDK header files should be listed in the INCLUDE environment variable. The easiest way to accomplish this is to use the vcvars64.bat script provided by Visual C++, as described in the TurboVNC build instructions.

The official TurboVNC binaries are generated using Visual Studio 2015 Community Edition, but any reasonably modern version of Visual C++ and the Windows SDK should work.

Install all other software necessary to build a 32-bit and a 64-bit version of TurboVNC (both 32-bit and 64-bit libjpeg-turbo SDKs for Visual C++ should be installed in their default locations. Refer to BUILDING.md for more information.)

Build Procedure

Executing

buildvnc [branch/tag]

(where branch/tag is, for instance, "2.0.x" and defaults to "main") will generate both a pristine source tarball and binaries for the platform on which the script is executed. These are placed under $HOME/src/vnc.nightly/YYYYMMDD/files, where YYYYMMDD is a build number based on today's date. If the build is successful, then a sym link will be created from $HOME/src/vnc.nightly/latest to $HOME/src/vnc.nightly/YYYYMMDD.

Once a full build is completed on one platform, then you can use the existing source tarball to build binaries on other platforms by running buildvnc -e (assuming that $HOME/src is a shared directory.)

NOTE: On Windows, buildvnc should be run from inside an MSYS shell. If you are mounting your home directory as a drive letter (e.g. H:), then set the HOME environment variable to the MinGW path for that drive (e.g. /h) prior to running buildvnc.

Run buildvnc -h for usage information.

Signing the Linux Packages

To sign the RPMs and DEBs using a GPG key, create a file called gpgsign in the same directory as buildvnc, and include the following contents in the file:

GPG_KEY_NAME={full name of GPG key to use (as listed in 'gpg --list-keys')}
GPG_KEY_ID={key ID of GPG key to use (as listed in 'gpg --list-keys')}
GPG_KEY_PASS={password for GPG key}

debsigs must be installed and in the PATH.

Signing the Mac App/Package/DMG

To sign the Mac TurboVNC Viewer app, installer package, and DMG, create a file called macsign under setupscripts/, and include the following contents in the file:

MACOS_APP_CERT_NAME={full name of Mac Developer ID Application certficate (in the macOS keychain) used to sign the app & DMG}
MACOS_INST_CERT_NAME={full name of Mac Developer ID Installer certificate (in the macOS keychain) used to sign the installer package}

macOS 10.11 "El Capitan" or later is required in order to sign the Mac app/package/DMG.

Signing the Windows Packages

To sign the Windows installers using a code signing certificate, create a file called mssign in the same directory as buildvnc, and include the following contents in the file:

MS_KEY_FILE={full MinGW path to a .pfx file containing the code signing certificate}
MS_KEY_PASS={password for certificate}

signtool (available in the Windows SDK) must be in the PATH.

TurboVNC/buildscripts