Forge Home

tmux

Install, manage and configure tmux and set per user profiles for tmux

536 downloads

536 latest version

5.0 quality score

Version information

  • 2.0.0 (latest)
released Jul 29th 2021
This version is compatible with:
  • Puppet Enterprise 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x
  • Puppet >= 5.5.10 < 8.0.0
  • , , , , , , , , , , , ArchLinux

Start using this module

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

Add this module to your Puppetfile:

mod 'rehan-tmux', '2.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install rehan-tmux --version 2.0.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

rehan/tmux — version 2.0.0 Jul 29th 2021

puppet-tmux

Build Status

This module is a clone of zanloy/tmux. It removes the global /etc/tmux.conf based config file in favor of using ohmytmux on per user profile level.

Manage tmux via puppet.

tmux is a terminal multiplexer. It lets you switch easily between several programs in one terminal, detach them (they keep running in the background) and reattach them to a different terminal. And do a lot more.

Sample Usage

Install tmux and use the provided configuration defaults

class { 'tmux': }

Install tmux with different package management options

class { '::tmux':
  package_manage => true,
  package_name   => 'tmux',
  package_ensure => 'latest',
}

Uninstall tmux

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

Class parameters

  • package_ensure

    • Accepted values: present, absent, latest
    • Default: present
    • Description: Whether or not tmux will be installed
  • package_manage

    • Accepted values: true or false
    • Default: true
    • Description: Whether or not this module will be allowed to manage tmux package using system package manager.
  • package_name

    • Accepted values: non-empty string
    • Default: tmux
    • Description: Lets you override the default package name on a given system.

All of this data can be provided through Hiera.

YAML

tmux::package_manage: true
tmux::package_ensure: present
tmux::package_name: 'tmux'
tmux::download_home: '/opt/tmux'
tmux::profiles:
  root:
    manage: true
    ensure: present
  user1:
    manage: true
    ensure: present
  user2:
    manage: true
    ensure: absent