Forge Home


Report processor that notifies an IRC channel about failed Puppet runs


105,046 latest version

3.8 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.0.7 (latest)
  • 0.0.6
  • 0.0.5 (deleted)
  • 0.0.4 (deleted)
  • 0.0.3 (deleted)
  • 0.0.2 (deleted)
  • 0.0.1 (deleted)
released Mar 12th 2014

Start using this module

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

Add this module to your Puppetfile:

mod 'jamtur01-irc', '0.0.7'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add jamtur01-irc
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install jamtur01-irc --version 0.0.7

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.

Tags: report, irc


jamtur01/irc — version 0.0.7 Mar 12th 2014



A Puppet report handler for sending notifications of failed runs to IRC.


  • carrier-pigeon
  • puppet (version 2.6.5 and later)

Installation & Usage (with ircreporter class)

On your report server (usually your Puppet Master), define the ircreporter class in a manifest or your ENC with the appropriate parameters:

 class { 'ircreporter':
   irc_server  => 'irc://',
   report_url  => '',

Run puppet once on the master/report server to sync the plugin and setup requirements and the config file. Then, add "irc" to the comma-separated "reports" list in puppet.conf on your master (or via a puppet module that configures puppet, such as jbouse/puppetlabs-puppet).

Installation & Usage (manual setup)

  1. Install the carrier-pigeon gem on your Puppet master

    $ sudo gem install carrier-pigeon
  2. Install puppet-irc as a module in your Puppet master's module path.

  3. Copy irc.yaml to /etc/puppet and modify configuration settings to your fit your needs. NOTE: Remove any configurations items you're not setting. Available options are decribed below:

    • irc_server: URI containing the channel connection details. Example: irc://
    • irc_ssl: set to true if you wish to enable an SSL connection to your IRC server.
    • irc_password: Specify the channel password here if needed.
    • irc_register_first : set to true if you are getting register_first error.
    • irc_join: set to false if you wish to disable parts/joins/quits messages.
    • github_user: user account. If specified, the report processor will create a Gist containing the log output from the run and link it in the IRC notification.
    • github_password: above github user's password.
    • parsed_reports_dir: path to a directory on the reportserver. If specified, a human-readable version of the report will be saved in this directory, and it's path will be mentioned in the IRC notification. Don't forget to create the directory on your reportserver, writeable to the user running the puppet-master, and setup a job to clean old reports.
    • report_url: an URL, which if specified, will be appended to the IRC notification. Some special characters will be expanded to values found in the report. Example: Currently supported characters include:
      • %c: configuration version string
      • %e: puppet's run environment
      • %h: host name from the report
      • %k: kind of report
      • %s: report status
      • %t: report timestamp
      • %v: puppet version
  4. Enable pluginsync and reports on your master and clients in puppet.conf

    report = true
    reports = irc
    pluginsync = true
    report = true
    pluginsync = true
  5. Run the Puppet client and sync the report as a plugin


James Turnbull Jason Antman (init.pp)


Author:: James Turnbull (<>)
Copyright:: Copyright (c) 2011 James Turnbull
License:: Apache License, Version 2.0

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.