Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

gnuscreen

Puppet Module for installing and configuring GNU Screen
Project URLRSS FeedReport issues

6,246 downloads

6,246 latest version

1.9 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.1.0 (latest)
released Oct 13th 2017

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'cmiersma-gnuscreen', '0.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add cmiersma-gnuscreen
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install cmiersma-gnuscreen --version 0.1.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

cmiersma/gnuscreen — version 0.1.0 Oct 13th 2017

gnuscreen

Table of Contents

  1. Description
  2. Setup - The basics of getting started with gnuscreen
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module

Description

This module installs and configures GNU Screen on a user by user basis. It has been tested on Redhat/CentOS/Fedora distros.

This module is divided into a packages and a config class. The config class can be used by a non-root user. It creates a .screen directory, which can hold multiple configurations and log files. If the .screenrc file does not exist it symlinks to a default config, which is more useful than the system screenrc. Users can overwrite or point the symlink elsewhere, so it will be easy to install this side-by-side with another configuration and use both. Future alternate configurations will be deployed in the same way. Rather than trying to template the .screenrc, this just provides a means of managing multiple alternate config files.

Setup

What gnuscreen affects

If you are using ~/.screen or ~/.screenrc for anything, it may cause conflict.

Beginning with gnuscreen

You module is designed to be used on a user by user basis. The default will configure the root user.

Usage

This module assumes you have a valid user home. You must pass determine a user's home directory externally and pass that to the module. Otherwise, it will configure root.

Typically, it would be called as below:

class { 'gnuscreen':
  user_home => '/home/username',
}

This would install this configuration for the user username.

Reference

It includes two classes packages and config.

Limitations

It has only been tested on Fedora, but should work on most Linux distros. The default screen config launches some applications that may not be installed on all systems.

Development

This is currently a minimal release. Anything may change.