User Tools

Site Tools


wiki:development:build-howto-mswin:x2goclient

Build X2GoClient and 3rd-party programs for MS Windows

This howto explains how to build the MS Windows version of X2Go Client. This howto explains how to build the 32-bit version of X2Go Client on MS Windows. If someone successfully attempts a 64-bit (which should work, but needs to be tested), please contribute to this wiki page.

Overview of third-party components

X2Go Cltient for Windows needs several 3rd-party programmes for being able to run on MS Windows:

  • PuTTY for Kerberos 5 (GSSAPI) authentication

All these programmes can be built from source, downloaded from our server or from their project sites. You can also copy the 3rd-party components from X2Go Client installation (on MS Windows) directory.

Build Utilities

For building X2Go Client, we highly recommend to install MSysGit and Notepad2.

MSysGit provides a Unix-like shell (bash) environment, so that you can use Git easily from the command line.

Notepad2 is a freeware alternative to Notepad shipped with Microsoft Windows. Notepad2 understands UTF-8 text formats (and others) and can handle Unix-style line endings. In case you want to introspect a code file, this tool is very handy.

Build X2Go Client

Installing MinGW (Current Version)

MinGW is a gcc compiler for Windows. You need it to build X2Go Client.

Since X2Go Client 4.0.3.0, X2Go Client uses Qt 4.8.6 specifically. Qt 4.8.6 uses MinGW 4.8.x. Qt 4.8.6 for Windows recommends this specific build of MinGW, so it is this specific build that you should use.

http://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win32/Personal%20Builds/mingw-builds/4.8.2/threads-posix/dwarf/i686-4.8.2-release-posix-dwarf-rt_v3-rev3.7z

Extract it to your disk (D:\i686-4.8.2-release-posix-dwarf-rt_v3-rev3\mingw32 in this example).

Finally, you have to add these MinGW executable directories to your PATH environment variable: D:\i686-4.8.2-release-posix-dwarf-rt_v3-rev3\mingw32\bin, D:\i686-4.8.2-release-posix-dwarf-rt_v3-rev3\mingw32\libexec\gcc\i686-w64-mingw32\4.8.2.

Installing MinGW (Old Version)

Using Qt 4.8.5 + MinGW 4.4 is still an option for building X2Go Client 4.0.3.0 and later. It was how X2Go Client 4.0.2.1 and many prior versions were built. Unfortunately, you can not download binaries for this version from MinGW project site any more. You can build it from source or download it from X2Go Site

Extract it to your disk (D:\mingw in this example).

Finally, you have to add these MinGW executable directories to your PATH environment variable: D:\mingw\bin, D:\mingw\libexec\gcc\mingw32\4.4.0.

Installing Qt (Current Version)

You need Qt to build X2Go Client from source.

Qt-4.8.6 is tested and recommended for X2Go Client 4.0.3.0 and later.

Download and install the MinGW version of Qt-4.8.6 for Windows from here

In this example D:\Qt\4.8.6 will be chosen as installation directory

Installing Qt (Old Version)

Qt-4.8.5 was tested and recommended for X2Go Client 4.0.2.1 and earlier. It is still an option for X2Go Client 4.0.3.0 and later.

Download and install the MinGW version of Qt-4.8.5 for Windows from here

In this example D:\Qt\4.8.5 will be chosen as installation directory

Configuring Qt

Providing OpenSSL support in Qt

As X2Go Client needs a Qt with SSL support you must install OpenSSL for MS Windows. OpenSSL depends on the Microsoft Visual C++ 2008 Redistributables. Get that (32-bit version, x86) from the Microsoft site and install it prior to installing OpenSSL.

Download the OpenSSL installer for Windows by browsing here and selecting “Win32 OpenSSL v1.0.1*” where “1.0.1*” s the current version. You can also download it from our site, but only do so if we have the current version. Install it on your build system (for example to directory d:\OpenSSL-Win32).

After installation, copy OpenSSL header files into MinGW's include directory:

For MinGW 4.4:

d:\OpenSSL-Win32\include\openssl -> d:\mingw\include\openssl

For MinGW 4.8:

d:\OpenSSL-Win32\include\openssl -> d:\i686-4.8.2-release-posix-dwarf-rt_v3-rev3\mingw32\i686-w64-mingw32\include\openssl

Static builds of Qt with SSL support

It is recommended to configure Qt to build statically linked applications. It will take some time to reconfigure Qt for static builds. You surely can skip this step, but in this case you must provide Qt libraries with your X2Go Client binary.

Open Qt Command Prompt and start configuration script.

For Qt 4.8.5:

$ configure -release -static -openssl

For Qt 4.8.6, the command is different due to QTBUG-38706:

$ configure -release -static -openssl -qt-style-windowsxp -qt-style-windowsvista

For either version of Qt, rebuild Qt:

$ make sub-src

Dynamically linked builds of Qt with SSL support

If you choose to build dynamically linked applications with Qt, you still have to rebuild Qt in order to get OpenSSL support into Qt.

Open Qt Command Prompt and start configuration script.

For Qt 4.8.5:

$ configure -release -openssl

For Qt 4.8.6, the command is different due to QTBUG-38706:

$ configure -release -openssl -qt-style-windowsxp -qt-style-windowsvista

For either version of Qt, rebuild Qt:

$ make sub-src

Installing libssh

You need libssh to build X2Go Client.

X2Go Client 4.0.3.0 and later use libssh 0.6.3 with pageant support. Get the library package built with either MinGW 4.4.0 or MinGW 4.8.x (currently 4.8.2) from here on our site.

Extract files from archive.

Copy headers files in “include” directory of MinGW.

For MinGW 4.4:

libssh\include\libssh -> d:\mingw\include\libssh

For MinGW 4.8:

libssh\include\libssh -> d:\i686-4.8.2-release-posix-dwarf-rt_v3-rev3\mingw32\i686-w64-mingw32\include\libssh

Copy library files in “lib” directory of MinGW

For MinGW 4.4:

libssh\lib\*.* -> d:\mingw\lib\

For MinGW 4.8:

libssh\lib\*.* -> d:\i686-4.8.2-release-posix-dwarf-rt_v3-rev3\mingw32\i686-w64-mingw32\lib\

Build X2Go Client from source

Open Qt Command Prompt, change to your build directory and get X2Go Client sources from git

$ git clone git://code.x2go.org/x2goclient.git
$ cd x2goclient

Generate the changelog, which x2goclient.exe –changelog will show:

$ copy debian\changelog txt\
git --no-pager log --since "2 years ago" --format="%ai %aN (%h) %n%n%x09*%w(68,0,10) %s%d%n" > ChangeLog.gitlog
$ copy ChangeLog.gitlog txt\git-info

Build X2Go Client:

$ cd x2goclient
$ PATH=%PATH%;D:\i686-4.8.2-release-posix-dwarf-rt_v3-rev3\mingw32\bin\
$ config_win.bat
$ mingw32-make
$ cd x2gohelper
$ mingw32-make
$ cd ..

X2Go Client binaries (x2goclient.exe & x2gohelper.exe) are in d:\build\x2goclient\release\ directory.

Build X2Go Client from source (debug build)

Repeat the instructions for “Build X2Go Client from source”, except

  1. Before running config_win.bat, edit x2goclient.pro so that “CONFIG += console” is uncommented
  2. Edit nsis\x2goclient.nsi so that the following lines:
  • CreateShortCut “$INSTDIR\X2Go Client.lnk” “$INSTDIR\x2goclient.exe”
  • CreateShortCut “$SMPROGRAMS\$STARTMENU_FOLDER\X2Go Client.lnk”
  • CreateShortCut “$DESKTOP\X2Go Client.lnk” “$INSTDIR\x2goclient.exe”

Are replaced with the following:

  • CreateShortCut “$INSTDIR\X2Go Client.lnk” “$INSTDIR\x2goclient.exe” “–debug”
  • CreateShortCut “$SMPROGRAMS\$STARTMENU_FOLDER\X2Go Client.lnk” “$INSTDIR\x2goclient.exe” “–debug”
  • CreateShortCut “$DESKTOP\X2Go Client.lnk” “$INSTDIR\x2goclient.exe” “–debug”

Pack/Compress X2Go Client

You may want to pack X2Go Client to reduce it size. You can do it with upx, which is available for Windows, Linux and Cygwin.

X2Go Client package folder

To make X2Go Client usable on Windows, you must put X2Go Client binary and all libraries and components in one directory.

All of the files referenced below (apart from x2goclient.exe) can be obtained from x2goclient-contrib.git on http://git.x2go.org

In the base directory of your X2Go Client source tree create a folder named dist/. To this folder you have to add the following components:

  • X2Go Client with libraries
  • nxproxy with libraries
  • Open SSH Server with libraries (optional)
  • VcXsrv
  • PulseAudio (optional)

Add X2Go Client with libraries to package folder

  1. Add x2goclient.exe (from the release/ folder) to the dist/ folder.
  2. If you are using MinGW 4.4, add its libraries (copy from D:\MinGW\bin)
    • libgcc_s_dw2-1.dll
    • mingwm10.dll
  3. If you are using MinGW 4.8, add its libraries (copy from D:\i686-4.8.2-release-posix-dwarf-rt_v3-rev3\mingw32\bin). (Note that the inclusion of '\' character before the '+' character is to work around a horrible issue in dokuwiki; the actual filenames do not have the '\“ character.)
    • libgcc_s_dw2-1.dll
    • libstdc\+\+-6.dll
    • libwinpthread-1.dll
  4. Add OpenSSL libraries (copy from your OpenSSL installation directory)
    • libeay32.dll
    • ssleay32.dll
    • libssh.dll
  5. libzip library (available here on our site) (binaries originally from the KDE Windows project site)
    • libzip.dll
  6. zlib library for libzip (available here on our site) (binaries originally from the KDE Windows project site )
    • libz.dll
  7. zlib library for libssh (available here on our site) (binaries originally from the zlib project site)
    • zlib1.dll
  8. If you want to use X2Go Client on older versions of Windows, you should put the “Microsoft Visual C\+\+ Redistributable 2008 Package”'s dll files into your X2Go Client package directory. (Originally downloaded from the Microsoft download site).
    • Microsoft.VC90.CRT.manifest
    • msvcm90.dll
    • msvcp90.dll
    • msvcr90.dll

Build/Add nxproxy with libraries

You can download nxproxy, and its libraries here or obtain them from x2goclient-contrib.git directly.

  1. Copy the nxproxy binaries directly into the dist/ folder (built from nx-libs.git on http://git.x2go.org):
    • cygXcomp.dll
    • cygjpeg-8.dll
    • cygstdc\+\+-6.dll
    • cygz.dll
    • cyggcc_s-1.dll
    • cygpng-3.dll
    • cygwin1.dll
    • nxproxy.exe

If you want to build nxproxy from source, you need install and configure Cygwin first.

Installing Cygwin

Download and start the Cygwin installer

Choose your cygwin directory. For example c:\cygwin. Follow installer instructions.

on installer page “Select Packages” you can select programs and libraries that should be installed in your cygwin environment. For building of nxproxy you will need:

  • autoconf
  • automake
  • gcc-core
  • gcc-g\+\+
  • git
  • libX11-devel
  • libjpeg-devel
  • libpng-devel
  • libmpfr4
  • make
  • mc
  • zlib-devel
  • wget

By installing the libjpeg-devel package, you are now installing libjpeg-turbo instead of the legacy libjpeg . The same applies for the dependency libjpeg8 package, which provides the cygjpeg-8.dll file that you will copy later.

If you are updating the X2Go Windows build VM, X2Go-WinBuilder, install these packages too:

  • bashdb
  • bash-completion
  • chere
  • colorgcc
  • colordiff
  • diffutils
  • dos2unix
  • cygcheck-dep
  • cygutils-extra
  • indent
  • renameutils
  • vim
  • git-completion
  • patch
  • patchutils
  • openssh
  • xz
  • unzip
  • nano
  • bzip2
  • time

Currently_Testing: The following source packages for both nxproxy and openssh

  • dash
  • cygwin
  • gcc (select source for: gcc-core)
  • libedit (select source for: libedit0)
  • libjpeg-turbo (select source for: libjpeg-devel)
  • libpng (select source for: libpng-devel)
  • ncurses (select source for: libncurses-devel)
  • openssh (source, but not binary)
  • openssl
  • zlib (select source for: zlib-devel)

Currently_Testing: Install libpng-devel from cygwin instead.

Building nxproxy

  • Open a cygwin shell and change to your build directory. In this example d:\Build will be used
$ cd /cygdrive/d/Build

Do not download and use the sources from git. Unlike the tarball, the git sources do not have the X2Go project's patches (debian/patches/) applied. (Technically, you could use the sources from git and apply the patches manually.)

$ wget http://code.x2go.org/releases/source/nx-libs/nx-libs-3.5.0.27-lite.tar.gz
$ tar -xvzf nx-libs-3.5.0.27-lite.tar.gz
$ cd nx-libs-3.5.0.27
  • Build nxcomp
$ cd nxcomp
$ autoconf
$ ./configure
$ make
$ cd ..
  • Build nxproxy
$ cd nxproxy
$ autoconf
$ ./configure
$ make
$ strip nxproxy.exe
$ cd ..

Copying the nxproxy binaries

Now the nxproxy binary (nxproxy.exe) is ready. You can copy it into the programme packaging folder (dist/) of X2Go Client. To be able to run nxproxy you must also copy required libraries into the dist/ folder:

  1. From nxproxy directory (d:\Build\nx-libs\nxproxy) - nxproxy.exe
  2. From nxcomp directory (d:\Build\nx-libs\nxcomp) - cygXcomp.dll
  3. From cygwin directory (c:\cygwin\bin):
    • cyggcc_s-1.dll
    • cygjpeg-8.dll
    • cygpng15-15.dll
    • cygstdc\+\+-6.dll
    • cygwin1.dll
    • cygz.dll
$ cd /usr/bin
$ cp --preserve=time -t /cygdrive/d/Build/cygwin-2014-09-16/ cyggcc_s-1.dll cygjpeg-8.dll cygpng15-15.dll cygstdc++-6.dll cygwin1.dll cygz.dll  

Open SSH Server

X2Go Client for Windows using modified Cygwin Open SSH Server for file sharing. You can download it here

If you want to build it from source, you should install Cygwin first.

After that run Cygwin installer (setup.exe), navigate to “Select Packages” page and install additional packages, you need to build Open SSH Server:

  • libedit
  • libedit-devel
  • libkrb5-devel
  • libncurses-devel
  • openssl-devel
  • patch

For openssh you should install both, binary and source packages (toggle “Src” checkbox beside of package name). Source package will be installed in /usr/src directory in your Cygwin installation.

Copy the source folder (downloaded and extracted from a tarball by cygwin) to your build directory. In this example d:\Build will be used

$cp -pr /usr/src/openssh-6.1.1p1-3-src /cygdrive/d/Build/

cd to the openssh source directory, extract the upstream (openssh.com) tarball within, and cd to the lower-level source directory

$cd /cygdrive/d/Build/openssh-6.6.1p1-3
$tar -xzvf openssh-6.6p1.tar.gz
$cd openssh-6.6p1

Apply any patches that cygwin provides. For example, with 6.6p1-3:

$patch < ../curve25519-sha256.patch

Get and apply the X2Go patch, which enables use of the Open SSH Server with X2Go Client

$wget http://code.x2go.org/releases/source/openssh-cygwin/openssh-6.6p1-1.x2go.patch ../
$patch.exe < ../openssh-6.6p1-1.x2go.patch

Build Open SSH Server

$./configure --libexecdir=/usr/sbin --with-libedit --with-xauth=/usr/bin/xauth --build=mingw32w32
$make
$strip *.exe

The command above is based on the command that Cygwin uses for their official builds, but with certain changes in order to eliminate unnecessary dependencies. Eliminating unnecessary dependencies decreases how frequently X2Go Client for Windows needs to rebuilt in order to include security patches for those dependencies.

Open SSH Server binaries are ready. Now you can copy them in to the installation directory of x2goclient:

  • sftp.exe
  • sftp-server.exe
  • ssh-keygen.exe
  • sshd.exe

To be able to run Open SSH Server you should also copy needed programs and libraries from cygwin directory (c:\cygwin\bin).

1st, copy these files over without changing their filenames.

  • cygcrypto-1.0.0.dll
  • cygedit-0.dll
  • cyggcc_s-1.dll
  • cygncursesw-10.dll
  • cygssp-0.dll
  • cygwin1.dll
  • cygz.dll

2nd, copy the Dash executable over and rename it:

ash.exe -> sh.exe

Some of these libraries are also used by nxproxy. Open SSH Server and nxproxy should be built using same version of Cygwin.

This section needs to be updated for the .csv file that lists Cygwin packages and versions, and for the zip files on http://code.x2go.org/releases/ that contain pre-built binaries.

PulseAudio

You can download PulseAudio 5.0 for Windows here.

Prior versions of PulseAudio are available from project site and the above link.

VcXsrv - XP Compatible

You can download the X2Go project's modified version of VcXsrv (VcXsrv - XP Compatible) http://code.x2go.org/releases/binary-win32/3rd-party/vcxsrv-modified-by-x2go-project/.

Building VcXsrv from source is not the part of this Howto. However, it is documented under the source repo

All official X2Go Project builds use the 32-bit builds of VcXsrv. 64-bit builds are probably compatible with the 32-bit X2Go Client, but have not been tested. Furthermore, the XP compatible builds are only offered in 32-bit.

If you are doing an official X2Go Project build of X2Go Client 4.0.3.0, use the version: 1.15.2.1+xp-vc2013+x2go1 The ”+x2go1“ in the version string implies that an X2Go-specific patch, winmultiwindow.patch has been applied. It is believed that this patch cannot be upstreamed.

If you do install VcXsrv the setup installer, and you are building X2Go Client 4.0.2.1, deselect to install the fonts. They would more than double the size of the X2Go NSIS installer. Some legacy apps do need them, and users can install them if they'd like.

If you do install VcXsrv the setup installer, and you are building X2Go Client 4.0.3.0, select to install the fonts. They will be an optional component of X2Go Client for Windows in its installer.

Also, if you are doing an official X2Go Project build, remove these files that X2Go Client does not need and would take up extra space:

  • iconv.dll
  • libgcc-s-sjlj-1.dll
  • libiconv-2.dll
  • libwinpthread-1.dll
  • libxml2.dll
  • libxml2-2.dll
  • plink.exe
  • uninstall.exe
  • xauth.exe
  • XCalc
  • xcalc.exe
  • XCalc-color
  • XClock
  • xclock.exe
  • XClock-color
  • Xcms.txt
  • xhost.exe
  • xlaunch.exe
  • xrdb.exe
  • xwininfo.exe

Also, if you are doing an official X2Go Project build, create this file in the VcXsrv folder:

  • vcxsrv-version.txt

And specify the version string of VcXsrv in it. The version string should be the only contents of the file. For example:

1.15.2.1+xp-vc2013+x2go1

PuTTY

you can download PuTTY for Windows from project site. Building PuTTY from source is not the part of this Howto

These are the only binaries you need from PuTTY. Copy them directly into the dist/ folder.

  • plink.exe
  • pscp.exe
wiki/development/build-howto-mswin/x2goclient.txt · Last modified: 2014/10/31 02:28 by mikedep333