Debian Codegraph @

doc/README.NX-development

raw
1 # NX development by ArticaProject, X2Go and TheQVD
2
3 This source tree started as a re-distribution of those NX packages needed
4 to setup FreeNX and/or X2Go on a Linux server.
5
6 In the past, the NX re-distribution (3.5.0.x) had been maintained by the X2Go Project:
7 http://wiki.x2go.org
8
9 In 2014, [the QVD project](http://theqvd.com) run by the company Qindel
10 joined the group of people being interested in NX maintenance and
11 improvement.
12
13 Since 2015, the Arctica Project has joined in the NX development. The core devs
14 of X2Go, Arctica and TheQVD have agreed on stopping to redistribute NX and to
15 continue the development of NX 3.x as the new upstream instead. The package
16 will see a slight name change to **nx-libs** starting with version 3.5.99.0.
17
18 Our intentions for nx-libs are:
19
20 * provide _one_ tarball that builds NX projects via a common Makefile
21 * provide _one_ tarball for distribution packagers
22 * provide support for security issues
23 * provide support for latest X11 extensions
24 * improve NX where possible while still staying compatible to FreeNX and NoMachine 3.x
25
26
27 This source tree is maintained on Github:
28
29 https://github.com/ArcticaProject/nx-libs (3.6.x branch)
30
31 For the the post-NoMachine era of nx-libs, we will focus on two release
32 phases for the upcoming two years.
33
34 ## Release series 3.6.0.x
35
36 Release goals (phase 1) for nx-libs release series 3.6.0.x:
37
38 * CVE security audit (complete)
39 * remove unused code (+/- complete)
40 * no bundled non-X11 libraries anymore (complete)
41 * complete imake cleanup (+/- complete)
42 * replace as many libNX_X* libraries by X.org's libX* libraries
43 (complete, only remaining library: libNX_X11)
44 * support for iOS (nxproxy, complete)
45 * Unix file socket communication for nxproxy -C <-> nxproxy -S connections
46 (complete)
47 * allow Unix file sockets as channel endpoints (complete)
48 * allow embedding of nxproxy into other windows (work pending)
49 * new RandR based Xinerama extension (+/- complete, more QA needed)
50 * Fix Xcomposite extension in Xserver (work pending)
51 * nxcomp protocol clean-up (complete)
52 * nxcomp logging clean-up (work pending)
53 * optimizing documentation: how to tune NX connections (work pending)
54
55
56 ## Release series 3.7.0.x
57
58 Release goals (phase 2) for nx-libs release series 3.7.0.x (not branched-off, yet):
59
60 * rebase Xserver code against latest X.Org server (work in progress)
61 * event FIFO sockets for attaching external applications
62 (todo, to be discussed)
63 * enable/support XV extension (todo)
64 * software cursor for shadow sessions (todo)
65 * no bundled Mesa library anymore (todo, to be discussed)
66 * use recent MesaGL (todo, to-be-discussed)
67
68
69 If you have any questions about this NX development or want to file a bug
70 report, please contact the Arctica developers, the X2Go developers or the
71 TheQVD developers via the project's Github issue tracker.
72
73 *Sincerely,*
74
75 *The nx-libs developers (a combined effort of ArcticaProject / TheQVD / X2Go)*
76
77 ## Building Under Fedora or EPEL using Mock
78
79 Assuming:
80
81 1. The branch you are building is 3.6.x
82 2. The current version is 3.5.99.0 (specified in the .spec file)
83 3. The current release is 0.0build1 (specified in the .spec file)
84 4. You wish for the RPM files and the mock build logs to be under ~/result
85
86 Prerequisites:
87
88 1. Install package "mock"
89 2. Add your user account to the "mock" group (recommended)
90 3. cd to the nx-libs directory that you cloned using git
91
92 ```
93 mkdir -p ~/result
94 git archive -o ../nx-libs-3.5.99.0.tar.gz --prefix=nx-libs-3.5.99.0/ 3.6.x
95 cp --preserve=time nx-libs.spec ../
96 cd ..
97 mock --buildsrpm --spec ./nx-libs.spec --sources ./nx-libs-3.5.99.0.tar.gz --resultdir ~/result
98 mock --rebuild ~/result/nx-libs-3.5.99.0-0.0build1.fc23.src.rpm --resultdir ~/result
99 ```
100
101 The end result is RPMs under ~/result that you can install (or upgrade to) using yum or dnf, which will resolve their dependencies.
102
103 ## Building for openSUSE using OBS Build
104
105 Assuming:
106
107 1. The branch you are building is 3.6.x
108 2. The current version is 3.5.99.0 (specified in the .spec file)
109 3. The current release is 0.0build1 (specified in the .spec file)
110 4. You wish for the RPM files and the obs-build logs to be under ~/rpmbuild
111
112 Prerequisites:
113
114 1. Install package "obs-build"
115 2. Make sure your user account can become root via sudo
116 3. cd to the nx-libs directory that you cloned using git
117
118 ```
119 mkdir -p ~/rpmbuild/SOURCES ~/rpmbuild/RPMS ~/rpmbuild/SRPMS ~/rpmbuild/OTHER ~/rpmbuild/BUILD
120 git archive -o $HOME/rpmbuild/SOURCES/nx-libs-3.5.99.0.tar.gz --prefix=nx-libs-3.5.99.0/ 3.6.x
121 cp --preserve=time nx-libs.spec ~/rpmbuild/SOURCES
122 cd ..
123 sudo obs-build --clean --nosignature --repo http://download.opensuse.org/distribution/<OPENSUSE-VERSION>/repo/oss/suse/ --root /var/lib/obs-build/ ~/rpmbuild/SOURCES/nx-libs.spec
124 cp -ar /var/lib/obs-build/home/abuild/rpmbuild/RPMS/* ~/rpmbuild/RPMS/
125 cp -ar /var/lib/obs-build/home/abuild/rpmbuild/SRPMS/* ~/rpmbuild/SRPMS/
126 cp -ar /var/lib/obs-build/home/abuild/rpmbuild/OTHER/* ~/rpmbuild/OTHER/
127 cp -ar /var/lib/obs-build/.build.log ~/rpmbuild/BUILD/
128 ```
129
130 The end result is RPMs under ~/result that you can install (or upgrade to) using yum or dnf, which will resolve their dependencies.
131
132 ## Building Under Debian or Ubuntu using debuild
133
134 Assuming:
135
136 1. The current version is 3.5.99\* (specified in debian/changelog)
137
138 Prerequisites:
139
140 1. Install package "devscripts"
141 2. Install the build dependencies. `dpkg-checkbuilddeps` can help you identify them.
142
143 ```
144 git clone <url> nx-libs
145 cd nx-libs
146 debuild -uc -us
147 cd ..
148 sudo dpkg -i *3.5.99*.deb
149 ```
150
151 ## Building on Windows
152
153 The only components that can be built on Windows at the time of writing are `nxcomp` and `nxproxy` (with the latter utilizing the former).
154
155 **The next section is only relevant for git-based source code builds. Released tarballs do not require special handling.**
156
157 Since this project makes use of UNIX-style symlinks, it is imperative to clone the repository using Cygwin's git binary. MSYS(2) git is not able to handle UNIX-style symlinks.
158 Make sure that all build utilities are Cygwin-based. Non-Cygwin binaries will bail out with errors during the build process or insert garbage.
159
160
161 ## Binary Builds
162
163 Most major Linux distribution come with nx. However, their packages
164 are often not the most current releases so we encourage you to update
165 to the newest release.
166
167 ### Debian/Ubuntu
168 You can obtain binary builds of nx-libs for Debian and Ubuntu via these apt-URLs:
169
170 Debian: deb http://packages.arctica-project.org/debian {YOUR DIST VERSION} main
171 Ubuntu: deb http://packages.arctica-project.org/ubuntu {YOUR DIST VERSION} main
172
173 Our package server's archive key is: 0x98DE3101 (fingerprint: 7A49
174 CD37 EBAE 2501 B9B4 F7EA A868 0F55 98DE 3101). Use this command to
175 make APT trust our package server:
176
177 wget -qO - http://packages.arctica-project.org/archive.key | sudo apt-key add -
178
179 ### RedHat based
180
181 For RedHat based distributions current packages can be found at
182
183 https://bodhi.fedoraproject.org/updates/?packages=nx-libs
184
185 Please note that these are not always current as the builds are done manually.
186
187
188 ## Compatibility with other NX based software
189
190 FreeNX is a free replacement of the original nxserver by
191 nomachine. OpenNX-CE is OSS GUI client replacing the original
192 nomachine nxclient. nx-libs is developed with those projects in mind
193 and tries to stay compatible with FreeNX and nomachine NX. While
194 looking abandoned for many years some people are still using and
195 improving these packages. For current repos see
196
197 * https://github.com/dimbor-ru/freenx-server
198 * https://github.com/dimbor-ru/opennx
199
200 Thanks to dimbor for providing/maintaining these.
201
202 Etersoft is offering a commercial software called RX. Their OSS client
203 called rxclient also aims to be compatible to FreeNX and nomachine and
204 is based on opennx. You can find repos for their software here:
205 * https://github.com/Etersoft/rxclient
206 * https://github.com/Etersoft/rx-etersoft