Table of Contents

• Description
  • This is a SIMP module
• Setup
  • What x2go affects
• Usage
• Development
  • Acceptance tests

Description

This is a module for managing x2go server and client installations.

This is a SIMP module

This module is a component of the System Integrity Management Platform, a compliance-management framework built on Puppet.

If you find any issues, they may be submitted to our bug tracker.

See ./REFERENCE.md for API details.

Setup

What x2go affects

The x2go module is quite minimal, like x2go itself and simply installs the required packages and allows you to configure the most common files with safe defaults in place.

Usage

The x2go client is installed by default. To disable this, set x2go::client to false in Hiera.

To install and configure the x2go server, set x2go::server to true in Hiera.

x2go requires a functioning window manager on the server to be useful and it does not perform well with compositing window managers, such as GNOME 3.

See https://wiki.x2go.org/doku.php/doc:de-compat for additional information.

It is recommended that you use the SIMP gnome module and set enable_mate to use the MATE window manager (or GNOME 2 if MATE is not available).

NOTE: The x2go server clipboard is set to server by default. This means that the client clipboard will not be exposed to the server to which you are connecting. This is done to prevent sensitive information from the client leaking onto the server by accident.

You can change this by setting the following in Hiera:

---
x2go::server::agent_options:
  '-clipboard': 'both'

Valid options include:

• both => Bi-directional clipboard
• server => Server side and Server to Client
• client => Client side and Client to Server
• none => Disable the clipboard

Development

Please read our Contribution Guide.

Acceptance tests

This module includes Beaker acceptance tests using the SIMP Beaker Helpers. By default the tests use Vagrant with VirtualBox as a back-end; Vagrant and VirtualBox must both be installed to run these tests without modification. To execute the tests run the following:

bundle install
bundle exec rake beaker:suites

NOTE: When testing this module, you will probably want to run with BEAKER_destroy=no, install the x2go client locally and connect to the running VM to ensure proper functionality.

Please refer to the SIMP Beaker Helpers documentation for more information.