README.md

Dullahan Plugin Xvfb

Allows Dullahan to manage Xvfb by starting, stopping and/or re-using a virtual frame buffer whenever Dullahan needs it.

Install this plugin:

yarn add @k2g/dullahan-plugin-xvfb

Note: Our documentation uses yarn commands, but npm will also work. You can compare yarn and npm commands in the yarn docs, here.

Now that the plugin is installed, you can add it to your Dullahan configuration file:

export default {
    plugins: [
        '@k2g/dullahan-plugin-xvfb'
    ]
}

This plugin uses xvfb internally and passes through all options given to it. A value of - means that the plugin leaves it up to xvfb to decide.

name	type	default	description
displayNum	integer	-	See xvfb
reuse	boolean	-	See xvfb
timeout	integer	-	See xvfb
silent	boolean	-	See xvfb
xvfb_args	string	-	See xvfb

To change any of these options, pass along an object containing the options you wish to change to Dullahan:

export default {
    plugins: [
        ['@k2g/dullahan-plugin-xvfb', {
            displayNum: 13
        }]
    ]
}

Question: What happens if I use this plugin on a system that does not have or support Xvfb?

Answer: Dullahan will display an error stating that Xvfb failed to start and will then shut down.