Table of Contents
- Setup - The basics of getting started with irssi
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Contributors - List of those who've helped to make the module better
This module provides simple classes and types for installing the irssi chat client on a system, and setting up user configuration and scripts.
What irssi affects
This module installs the irssi package and may optionally be used to manage one or more user configuration directories.
Currently, this module only supports Ubuntu (tested on Ubuntu 14.04), but will likely work on otehr Debian-based distributions.
Beginning with irssi
To install this modual, call:
puppet module install brwyatt-irssi
To install irssi on agent, simply include it into your manifests.
Installs and realizes user configuration for irssi by including
Realizes user configuration for irssi.
Installs the irssi package with the default system package provider.
Default values for class parameters are derived from Hiera data files in
package_ensure: Package ensure value (defaults to "latest")
package_name: Name of the package (defaults to "irssi" on Debian)
Manages an irssi config directory and config file.
owner: (required) System owner of the files and directories
config_dir: (namevar) Path of the config directory to manage
networks: Hash of networks and their configurations TODO: Describe structure
real_name: Default real name of the user
user_name: Default user name of the user
nick_name: Default nick name of the user
windows: Array of pre-defined windows and their settings TODO: Describe structure
purge_scripts: Whether the scripts directory should have unmanaged scripts purged (default: false)
Manages scripts installed in a config directory.
config_dir: (required) Config directory this script should be installed to
owner: (required) System owner of the script
source: Source for the file (required unless
content: Content of the file (required unless
user_config: (optional) Name of the
irssi::user_configif named differently than the default
autorun: Controls whether the script should be enabled to auto-load on irssi start. (default: false)
script_name: (namevar) The filename for the script file
Currently, this module is only tested against Ubuntu 16.04. It will likely work on other Debian-based distributions, and may or may not work on RedHat-based distributions, but makes no claims regarding such.
I may not have much time to work on (or test) this myself, so help to expand current functionality (especially to make it work for more people) is greatly appreciated and encouraged.
The list of contributors can be found at: https://github.com/brwyatt/puppet-irssi/graphs/contributors.