This plugin lets you run an Xvnc session during a build. This is handy if your build includes UI testing that needs a display available.
Each build using the plugin gets its own display allocated from a free
list, by default starting with :10 and ending with :99.
(The $DISPLAY environment variable is set for the build by the plugin.)
Thus you can freely run builds on multiple executors without fear of interference.
If there is some problem starting a display server with a given number,
that number will be blacklisted
for the remainder of the Hudson session and the plugin will try ten more times before giving up.
This is commonly due to stale locks that did not get cleaned up properly.
There is also an option to clean up locks when starting the first Xvnc-enabled build in a given session.
You can record your vnc session with VncRecorder Plugin.
Note: you must have started the vncserver at least one time before you use it with hudson. This is to create a password. Otherwise Jenkins fails. This blog post describes how.
If you are running Windows you probably do not want this plugin. This blog post offers an alternative suggestion.
- JENKINS-36845: ConcurrentModificationException when using Xvnc plugin on Pipeline.
- A small bugfix when overwriting the XAUTHORITY env var during vnc setup retry.
- A workaround for JENKINS-19139 where the xautority file is placed in the slave fs root if the build's workspace contains a space, or in tmp if that also contains a space.
- Requires 1.609.1+.
- JENKINS-26477 Workflow plugin support.
- JENKINS-25424 Exception when editing nodes
- JENKINS-24773 Allocated and blacklisted display number are shared accross all slaves
- JENKINS-22105 Client
is not authorized to connect to Server.
This will reintroduce the problem with spaces in job names. To avoid that bug:
- avoid using spaces in job names, or
- fix the vncserver script: add qoutes around the xauthority filename when xauth is called, or
- turn off per job xauthority file generation.
- JENKINS-19139 Xvnc plugin fails if the job has a space in the name
- JENKINS-18108 "Unrecognized option: UI" in v1.14
- JENKINS-17280 Display number out of bounds, no way to reset
- JENKINS-17550 Xvnc plugin tries to use already allocated displays
- Automatic clearing of blacklist when run out of available ports
- Changed the configurable base display number to a configurable range of display numbers.
- Randomly retry ten times to find a working display number before giving up.
- JENKINS-16879 More robust display detection needed - builds fail when many builds require Xvnc
- JENKINS-8670 Bind vncserver to localhost for enhanced security.
- JENKINS-3285 Option to clean up stale locks & processes.
- JENKINS-3680 Do
vncserver -killin workspace directory.
- Added a mechanism to exclude Xvnc execution on specific nodes
- Added an option to skip Xvnc execution on all Windows machines
- Ensure screenshot is taken when selected
- Update code for more recent Hudson
- Retry several times before giving up on attempt to get a display, blacklisting displays each time.
- If the user forgot to put
:$DISPLAY_NUMBERin the command line, issue a warning (report)
- Better help.
- Updated to new form validation style.
- Can be configured to take a screenshot of the X session upon build completion. These screenshots are treated as build artifacts. This functionality requires Imagemagick
- Updated to work with the latest Hudson patch