Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

tmux

Installs the tmux terminal multiplexer
Project URLRSS FeedReport issues

8,410 downloads

8,410 latest version

4.6 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 Jul 31st 2015
This version is compatible with:
  • ,

Start using this module

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

Add this module to your Puppetfile:

mod 'maxhope-tmux', '0.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add maxhope-tmux
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install maxhope-tmux --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

maxhope/tmux — version 0.1.0 Jul 31st 2015

tmux

Table of Contents

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

Overview

This module installs tmux.

Module Description

This module installs tmux in an easy way.

Setup

What tmux affects

  • Will create the file /etc/tmux.conf
  • Will create an emty .tmux.conf in all users home dirs for user specific settings

Setup Requirements

  • pluginsync must be enabled (enabled by default in Puppet version 4 and above)

Beginning with tmux

Just type 'tmux' in the terminal to begin. I recommend you to read the tmux man pages for information of how to use tmux.

Usage

To install tmux:

class{'::tmux':}

To uninstall tmux:

class{'::tmux':
  ensure => 'absent',
}

To set some custom parameters:

class{'::tmux':
  set_option => ['-g prefix C-a', '-g base-index 1'],
  bind_key   => ['C-a send-prefix', '-t vi-copy "v" begin-selection', '-t vi-copy "y" copy-selection'],
}

Reference

This module contains a facter called 'userdirs' and is under the lib/facter folder in the tmux module. It just returns an array of all users home directorys, that is all users that have a home dir under /home.

Class parameters

  • ensure
  • set_option
  • set_window_option
  • bind_key
  • set
  • unbind_key

Limitations

Puppet version 3 or above is required.

Development

Please se the github page for this module at https://github.com/maxhope/puppet-tmux. I would be more than happy if you would contribute with improvements.