https://github.com/simp/pupmod-simp-x2go
Puppet module for x2go
https://github.com/simp/pupmod-simp-x2go
Last synced: about 1 year ago
JSON representation
Puppet module for x2go
- Host: GitHub
- URL: https://github.com/simp/pupmod-simp-x2go
- Owner: simp
- License: other
- Created: 2018-05-16T17:43:08.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-20T19:54:17.000Z (almost 2 years ago)
- Last Synced: 2025-04-13T05:53:50.110Z (about 1 year ago)
- Language: Ruby
- Size: 127 KB
- Stars: 0
- Watchers: 16
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
[](http://www.apache.org/licenses/LICENSE-2.0.html)
[](https://bestpractices.coreinfrastructure.org/projects/73)
[](https://forge.puppetlabs.com/simp/x2go)
[](https://forge.puppetlabs.com/simp/x2go)
[](https://travis-ci.org/simp/pupmod-simp-x2go)
#### Table of Contents
* [Description](#description)
* [This is a SIMP module](#this-is-a-simp-module)
* [Setup](#setup)
* [What x2go affects](#what-x2go-affects)
* [Usage](#usage)
* [Development](#development)
* [Acceptance tests](#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](https://simp-project.com), a
compliance-management framework built on Puppet.
If you find any issues, they may be submitted to our [bug tracker](https://simp-project.atlassian.net/).
See [./REFERENCE.md](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](https://github.com/simp/pupmod-simp-gnome)
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:
```yaml
---
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](https://simp.readthedocs.io/en/stable/contributors_guide/index.html).
### Acceptance tests
This module includes [Beaker](https://github.com/puppetlabs/beaker) acceptance
tests using the SIMP [Beaker Helpers](https://github.com/simp/rubygem-simp-beaker-helpers).
By default the tests use [Vagrant](https://www.vagrantup.com/) with
[VirtualBox](https://www.virtualbox.org) as a back-end; Vagrant and VirtualBox
must both be installed to run these tests without modification. To execute the
tests run the following:
```shell
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](https://github.com/simp/rubygem-simp-beaker-helpers/blob/master/README.md)
for more information.