puppetlabs / 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. License
8. Development - Guide for contributing to the module

Module Description

The motd module configures a system message of the day. The module includes a default message template. Alternatively, you can specify a different template or a static string.

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. The module populates either /etc/motd, /etc/issue and /etc/issue.net (on POSIX systems) or a registry key (on Windows systems) with the contents of a basic template file.

By default, the module populates motd using the included template. Alternatively, 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.epp',
}

To specify a string as the message of the day:

class { 'motd':
  content => "Hello world!\n",
}

Reference

See REFERENCE.md

Limitations

For an extensive list of supported operating systems, see metadata.json

Disabling dynamic motd is supported only on Debian.

A note on Windows

On Windows systems, the motd module populates the contents of HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\policies\system\legalnoticetext and HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\policies\system\legalnoticecaption. The legalnoticetext registry key is shown before login on a Windows system.

License

This codebase is licensed under the Apache2.0 licensing, however due to the nature of the codebase the open source dependencies may also use a combination of AGPL, BSD-2, BSD-3, GPL2.0, LGPL, MIT and MPL Licensing.

Development

We are experimenting with a new tool for running acceptance tests. It's name is puppet_litmus this replaces beaker as the test runner. To run the acceptance tests follow the instructions here.

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.

puppetlabs-motd's Issues

README.md example is wrong

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

Clearly "template" should be "content".

DISABLE ON WINDOWS CLIENTS

Is there an option to disable motd on windows clients?

Broken spec tests impacting PDK release testing

Describe the Bug

A PR was merged that had failing spec tests. This caused down stream integration testing of PDK to fail slowing down the release process.

The following PR uses the hash map syntax for facts which the tests did not cater for:

#431

Expected Behavior

The tests should pass & ideally PRs with broken spec tests should not be merged.

Steps to Reproduce

Run spec tests

Environment

N/A

Additional Context

Add any other context about the problem here.