Forge Home

profanity

A Puppet module to install and manage Profanity XMPP client.

8,726 downloads

6,868 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.

Version information

  • 0.2.2 (latest)
  • 0.2.1
  • 0.2.0
  • 0.1.0
released Jun 14th 2016
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 'jon6000-profanity', '0.2.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add jon6000-profanity
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install jon6000-profanity --version 0.2.2

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

jon6000/profanity — version 0.2.2 Jun 14th 2016

profanity

Table of Contents

  1. Description
  2. Setup - The basics of getting started with profanity
  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 allows you to manage Profanity, a console-based XMPP chat client. It has been tested on Ubuntu, Debian and CentOS. Puppet 4.0.0 or higher is required.

As well as Profanity itself, the module can also manage Profanity accounts and the .profrc file. It also provides the profanity::account defined type, allowing accounts to be managed from other modules.

Profanity website: http://profanity.im

Setup

What profanity affects

Profanity will install libstrophe, as well as several packages. Details can be found inside params.pp.

The module is dependant on puppetlabs/concat.

Setup Requirements

Beginning with profanity

As a bare minimum, the following will ensure Profanity is installed on your system:

include profanity

Usage

By default the module will not manage the .profrc file or any chat accounts. You are therefore free to create or alter these manually without Puppet interfering.

Optionally override the default parameters (in params.pp) by using the 'class' syntax, e.g.

class { 'profanity':
  install_from_package => true,
  package_ensure       => '0.4.7-1',
  manage_accounts      => true,
  manage_profrc        => true,
}

If $manage_accounts is true, a hash of accounts can be passed in using the 'accounts' attribute:

$accounts = {
  'me' => {
    'jid'    => 'me@chatty',
    'server' => 'talk.chat.com',
    'port'   => '5111',
    'muc'    => 'chatservice.mycompany.com',
    'nick'   => 'dennis',
    'status' => 'dnd',
    'dnd'    => '-1',
  },
}

class { 'profanity':
  accounts => $accounts,
}

You can also use the 'profanity::account' defined type directly in your Puppet code:

profanity::account { 'me_work':
  jid      => 'me@mycompany',
  presence => 'Profanity-work',
  nick     => 'Employee #4354',
}

All parameters are optional.

The profrc file can also be managed by setting $manage_profrc to true and uncommenting the required settings in params.pp.

Reference

An individual reference is contained within each class.

Limitations

The module has currently only been tested on the following OS:

Ubuntu 14.04 and higher Debian 7 and higher CentOS 7 and higher

Puppet 4.0 or higher required.

Development

Pull requests welcome. Adding Mac and Cygwin support is a high priority, as well as adding support for other Linux distributions.