* Edit the README.md.
This commit is contained in:
parent
91d87a60b1
commit
cb6ed4f1dc
|
|
@ -17,6 +17,7 @@
|
|||
* Add a template to manage the static motd (/etc/motd).
|
||||
* Rename the ::config class into ::install, because it's provide and install everything to have dynamic Motd.
|
||||
* Add the display of the Motd upon successful shadow or ssh login.
|
||||
* Edit the README.md.
|
||||
|
||||
|
||||
---------------------------------------
|
||||
|
|
|
|||
120
README.md
120
README.md
|
|
@ -3,77 +3,95 @@
|
|||
#### Table of Contents
|
||||
|
||||
1. [Overview](#overview)
|
||||
2. [Module Description - What the module does and why it is useful](#module-description)
|
||||
3. [Setup - The basics of getting started with dynmotd](#setup)
|
||||
* [What dynmotd affects](#what-dynmotd-affects)
|
||||
* [Setup requirements](#setup-requirements)
|
||||
* [Beginning with dynmotd](#beginning-with-dynmotd)
|
||||
4. [Usage - Configuration options and additional functionality](#usage)
|
||||
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
|
||||
5. [Limitations - OS compatibility, etc.](#limitations)
|
||||
6. [Development - Guide for contributing to the module](#development)
|
||||
2. [Module Description](#module-description)
|
||||
3. [Setup](#setup)
|
||||
* [What Proxmox affects](#what-proxmox-affects)
|
||||
4. [Usage](#usage)
|
||||
* [Hypervisor](#hypervisor)
|
||||
* [VM](#vm)
|
||||
5. [Reference](#reference)
|
||||
* [Classes](#classes)
|
||||
* [Defined types](#defined-types)
|
||||
* [Parameters](#parameters)
|
||||
6. [Other notes](#other-notes)
|
||||
7. [Limitations](#limitations)
|
||||
8. [Development](#development)
|
||||
9. [License](#license)
|
||||
|
||||
## Overview
|
||||
|
||||
A one-maybe-two sentence summary of what the module does/what problem it solves.
|
||||
This is your 30 second elevator pitch for your module. Consider including
|
||||
OS/Puppet version it works with.
|
||||
This module allows to generate a dynamic Motd `/var/run/motd` with simples
|
||||
scripts.
|
||||
|
||||
## Module Description
|
||||
|
||||
If applicable, this section should have a brief description of the technology
|
||||
the module integrates with and what that integration enables. This section
|
||||
should answer the questions: "What does this module *do*?" and "Why would I use
|
||||
it?"
|
||||
|
||||
If your module has a range of functionality (installation, configuration,
|
||||
management, etc.) this is the time to mention it.
|
||||
This is a simple Puppet module to manage a more advanced Motd (Message of the
|
||||
day) and automatically display it upon successful ssh or shadow login.
|
||||
|
||||
## Setup
|
||||
|
||||
### What dynmotd affects
|
||||
|
||||
* A list of files, packages, services, or operations that the module will alter,
|
||||
impact, or execute on the system it's installed on.
|
||||
* This is a great place to stick any warnings.
|
||||
* Can be in list or paragraph form.
|
||||
|
||||
### Setup Requirements **OPTIONAL**
|
||||
|
||||
If your module requires anything extra before setting up (pluginsync enabled,
|
||||
etc.), mention it here.
|
||||
|
||||
### Beginning with dynmotd
|
||||
|
||||
The very basic steps needed for a user to get the module up and running.
|
||||
|
||||
If your most recent release breaks compatibility or requires particular steps
|
||||
for upgrading, you may wish to include an additional section here: Upgrading
|
||||
(For an example, see http://forge.puppetlabs.com/puppetlabs/firewall).
|
||||
* Dynamic (/var/run/motd) and static (/etc/motd) Motd files.
|
||||
* The dynamic Motd generation directory and scripts (/etc/update-motd.d).
|
||||
* The pam configuration to display the Motd for ssh and shadow login.
|
||||
|
||||
## Usage
|
||||
|
||||
Put the classes, types, and resources for customizing, configuring, and doing
|
||||
the fancy stuff with your module here.
|
||||
To begin using Motd module with defaults parameters:
|
||||
|
||||
include dynmotd
|
||||
|
||||
If you don't want to display the Motd upon ssh login:
|
||||
|
||||
class { 'motd':
|
||||
print_motd_ssh => false,
|
||||
}
|
||||
|
||||
## Reference
|
||||
|
||||
Here, list the classes, types, providers, facts, etc contained in your module.
|
||||
This section should include all of the under-the-hood workings of your module so
|
||||
people know what the module is touching on their system but don't need to mess
|
||||
with things. (We are working on automating this section!)
|
||||
### Classes
|
||||
|
||||
## Limitations
|
||||
* `motd`: Main class calls all subclasses.
|
||||
|
||||
This is where you list OS compatibility, version compatibility, etc.
|
||||
* `motd::install`: Provide all scripts that display system informations.
|
||||
|
||||
## Development
|
||||
* `motd::config`: Manage the pam configuration.
|
||||
|
||||
Since your module is awesome, other users will want to play with it. Let them
|
||||
know what the ground rules for contributing are.
|
||||
### Parameters
|
||||
|
||||
## Release Notes/Contributors/Etc **Optional**
|
||||
#### motd
|
||||
|
||||
* `dynmotd_path`: Path to the default dynamic Motd generated by pam. Defaults to '/var/run/motd'.
|
||||
* `update_motd_dir_path`: Path to the directory containing the scripts to generate the dynamic Motd. Defaults to '/etc/update-motd.d'.
|
||||
* `system_info_script_name`: The script to display system informations (uptime, kernel, …). Defaults to '01system'.
|
||||
* `system_info_script_content`: Template file use to generate the previous script. Defaults to 'dynmotd/motd_system_info.erb'.
|
||||
* `user_info_script_name`: The script to display user informations (number of sessions, processes, …). Defaults to '02user'.
|
||||
* `user_info_script_content`: Template file use to generate the previous script. Defaults to 'dynmotd/motd_user_info.erb'.
|
||||
* `auth_info_script_name`: The script to display authentication informations (number of ssh, sudo fails, …). Defaults to '03auth'.
|
||||
* `auth_info_script_content`: Template file use to generate the previous script. Defaults to 'dynmotd/motd_auth_info.erb'.
|
||||
* `fs_info_script_name`: The script to display filesystem informations (disk space usage). Defaults to '04fs'.
|
||||
* `fs_info_script_content`: Template file use to generate the previous script. Defaults to 'dynmotd/motd_fs_info.erb'.
|
||||
* `service_info_script_name`: The script to display services informations (running process, listening socket, …). Defaults to '06service'.
|
||||
* `service_info_script_content`: Template file use to generate the previous script. Defaults to 'dynmotd/motd_service_info.erb'.
|
||||
* `static_motd_path`: Path to the standard and static Motd. Defaults to '/etc/motd'.
|
||||
* `static_motd_content`: Template file use to generate the static motd. Defaults to 'dynmotd/static_motd.erb'.
|
||||
* `print_motd_ssh`: If set to 'true', the Motd will be displayed upon successful ssh login. Can be 'true' or 'false'. Defaults to 'true'.
|
||||
* `print_motd_login`: If set to 'true', the Motd will be displayed upon successful shadow (classic tty/shell) login. Can be 'true' or 'false'. Defaults to 'true'.
|
||||
|
||||
Limitations
|
||||
-----------
|
||||
|
||||
This module has only be tested on Debian 7.x versions, but should work on Debian >7.
|
||||
The dynamic Motd generation with `/etc/update-motd.d` directory was implemented in pam by Ubuntu (in 10.04), so it should also work with Ubuntu >=10.04.
|
||||
|
||||
Development
|
||||
-----------
|
||||
|
||||
Free to send contributions, fork it, ...
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
WTFPL (http://wtfpl.org/)
|
||||
|
||||
If you aren't using changelog, put your release notes here (though you should
|
||||
consider using changelog). You may also add any additional sections you feel are
|
||||
necessary or important to include here. Please use the `## ` header.
|
||||
|
|
|
|||
Loading…
Reference in New Issue