An open API service indexing awesome lists of open source software.

https://github.com/simp/pupmod-simp-gnome

The SIMP windowmanager Puppet Module
https://github.com/simp/pupmod-simp-gnome

Last synced: 6 months ago
JSON representation

The SIMP windowmanager Puppet Module

Awesome Lists containing this project

README

          

[![License](https://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/73/badge)](https://bestpractices.coreinfrastructure.org/projects/73)
[![Puppet Forge](https://img.shields.io/puppetforge/v/simp/gnome.svg)](https://forge.puppetlabs.com/simp/gnome)
[![Puppet Forge Downloads](https://img.shields.io/puppetforge/dt/simp/gnome.svg)](https://forge.puppetlabs.com/simp/gnome)
[![Build Status](https://travis-ci.org/simp/pupmod-simp-gnome.svg)](https://travis-ci.org/simp/pupmod-simp-gnome)

#### Table of Contents

* [Description](#description)
* [This is a SIMP module](#this-is-a-simp-module)
* [Setup](#setup)
* [Usage](#usage)
* [Reference](#reference)
* [Limitations](#limitations)
* [Development](#development)

## Description

`gnome` is a Puppet module that installs and manages a GNOME 3 installation.

### 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/).

This module is optimally designed for use within a larger SIMP ecosystem, but
it can be used independently:

* When included within the SIMP ecosystem, security compliance settings will
be managed from the Puppet server.
* If used independently, all SIMP-managed security subsystems are disabled by
default and must be explicitly opted into by administrators. See
[simp_options](https://github.com/simp/pupmod-simp-simp_options) for more
detail.

## Setup

To use the module with default settings, just include the class:

```ruby
include 'gnome'
```

## Usage

You can disable configuration of gnome by setting `gnome::configure` to false.
The module will then only install Gnome.

This module makes heavy use of data. The `dconf` and `gconf` settings are all
data-driven, and the defaults can be seen in the
[common.yaml](data/common.yaml).

You can use the knockout prefix of `--` in front of a key to remove it from the
Hash, like this:

```yaml
gnome::dconf_hash:
simp_gnome:
--org/gnome/settings-daemon/plugins/media-keys:
org/gnome/desktop/media-handling:
--automount-open:
```

Or you can simply set it to the desired value.

`Dconf` settings are locked by default so that users can't change them.

This can be disabled on a per setting basis, like in this entry for wallpaper
in `gnome::dconf_hash`:

```yaml
gnome::dconf_hash:
simp_gnome:
org/gnome/desktop/background:
picture-uri:
value: file:///usr/local/corp/puppies.jpg
lock: false
```

## Reference

See the [API documentation](./REFERENCE.md) for details.

## Limitations

SIMP Puppet modules are generally intended for use on Red Hat Enterprise Linux
and compatible distributions, such as CentOS.

Please see the [`metadata.json` file](./metadata.json) for the most up-to-date
list of supported operating systems, Puppet versions, and module dependencies.

This module is compatible with GDM v3.

## Development

Please read our [Contribution Guide](https://simp.readthedocs.io/en/stable/contributors_guide/index.html)