NOTICE: This project is dormant and looking for a new owner. If you would like to assume the role of maintaining this project, please get in touch with [email protected]
- Overview
- Setup - The basics of getting started with display
- Usage - Configuration options and additional functionality
- Reference - classes and parameters
- Limitations - OS compatibility, etc.
- Contributors
The display module can manage Xvfb (X Virtual Framebuffer) and x11vnc for remote displays.
The base class, display, can be used to manage both xvfb and x11vnc
together.
xvfb and x11vnc can be managed individually using their own classes if
desired.
Additionally, a profile.d helper script can be managed that exports the
DISPLAY environment variable.
The display module can manage the following:
- xvfb package
- xvfb service
- x11vnc package
- x11vnc service
To manage xvfb and x11vnc with default parameters:
include ::displayCustom display, resolution and color depth:
class { 'display':
display => 99, # default is 0
width => 1024, # default is 1280
height => 768, # default is 800
color => 24, # default is "24+32" (i.e. 32-bit)
}Running as a custom user (both xvfb and x11vnc):
class { 'display':
runuser => 'xvfbservice',
}Only manage xvfb (e.g. not x11vnc) and specify a custom user and fbdir:
class { 'display::xvfb':
runuser => 'xvfbuser',
fbdir => '/var/tmp/xvfb',
}Only manage x11vnc:
class { 'display::x11vnc':
display => 3,
runuser => 'x11user',
}- display: Main class, includes all other classes (wrapper)
- display::xvfb: Manages xvfb
- display::x11vnc: Manages x11vnc
X display to use. Default is 0
Screen width to use. Default is 1280
Screen height to use. Default is 800
Screen color depth to use. Default is '24+32' (32-bit)
User to run xvfb as. Default is 'root'
Directory in which the memory mapped files containing the framebuffer memory
should be created. Defaults to '/tmp'
Package name for installing xvfb. Defaults to xorg-x11-servers-Xvfb on
RedHat systems and xvfb on Debian systems.
Name of the xvfb service. This class will create an init script with this
name and manage a service by this name. Defaults to xvfb
Absolute path to the xvfb executable. Defaults to /usr/bin/xvfb on
RedHat and Debian systems and /usr/local/bin/Xvfb on FreeBSD.
Custom arguments to use for starting xvfb. If this parameter is defined, the display, width, height, color, and fbdir parameter values will not be used for starting the xvfb service via the init script - that's left up to the user. Optional. Defaults to undefined.
Package name for installing x11vnc. Defaults to x11vnc on RedHat and
Debian systems.
Name of the x11vnc service. This class will create an init script with
this name and manage a service with this name. Defaults to x11vnc
Absolute path to the x11vnc executable. Defaults to /usr/bin/x11vnc on
RedHat and Debian systems and /usr/local/bin/x11vnc on FreeBSD.
Custom arguments to use for starting x11vnc. If this parameter is defined, the display parameter is unused for starting x11vnc - that's left up to the user. Optional. Defaults to undefined.
Boolean. Provide a profile.d script to export the DISPLAY variable.
Defaults to true.
NOTE: This parameter and the display::env class is being deprecated and will soon be removed.
Absolute path to place a profile.d script that exports the DISPLAY
variable. Defaults to /etc/profile.d/vagrant_display.sh
This is only effective if 'profiled' is true.
NOTE: This parameter and the display::env class is being deprecated and will soon be removed.
X display to use. Default is 0
Screen width to use. Default is 1280
Screen height to use. Default is 800
Screen color depth to use. Default is '24+32' (32-bit)
User to run xvfb as. Default is 'root'
Directory in which the memory mapped files containing the framebuffer memory
should be created. Defaults to '/tmp'
Package name for installing xvfb. Defaults to xorg-x11-servers-Xvfb on
RedHat systems and xvfb on Debian systems.
Custom arguments to use for starting xvfb. If this parameter is defined, the display, width, height, color, and fbdir parameter values will not be used for starting the xvfb service via the init script - that's left up to the user. Optional. Defaults to undefined.
Name of the xvfb service. This class will create an init script with this
name and manage a service by this name. Defaults to xvfb
X display to use. Default is 0
User to run xvfb as. Default is 'root'
Package name for installing x11vnc. Defaults to x11vnc on RedHat and
Debian systems.
Name of the x11vnc service. This class will create an init script with
this name and manage a service with this name. Defaults to x11vnc
Absolute path to the x11vnc executable. Defaults to /usr/bin/x11vnc on
RedHat and Debian systems and /usr/local/bin/x11vnc on FreeBSD.
Custom arguments to use for starting x11vnc. If this parameter is defined, the display parameter is unused for starting x11vnc - that's left up to the user. Optional. Defaults to undefined.
NOTE: This class is being deprecated and will soon be removed.
This is better managed by your own implementation class. For example, a profile class.
Absolute path where a file should be place that exports the DISPLAY
environment variable. Defaults to /etc/profile.d/vagrant_display.sh
X display to use. Default is 0
This module has been built on a tested against Puppet 3.
Supported and tested on RedHat, Debian, and FreeBSD families.
Alex Rodionov https://github.com/p0deje
Josh Beard http://joshbeard.me
Joshua Hoblitt https://github.com/jhoblitt
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent