Xvfb Plugin

Skip to end of metadata
Go to start of metadata

Plugin Information

Plugin ID xvfb Changes In Latest Release
Since Latest Release
Latest Release
Latest Release Date
Required Core
Mar 05, 2014
Source Code
Issue Tracking
Open Issues
Zoran Regvart (id: zregvart)
Usage Installations 2013-Apr 1355
2013-May 1414
2013-Jun 1435
2013-Jul 1594
2013-Aug 1628
2013-Sep 1717
2013-Oct 1822
2013-Nov 1899
2013-Dec 1901
2014-Jan 1983
2014-Feb 2076
2014-Mar 2213

Lets you control Xvfb virtual frame buffer X11 server with each build. It starts Xvfb before the build starts, and stops it with the build. This is very useful if your build requires X11 access, for instance runs tests that require GUI.

Project Configuration

New: Use Let Xvfb choose display name option with Xvfb that supports displayfd option to choose the display number automatically by Xvfb.

On the job configuration page, enable the "Start Xvfb before the build, and shut it down after." under the Build Environment.

If you want to customize defaults click on Advanced... button.

  • Xvfb installation lets you choose Xvfb instalation to use, theese are configured by the Jenkins administrator in the Tools section of Jenkins configuration. By default the first defined instalation is used.
  • Let Xvfb choose display name Uses the -displayfd option of Xvfb by which it chooses it's own display name by scanning for an available one. This option requires a recent version (xserver 1.13 or newer). Useful if you do not want to manage display number ranges but have the first free display number be used.
  • Xvfb specific display name lets you customize what displayname should be created, enter a number here and that number prefixed by : will be the displayname (i.e. :1). If none is given display name is based upon Jenkins executor number increased by 1, or the configurable Xvfb display name offset.
  • Timeout in seconds lets you specify the number of seconds before letting the build progress. Since Xvfb is started in background, certain builds might fail because Xvfb was not started quick enough, with this the build is paused the for specified seconds to let Xvfb startup. The default is not to pause the build.
  • Xvfb screen changes the screen resolution and pixel depth, it needs to be in WxHxD format (i.e. 1600x1200x24). The default is 1024x768x24.
  • Xvfb display name offset lets you specify a offset i.e. a number that will be added to the job's executor number that will form the display name used. This is handy if you run other X servers (Xvfb, Xvnc or similar) in order to ensure that display numbers do not overlap.
  • Xvfb additional options lets you specify any additional Xvfb command line options you might need.
  • Log Xvfb output redirects output of Xvfb into job log, useful if you need to troubleshoot Xvfb starting/stopping.
  • Shoutdown Xvfb with whole job, not just with the main build action keeps Xvfb running for post build steps.

Jenkins configuration

Jenkins administrator needs to define the Xvfb tool installation.

The directory in which to find Xvfb executable can be left blank, then PATH is searched to find the executable.

Version History

Version 1.0.9 (Mar 5, 2014)

  • JENKINS-20758 Xvfb processes remain after slave disconnect
  • JENKINS-19950 DISPLAY variable is not overwritten when it already exists
  • JENKINS-21548 Xvfb failure does not fail build
  • New feature that lets Xvfb to pick the display name

Thanks to Marc Günther, Richard Cross and Jonathan Rogers for reporting and beta testing!

Version 1.0.8 (Jun 29, 2013)

  • JENKINS-18094 Xvfb plugin doesn't write any error message in build log

Thanks to Aleksey Alekseev for reporting and testing!

Version 1.0.7 (Dec 9, 2012)

Thanks to Yves Langisch for reporting the feature request!

Version 1.0.6 (Nov 5, 2012)

  • JENKINS-15638 Xvfb 'display name offset' defaults to 0, not 1 as described, if unset

Thanks to Fredrik Vihlborg for re-reporting issues!

Version 1.0.5 (Oct 30, 2012)

  • JENKINS-15638 Xvfb 'display name offset' defaults to 0, not 1 as described, if unset

Thanks to Fredrik Vihlborg for reporting issues!

Version 1.0.4 (Oct 24, 2012)

  • JENKINS-14483 Remaining Xvfb processes in matrix jobs
  • pull request #2 Make sure the random display name is always more than 0.
  • JENKINS-15608 Xvfb 'specific displayname' selects a random display between 0..100, not 1..100.

Thanks to Thorsten Kahler for reporting the issue and exemplary patience in testing, JeroenVanHab for the pull request and Fredrik Vihlborg for reporting the issue!

Version 1.0.3 (Sep 15, 2012)

Thanks to Brian Sipos and Daniel Piorkowski for reporting issues!

Version 1.0.2 (Mar 12, 2012)

  • Field to add additional options to Xvfb command line (JENKINS-13046)

Version 1.0.1 (Jan 29, 2012)

  • Initial release


plugin-buildwrapper plugin-buildwrapper Delete
plugin-xvfb plugin-xvfb Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Add Comment