Forge Home

catfacts

Send cat facts to your friends!

8,211 downloads

7,723 latest version

4.5 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.2 (latest)
  • 0.1.1
  • 0.1.0
released Dec 17th 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 'bbriggs-catfacts', '0.1.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add bbriggs-catfacts
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install bbriggs-catfacts --version 0.1.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

bbriggs/catfacts — version 0.1.2 Dec 17th 2015

CAT FACTS!

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 catfacts
  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

Send cat facts to your friends!

Module Description

Have you ever wanted to send cat facts to your friends? Of course, because you love them so much. Who doesn't? Share your enthusiasm for Linux, Puppet, and cats all at once by sending your friend cat facts with this module.

Setup

What catfacts affects

Catfacts installs fortune and expects sendmail to be present, but doesn't manage it. Catfacts installs a cron job in the specified user's crontab. Catfacts installs two small files full of cat fact-y goodness to /etc/catfacts.

Beginning with catfacts

include catfacts to have it install fortune and the two small files needed to pull cat facts. Declare a resource using the catfacts::schedule resource to start sending your friends cat facts throughout the day!

Usage

Example:

    include catfacts

    catfacts::schedule{'catfacts_for_dad':
        target  => '5558675309@txt.att.net',
        sender  => 'facts@catfacts.com',
        user    => 'not_root',
        minute  => '*/5',
        hour    => '*'
    }

Parameters

The main class has no parameters. The module is designed to be used via the type catfacts::schedule.
[target] String. Required. Email address of person with whom you just cannot wait to share the joy of CAT FACTS!

[sender] String. Required. Email address you want displayed as the sender, so everyone knows exactly who sent them the cat facts, right?

[user] String. Defaults to "root". Do you really want this running as root? Probably not. I don't know what users are running on your box, though, so I had to default to something

[minute] and [hour] String. Defaults to "0" and "*" respectively. These are inputs to the cron job. I did not provide other cron options because people should receive cat facts at least daily.

Reference

See above

Limitations

This module has been ever so slightly tested on Ubuntu 14.04 and CentOS/RHEL 6.x

Development

Pull requests to the development branch are welcome. Find this code on Github: https://github.com/bbriggs/puppet-catfacts