gregohardy / puppetlabs-motd

Simple motd module

#motd

####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 the motd module
   • Beginning with the motd module
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

This module populates /etc/motd on POSIX systems, and a registry key in Windows Systems with the contents of a simple template file.

##Module Description

The MOTD module demonstrates how to utilize templates within a module class and provides a means with which to experiment with the puppet module tool.

##Setup

###Beginning with the motd module To configure motd on your system, include the motd class: include motd.

##Usage

The motd module configures the message of the day on a wide variety of systems. By default, the module will populate motd using the included template, however you can specify a different template or a static string. For example, to use a custom template you would set the template parameter:

class { 'motd':
  template => 'mymodule/mytemplate.erb',
}

##Reference

###Classes

####Public classes

• motd: Configures the message of the day.

####Parameters The following parameters are available in motd:

template

Specifies a custom template. A template take precedence over content. Valid options: '/mymodule/mytemplate.erb'. Default: 'undef'.

content

Specifies a static string as the motd content. Valid options: "Hello!\n", or "Please lock workstations when not in use\n". Default: 'undef'.

dynamic_motd

Enables or disables dynamic motd on Debian systems. Valid options: 'true', or 'false'. Default: 'true'.

##Limitations

This module is supported for the following platforms:

• Red Hat Enterprise Linux (RHEL) 5, 6, 7
• Ubuntu 12.04, 12.10, 14.04
• Windows 2008, 2008 R2, 2012, 2012 R2

Disabling dynamic motd is supported on:

• Debian

A note on Windows

On Windows systems the contents of HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\policies\system\legalnoticetext and HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\policies\system\legalnoticecaption will be populated by motd. The legalnoticetext registry key is shown before login on a Windows system.

##Development

Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our module contribution guide.

##Contributors

The list of contributors can be found at: https://github.com/puppetlabs/puppetlabs-motd/graphs/contributors.