This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
wiki:development:build-howto-mswin:x2goclient [2015/01/12 05:23] mikedep333 [PulseAudio] update for x2goclient-contrib.git |
wiki:development:build-howto-mswin:x2goclient [2020/02/06 10:27] ionic Add staging prefix for later installation. |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Build X2GoClient and 3rd-party programs for MS Windows ====== | ====== 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. | + | 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. | ||
+ | |||
+ | This howto is intended for 2 different audiences: | ||
+ | - Those doing official X2Go Project builds. | ||
+ | - Those doing informal builds, personal builds, or builds for use within their organization. | ||
+ | The former audience has extra steps to do. These steps will be noted. | ||
===== Overview of third-party components ===== | ===== Overview of third-party components ===== | ||
- | X2Go Cltient | + | X2Go Client |
- | * [[wiki: | + | * [[wiki: |
- | * [[wiki: | + | * [[wiki: |
* [[wiki: | * [[wiki: | ||
- | * [[wiki: | + | * [[wiki: |
+ | |||
+ | * [[wiki: | ||
* [[wiki: | * [[wiki: | ||
- | All these programmes, as well as many of the libraries, can now be downloaded from [[http:// | + | All these programs, as well as many of the libraries, can now be downloaded from [[http:// |
- | They now also be built from source, or downloaded from their project sites. | + | They can also be built from source, or downloaded from their project sites. However, this howto only explains how to build nxproxy and OpenSSH. |
You can also copy the 3rd-party components from X2Go Client installation (on MS Windows) directory. | You can also copy the 3rd-party components from X2Go Client installation (on MS Windows) directory. | ||
Line 27: | Line 36: | ||
===== Build Utilities ===== | ===== Build Utilities ===== | ||
- | For building X2Go Client, we highly recommend to install [[http:// | + | For building X2Go Client, we highly recommend to install [[http:// |
MSysGit provides a Unix-like shell (bash) environment, | MSysGit provides a Unix-like shell (bash) environment, | ||
+ | |||
+ | For official X2Go project updates to x2goclient-contrib, | ||
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. | 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 ===== | ||
+ | ===== Setup Build Environment ===== | ||
- | ==== Installing MinGW (Current Version) | + | ==== Installing MinGW ==== |
- | MinGW is a gcc compiler for Windows. You need it to build X2Go Client. | + | MinGW includes the GCC compiler |
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. | 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. | ||
Line 47: | Line 58: | ||
Finally, you have to add these MinGW executable directories to your PATH environment variable: '' | Finally, you have to add these MinGW executable directories to your PATH environment variable: '' | ||
- | ==== Installing | + | ==== Installing Qt ==== |
- | + | ||
- | 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, | + | |
- | + | ||
- | Extract it to your disk ('' | + | |
- | + | ||
- | Finally, you have to add these MinGW executable directories to your PATH environment variable: '' | + | |
- | ==== Installing Qt (Current Version)==== | + | |
You need Qt to build X2Go Client from source. | You need Qt to build X2Go Client from source. | ||
Line 65: | Line 68: | ||
In this example D:\Qt\4.8.6 will be chosen as installation directory | 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 [[http:// | ||
- | |||
- | In this example D:\Qt\4.8.5 will be chosen as installation directory | ||
==== Configuring Qt ==== | ==== Configuring Qt ==== | ||
=== Providing OpenSSL support in 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 [[http:// | + | As X2Go Client needs Qt built with SSL support you must install OpenSSL for MS Windows. OpenSSL depends on the [[https:// |
Download the OpenSSL installer for Windows by browsing [[http:// | Download the OpenSSL installer for Windows by browsing [[http:// | ||
Line 85: | Line 81: | ||
< | < | ||
d: | d: | ||
- | </ | ||
- | For MinGW 4.4: | ||
- | < | ||
- | d: | ||
</ | </ | ||
Line 95: | Line 87: | ||
It is recommended to configure Qt to build statically linked applications. | It is recommended to configure Qt to build statically linked applications. | ||
- | This is how official X2Go Client builds are done | + | This is how official X2Go Client builds are done. |
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. | 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. | ||
Line 104: | Line 96: | ||
< | < | ||
$ configure -release -static -openssl -qt-style-windowsxp -qt-style-windowsvista | $ configure -release -static -openssl -qt-style-windowsxp -qt-style-windowsvista | ||
- | </ | ||
- | For Qt 4.8.5: | ||
- | < | ||
- | $ configure -release -static -openssl | ||
</ | </ | ||
- | For either version of Qt, rebuild | + | Rebuild |
< | < | ||
- | $ make sub-src | + | $ make -j3 sub-src |
</ | </ | ||
Line 124: | Line 112: | ||
< | < | ||
$ configure -release -openssl -qt-style-windowsxp -qt-style-windowsvista | $ configure -release -openssl -qt-style-windowsxp -qt-style-windowsvista | ||
- | </ | ||
- | For Qt 4.8.5: | ||
- | < | ||
- | $ configure -release -openssl | ||
</ | </ | ||
- | For either version of Qt, rebuild | + | Rebuild |
< | < | ||
- | $ make sub-src | + | $ make -j3 sub-src |
</ | </ | ||
+ | |||
==== Installing libssh ==== | ==== Installing libssh ==== | ||
You need libssh to build X2Go Client. | You need libssh to build X2Go Client. | ||
- | X2Go Client 4.0.3.0 and later use libssh 0.6.3 with pageant support. | + | X2Go Client 4.1.2.2 and later use libssh 0.9.x with pageant support. |
+ | |||
+ | === Pre-built Binaries === | ||
Get the **library** package built with MinGW 4.8.x (currently 4.8.2) from [[http:// | Get the **library** package built with MinGW 4.8.x (currently 4.8.2) from [[http:// | ||
- | Or for MingW 4.4.0, | ||
Copy headers files in " | Copy headers files in " | ||
Line 148: | Line 134: | ||
< | < | ||
x2goclient-contrib\libssh\0.6.3-762055b-pageant-support-mingw482_bin\include\libssh -> d: | x2goclient-contrib\libssh\0.6.3-762055b-pageant-support-mingw482_bin\include\libssh -> d: | ||
- | </ | ||
- | For MinGW 4.4: | ||
- | < | ||
- | libssh\include\libssh -> d: | ||
</ | </ | ||
Line 160: | Line 142: | ||
x2goclient-contrib\libssh\0.6.3-762055b-pageant-support-mingw482_bin\lib\*.* -> d: | x2goclient-contrib\libssh\0.6.3-762055b-pageant-support-mingw482_bin\lib\*.* -> d: | ||
</ | </ | ||
- | For MinGW 4.4: | + | |
- | <code> | + | === Building From Source === |
- | libssh\lib\*.* -> d:\mingw\lib\ | + | |
- | </ | + | If you want to rebuild the library (e.g., to backport fixes) or update it as part of the release process, follow these steps. |
+ | |||
+ | == Preparation == | ||
+ | |||
+ | Download the tarball from [[https:// | ||
+ | |||
+ | Unpack it as usually. The X2Go Project keeps libssh source | ||
+ | |||
+ | Adapt any required patches so that they apply cleanup, build and work correctly. | ||
+ | |||
+ | We currently patch libssh | ||
+ | |||
+ | To rebase patches, the X2Go Project uses the private git repository at '' | ||
+ | | ||
+ | * check out new release tag (or branch or whatever you intend to build later on): < | ||
+ | | ||
+ | * cherry-pick specific X2Go-related commits from older branches, one '' | ||
+ | * fix any merge conflicts, pull in other upstream code etc. | ||
+ | * update the commit message! | ||
+ | * when done, create patch files: < | ||
+ | |||
+ | Move the patches to the respective source directory and apply them in order. | ||
+ | |||
+ | If needed, install or update '' | ||
+ | |||
+ | == Configuration == | ||
+ | |||
+ | Open a terminal window. Crucially, this must **not** be a '' | ||
+ | |||
+ | Make sure that the mingw toolchain that was used to build Qt (and will be used to build X2Go CLient later on) is part of the %PATH% variable. On the X2Go Windows Builder, a session spawned via '' | ||
+ | |||
+ | Go to the unpacked source directory: < | ||
+ | |||
+ | Create and switch to a build subdirectory: | ||
+ | |||
+ | The pre-built libssh versions in '' | ||
+ | |||
+ | Call '' | ||
+ | |||
+ | == Build == | ||
+ | |||
+ | Build the software like any other, append '' | ||
+ | |||
+ | < | ||
+ | |||
+ | ===== Build X2Go Client ===== | ||
==== Build X2Go Client from source ==== | ==== Build X2Go Client from source ==== | ||
Line 176: | Line 203: | ||
< | < | ||
$ copy debian\changelog txt\ | $ copy debian\changelog txt\ | ||
- | git --no-pager log --since "2 years ago" --format=" | + | $ git --no-pager log --since "2 years ago" --format=" |
$ copy ChangeLog.gitlog txt\git-info | $ copy ChangeLog.gitlog txt\git-info | ||
- | |||
</ | </ | ||
Line 186: | Line 212: | ||
$ PATH=%PATH%; | $ PATH=%PATH%; | ||
$ config_win.bat | $ config_win.bat | ||
+ | $ cd client_build | ||
$ mingw32-make | $ mingw32-make | ||
+ | $ cd .. | ||
$ cd x2gohelper | $ cd x2gohelper | ||
$ mingw32-make | $ mingw32-make | ||
Line 193: | Line 221: | ||
X2Go Client binaries (x2goclient.exe & x2gohelper.exe) are in d: | X2Go Client binaries (x2goclient.exe & x2gohelper.exe) are in d: | ||
+ | |||
==== Build X2Go Client from source (debug build) ==== | ==== Build X2Go Client from source (debug build) ==== | ||
Repeat the instructions for "Build X2Go Client from source", | Repeat the instructions for "Build X2Go Client from source", | ||
Line 199: | Line 228: | ||
- Edit nsis\x2goclient.nsi so that the following lines: | - Edit nsis\x2goclient.nsi so that the following lines: | ||
- | * CreateShortCut " | + | < |
- | | + | |
- | | + | CreateShortCut " |
+ | CreateShortCut " | ||
+ | </ | ||
Are replaced with the following: | Are replaced with the following: | ||
- | * CreateShortCut " | ||
- | * CreateShortCut " | ||
- | * CreateShortCut " | ||
- | ==== Pack/ | ||
- | |||
- | You may want to pack X2Go Client to reduce it size. You can do it with [[http:// | ||
- | |||
- | It is available in [[http:// | ||
< | < | ||
- | x2goclient-contrib\upx\3.91_bin\upx.exe | + | CreateShortCut " |
+ | CreateShortCut " | ||
+ | CreateShortCut " | ||
</ | </ | ||
- | ==== X2Go Client package folder (scripted) ==== | ||
- | To make X2Go Client usable on Windows, you must put X2Go Client binaries | + | ==== Copy the X2Go Client binaries |
- | All of the files referenced below (except for the X2Go Client | + | The 2 binaries |
- | In the base directory of your X2Go Client source tree create a folder named '' | + | - '' |
+ | - '' | ||
- | * X2Go Client binaries | + | However, you must decide where you wish to copy them. |
- | * libraries | + | |
- | * nxproxy with libraries | + | |
- | * Open SSH Server with libraries (optional) | + | |
- | * PuTTY | + | |
- | * VcXsrv | + | |
- | * PulseAudio (optional) | + | |
- | You can then install all of them, except for the X2Go Client binaries, by using the copy-deps-win32.bat script in the x2goclient source | + | - If you wish to run x2goclient from a folder without creating and running |
- | | + | |
- | * 2nd, do a find & replace in the script to replace the path to OpenSSL32-Win32 with your own. | + | |
- | Now run the script, telling it to copy to the dist folder | + | ==== Pack/ |
+ | |||
+ | You may want to pack X2Go Client | ||
+ | |||
+ | Official regular builds of X2Go Client are packed. Official debug builds of X2Go Client are not. There is no difference between nightly and release versions - both pack the release binary, while not packing | ||
+ | |||
+ | It is available in [[http:// | ||
< | < | ||
- | cd x2goclient | + | x2goclient-contrib\upx\3.95_bin\upx.exe |
- | copy-deps-win32.bat dist | + | |
</ | </ | ||
- | Now, copy the 2 x2goclient | + | The 2 files to pack are: |
+ | - '' | ||
+ | - '' | ||
- | - Add x2goclient.exe | + | ===== Building nxproxy & OpenSSH |
- | - Add x2gohelper.exe (from the '' | + | |
+ | Building a new version nxproxy or OpenSSH is optional for non-official X2Go project builds. | ||
- | ==== X2Go Client package folder (manually) ==== | + | Official |
- | - Add x2goclient.exe (from the '' | + | Official X2Go project builds are kept under the x2goclient-contrib git repository under a folder |
- | | + | |
- | - If you are using MinGW 4.4, add its libraries (copy from '' | + | |
- | * '' | + | |
- | * '' | + | |
- | - If you are using MinGW 4.8, add its libraries (copy from '' | + | |
- | * libgcc_s_dw2-1.dll | + | |
- | * libstdc\+\+-6.dll | + | |
- | * libwinpthread-1.dll | + | |
- | - Add OpenSSL libraries | + | |
- | * '' | + | |
- | * '' | + | |
- | - libssh library ([[wiki: | + | |
- | * '' | + | |
- | - libzip library (available [[http:// | + | |
- | * '' | + | |
- | - zlib library for libzip (available [[http:// | + | |
- | * '' | + | |
- | | + | |
- | * '' | + | |
- | - 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. | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | ===== Build/Add nxproxy with libraries ===== | + | |
- | The latest version is available in [[http:// | + | ==== Installing Cygwin ==== |
- | If you ran copy-deps-win32.bat, nxproxy has already been copied over. | + | Download and start the [[https:// |
- | You can download older versions, including their libraries, from here [[http:// | + | Choose your Cygwin directory. For example C:\cygwin. Follow installer instructions. |
- | - Copy the nxproxy binaries directly into the '' | + | For the X2Go-WinBuilder VM, install to D:\cygwin.YYYY-MM-DD instead. |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | If you want to build nxproxy from source, you need install | + | You can automate the entirety of the instructions below with this command, except for selecting the source packages to install: |
- | ==== Installing Cygwin ==== | + | < |
- | + | $ setup-x86.exe -P " | |
- | Download and start the [[http:// | + | </ |
- | + | ||
- | Choose your cygwin directory. For example c:\cygwin. Follow installer instructions. | + | |
- | on installer page " | + | on installer page " |
* '' | * '' | ||
* '' | * '' | ||
* '' | * '' | ||
- | * '' | + | * '' |
* '' | * '' | ||
+ | * '' | ||
* '' | * '' | ||
* '' | * '' | ||
- | * '' | + | |
+ | | ||
* '' | * '' | ||
+ | * '' | ||
* '' | * '' | ||
- | * '' | ||
* '' | * '' | ||
* '' | * '' | ||
- | <note tip>By installing the '' | + | <note tip>By installing the '' |
+ | |||
+ | For building of OpenSSH Server, you will also need: | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | For OpenSSH you should install both, binary and source packages. Toggle the " | ||
If you are updating the X2Go Windows build VM, X2Go-WinBuilder, | If you are updating the X2Go Windows build VM, X2Go-WinBuilder, | ||
Line 328: | Line 329: | ||
* '' | * '' | ||
* '' | * '' | ||
+ | * '' | ||
* '' | * '' | ||
* '' | * '' | ||
Line 339: | Line 341: | ||
* '' | * '' | ||
* '' | * '' | ||
+ | * '' | ||
+ | * '' | ||
- | < | + | If you are doing official builds, install these **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) | + | * '' |
- | </ | + | * '' |
- | < | + | ==== Building nxproxy |
- | ==== Building nxproxy ==== | + | |
- | | + | X2Go Client for Windows is currently built with nxproxy 3.5. |
+ | |||
+ | | ||
< | < | ||
$ cd / | $ cd / | ||
</ | </ | ||
- | * Download and extract the latest nx-libs-lite tarball from http:// | + | * Download and extract the latest nx-libs-lite tarball from [[http:// |
<note warning> | <note warning> | ||
Line 367: | Line 372: | ||
$ tar -xvzf 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 | $ cd nx-libs-3.5.0.27 | ||
+ | </ | ||
+ | |||
+ | Fix building with libpng15 (X2Go Client 4.0.3.x): | ||
+ | < | ||
+ | diff --git a/ | ||
+ | index cdcde84..1f56787 100644 | ||
+ | --- a/ | ||
+ | +++ b/ | ||
+ | @@ -28,7 +28,7 @@ | ||
+ | # | ||
+ | # | ||
+ | # | ||
+ | -#include < | ||
+ | +#include < | ||
+ | |||
+ | # | ||
+ | # | ||
+ | |||
+ | </ | ||
+ | < | ||
+ | diff --git a/ | ||
+ | index 6fa9757..b0699bb 100644 | ||
+ | --- a/ | ||
+ | +++ b/ | ||
+ | @@ -385,7 +385,7 @@ AC_SUBST(ALL) | ||
+ | |||
+ | if test " | ||
+ | | ||
+ | - LIBS=" | ||
+ | + LIBS=" | ||
+ | else | ||
+ | | ||
+ | fi | ||
+ | |||
+ | </ | ||
+ | < | ||
+ | diff --git a/ | ||
+ | index b86828d..5858b36 100644 | ||
+ | --- a/ | ||
+ | +++ b/ | ||
+ | @@ -159,7 +159,7 @@ dnl GCC 3.3.x requires also the z, png and jpeg libraries. This is | ||
+ | dnl not true anymore since GCC 3.4.x. | ||
+ | |||
+ | if test " | ||
+ | - LIBS=" | ||
+ | + LIBS=" | ||
+ | else | ||
+ | | ||
+ | fi | ||
+ | |||
</ | </ | ||
* Build nxcomp | * Build nxcomp | ||
Line 382: | Line 437: | ||
$ ./configure | $ ./configure | ||
$ make | $ make | ||
+ | $ cp -p nxproxy.exe nxproxy.exe.unstripped | ||
$ strip nxproxy.exe | $ strip nxproxy.exe | ||
+ | $ cd .. | ||
+ | </ | ||
+ | |||
+ | ==== Building nxproxy 3.6 ==== | ||
+ | |||
+ | <note tip>X2Go Client for Windows is currently shipped with nxproxy 3.5, not 3.6. However, it should be safe to use 3.6.</ | ||
+ | <note important> | ||
+ | |||
+ | * Open a Cygwin shell and change to your build directory. In this example '' | ||
+ | < | ||
+ | $ cd / | ||
+ | </ | ||
+ | * Download [[nx-libs from Arctica on GitHub|https:// | ||
+ | < | ||
+ | git clone https:// | ||
+ | cd nx-libs | ||
+ | git checkout 3.6.x | ||
+ | </ | ||
+ | * Build nxcomp | ||
+ | < | ||
+ | $ cd nxcomp | ||
+ | $ autoreconf -vfi | ||
+ | $ ./configure | ||
+ | $ make | ||
+ | $ cd .. | ||
+ | </ | ||
+ | * Build nxproxy | ||
+ | < | ||
+ | $ cd nxproxy | ||
+ | $ autreoconf -vfi | ||
+ | $ ./configure | ||
+ | $ make | ||
+ | $ cp -p src/ | ||
+ | $ strip src/ | ||
$ cd .. | $ cd .. | ||
</ | </ | ||
Line 389: | Line 479: | ||
==== Copying the nxproxy binaries ==== | ==== Copying the nxproxy binaries ==== | ||
- | Now the nxproxy binary (nxproxy.exe) is ready. You can copy it into the programme | + | Now the nxproxy binary (nxproxy.exe) is ready. You can copy it into the program |
+ | - nx-libs 3.5: From '' | ||
+ | - nx-libs 3.5: From '' | ||
+ | - nx-libs 3.6: From '' | ||
+ | - nx-libs 3.6: From '' | ||
- | - From nxproxy directory (d: | + | You must also copy required libraries into that folder. |
- | - From nxcomp | + | - From cygwin |
- | - From cygwin directory (c: | + | |
* '' | * '' | ||
* '' | * '' | ||
- | * '' | + | * '' |
+ | * '' | ||
* '' | * '' | ||
* '' | * '' | ||
* '' | * '' | ||
- | < | ||
- | $ cd /usr/bin | ||
- | $ cp --preserve=time -t / | ||
- | ===== Open SSH Server ===== | ||
- | X2Go Client for Windows uses a modified Cygwin Open SSH Server for file sharing. | ||
- | |||
- | The latest version is available in [[http:// | ||
- | |||
- | If you ran copy-deps-win32.bat, | ||
- | |||
- | You can download older versions from [[http:// | ||
- | If you want to build it from source, you should | + | If you wish to facilitate debugging, or if you are updating x2goclient-contrib, you should |
+ | - nx-libs 3.5: From '' | ||
+ | - nx-libs 3.5: From '' | ||
+ | * '' | ||
+ | * '' | ||
+ | - nx-libs 3.6: From '' | ||
+ | - nx-libs 3.6: From '' | ||
+ | * '' | ||
+ | * '' | ||
- | After that run Cygwin installer (setup.exe), | ||
- | *libedit | ||
- | *libedit-devel | ||
- | *libkrb5-devel | ||
- | *libncurses-devel | ||
- | *openssl-devel | ||
- | *patch | ||
- | For openssh you should install both, binary and source packages (toggle " | + | ==== Building OpenSSH Server ==== |
- | Copy the source folder (downloaded and extracted from a tarball by cygwin) to your build directory. In this example | + | Copy the source folder (downloaded and extracted from a tarball by Cygwin) to your build directory. In this example |
< | < | ||
- | $cp -pr / | + | $ cp -pr / |
</ | </ | ||
- | cd to the openssh source directory, extract the upstream (openssh.com) tarball within, and cd to the lower-level source directory | + | '' |
< | < | ||
- | $cd / | + | $ cd / |
- | $tar -xzvf openssh-6.6p1.tar.gz | + | $ tar -xzvf openssh-6.6p1.tar.gz |
- | $cd openssh-6.6p1 | + | $ cd openssh-6.6p1 |
</ | </ | ||
- | Apply any patches that cygwin | + | Apply any patches that Cygwin |
< | < | ||
- | $patch < ../ | + | $ patch < ../ |
</ | </ | ||
Get and apply the X2Go patch, which enables use of the Open SSH Server with X2Go Client | Get and apply the X2Go patch, which enables use of the Open SSH Server with X2Go Client | ||
< | < | ||
- | $wget http:// | + | $ wget http:// |
- | $patch.exe < ../ | + | $ patch.exe < ../ |
</ | </ | ||
Build Open SSH Server | Build Open SSH Server | ||
< | < | ||
- | $./ | + | $ ./configure --libexecdir=/ |
- | $make | + | $ make |
- | $strip *.exe | + | $ strip *.exe |
</ | </ | ||
- | < | + | < |
- | Open SSH Server binaries are ready. Now you can copy them in to the installation directory | + | < |
- | *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: | ||
+ | ==== Copying OpenSSH Server binaries ==== | ||
- | 1st, copy these files over without changing their filenames. | + | Open SSH Server binaries are ready. You can copy it into the program packaging folder ('' |
- | *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: | + | For example: |
+ | < | ||
+ | $ cp --preserve=time 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 the Cygwin directory (c: | ||
+ | |||
+ | First, copy these files over without changing their filenames. | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | For example: | ||
+ | < | ||
+ | $ cd /bin | ||
+ | $ cp --preserve=time cygcrypto-1.0.0.dll cygedit-0.dll cyggcc_s-1.dll cygncursesw-10.dll cygssp-0.dll cygwin1.dll cygz.dll / | ||
+ | </ | ||
+ | |||
+ | Then, copy the dash executable over and rename it: | ||
< | < | ||
ash.exe -> sh.exe | ash.exe -> sh.exe | ||
+ | </ | ||
+ | |||
+ | For example: | ||
+ | < | ||
+ | $ cp --preserve=time ash.exe / | ||
</ | </ | ||
Line 484: | Line 589: | ||
< | < | ||
- | ===== PulseAudio ===== | ||
- | The latest version of PulseAudio for Windows (5.0) is available in [[http:// | + | ===== Copying 3rd-party libraries and components ===== |
- | If you ran copy-deps-win32.bat, | + | ==== Overview ==== |
- | If you are installing it manually, note that you must install | + | To make X2Go Client usable on Windows, all libraries and components must be in the some directory as where the 2 binaries |
+ | |||
+ | All of the files referenced below (except for the OpenSSL-Win32 library, which you installed previously) can be obtained from [[http:// | ||
+ | |||
+ | In the previous step, you chose either the '' | ||
+ | |||
+ | * libraries | ||
+ | * nxproxy with libraries | ||
+ | * Open SSH Server with libraries (optional) | ||
+ | * PuTTY | ||
+ | * VcXsrv | ||
+ | * PulseAudio (optional) | ||
+ | |||
+ | ==== Scripted Copying ==== | ||
+ | |||
+ | You can then install | ||
+ | |||
+ | First, clone [[http:// | ||
+ | |||
+ | Now run the script with the following arguments. In this example: | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | < | ||
+ | $ cd x2goclient | ||
+ | $ copy-deps-win32.bat ..\x2goclient-contrib D: | ||
+ | </ | ||
+ | or to the '' | ||
+ | < | ||
+ | $ cd x2goclient | ||
+ | $ copy-deps-win32.bat nsis\x2goclient | ||
+ | </ | ||
+ | |||
+ | ==== Scripted Copying (debug builds) ==== | ||
+ | |||
+ | Follow the instructions for Scripted Copying. | ||
+ | |||
+ | However, at the end: | ||
+ | |||
+ | - View the '' | ||
+ | - From the Cygwin bundle, '' | ||
+ | - Replace nxproxy.exe with nxproxy.exe.unstripped | ||
+ | |||
+ | ==== Manual Copying ==== | ||
+ | |||
+ | === Libraries === | ||
+ | |||
+ | - Add MinGW 4.8's libraries (copy from '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | - Add OpenSSL libraries (copy from your OpenSSL installation directory) | ||
+ | * '' | ||
+ | * '' | ||
+ | - libssh library ([[wiki: | ||
+ | * '' | ||
+ | - zlib library for libssh (available [[http:// | ||
+ | * '' | ||
+ | - If you want to use X2Go Client on older versions of Windows, you should put the "Microsoft Visual C%%++%% Redistributable 2013 Package"' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | |||
+ | === nxproxy === | ||
+ | |||
+ | The latest version is available in [[http:// | ||
+ | |||
+ | You can download older versions, including their libraries, from here [[http:// | ||
+ | |||
+ | === nxproxy (debug builds)=== | ||
+ | |||
+ | Follow the instructions above for nxproxy. | ||
+ | |||
+ | Except at the end, replace nxproxy.exe with nxproxy.exe.unstripped. | ||
+ | |||
+ | Older builds do not have nxproxy.exe.unstripped; | ||
+ | |||
+ | === OpenSSH Server === | ||
+ | |||
+ | X2Go Client for Windows uses a modified Cygwin OpenSSH Server for file sharing. | ||
+ | |||
+ | The latest version is available in [[http:// | ||
+ | |||
+ | You can download older versions from [[http:// | ||
+ | |||
+ | === PulseAudio === | ||
+ | |||
+ | PulseAudio for Windows 6.0 is used by X2Go Client 4.0.4.x and it is available in [[http:// | ||
+ | |||
+ | PulseAudio for Windows 5.0 is used by X2Go Client 4.0.3.x and it is available in [[http:// | ||
You can download older Windows builds here [[http:// | You can download older Windows builds here [[http:// | ||
- | Even older Windows builds are available from [[http:// | + | Note that the files must be installed to the '' |
- | ===== VcXsrv - XP Compatible ===== | + | Even older Windows builds are available from [[http:// |
- | You can download the X2Go project' | + | === VcXsrv - XP Compatible |
- | Building VcXsrv from source | + | The latest version |
- | 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, | + | You can download older versions, modified by the X2Go project, (VcXsrv - XP Compatible), here: [[http:// |
- | 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 | + | Note that the files must be installed to the '' |
- | The " | + | |
- | If you do install | + | Building |
- | 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. | + | 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, |
+ | |||
+ | If you do install VcXsrv | ||
+ | |||
+ | If you do install VcXsrv via 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. | ||
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: | 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: | + | Also, if you are doing an official X2Go Project build, before importing it into x2goclient-contrib, |
- | *vcxsrv-version.txt | + | Using Debian' |
- | And specify the version string of VcXsrv in it. The version string should be the only contents | + | < |
+ | $ cd / | ||
+ | $ find . -iname ' | ||
+ | </ | ||
+ | If you are doing an official X2Go Project build, create this file in the VcXsrv folder: | ||
+ | * '' | ||
+ | And specify the version string of VcXsrv in it. The version string should be the only content | ||
- | 1.15.2.1+xp-vc2013+x2go1 | + | 1.15.2.3+xp-vc2013+x2go1 |
- | ===== PuTTY ===== | + | |
- | you can download PuTTY for Windows from [[http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html|project site]]. Building PuTTY from source is not the part of this Howto | + | If you are doing an official X2Go Project build, copy the project' |
+ | * '' | ||
- | These are the only binaries you need from PuTTY. Copy them directly into the '' | + | === x3270-fonts ==== |
- | | + | For IBM x3270 compatibility, |
- | *pscp.exe | + | |
+ | Note that versions prior to 3.6 are classified non-free by major distributions due to their custom, restrictive license. Do **not** use and (re-)distribute older versions than 3.6 with X2Go Client. | ||
+ | |||
+ | ==== Updating x3270 Fonts Package ==== | ||
+ | |||
+ | * Check the current licensing situation. Do **not** update the package if it becomes non-free again. | ||
+ | * Build the x3270 package, download a complete precompiled one or just fetch a binary fonts package. Debian conveniently offers one named [[https:// | ||
+ | * Create a new versioned subdirectory in the '' | ||
+ | * Extract the binary fonts. | ||
+ | * Make sure that all binary font files are located in one single directory called '' | ||
+ | * Get copyright and licensing information and place them into a file called '' | ||
+ | * Use Debian' | ||
+ | < | ||
+ | $ find misc -iname ' | ||
+ | </ | ||
+ | * For official builds, create timestamps script: | ||
+ | < | ||
+ | $ cd .. | ||
+ | $ ../ | ||
+ | </ | ||
+ | * For official builds, call the timestamps script in x2goclient-contrib' | ||
+ | * For official builds, update the [[https:// | ||
+ | |||
+ | === PuTTY === | ||
+ | |||
+ | You can download PuTTY for Windows from [[https:// | ||
+ | |||
+ | These are the only binaries you need from PuTTY. Copy them directly into the '' | ||
+ | |||
+ | | ||
+ | * '' | ||
+ | |||
+ | Out of courtesy, we also ship the following additional, not strictly needed binaries: | ||
+ | |||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | |||
+ | ===== Creating an NSIS Installer ===== | ||
+ | |||
+ | Install NSIS (currently, 3.05): https:// | ||
+ | |||
+ | Previously, we used NSIS Unicode, but this project is stale and NSIS 3.x nowadays supports Unicode. | ||
+ | |||
+ | Then, edit '' | ||
+ | |||
+ | Then, open '' | ||
+ | |||
+ | If you wish to build via the command-line, | ||
+ | < | ||
+ | $ " | ||
+ | </ | ||
+ | (Adjust path if on 32-bit Windows.) |