94 lines
3.6 KiB
Markdown
94 lines
3.6 KiB
Markdown
# dynmotd
|
|
|
|
#### Table of Contents
|
|
|
|
1. [Overview](#overview)
|
|
2. [Module Description](#module-description)
|
|
3. [Setup](#setup)
|
|
* [What Motd affects](#what-motd-affects)
|
|
4. [Usage](#usage)
|
|
5. [Reference](#reference)
|
|
* [Classes](#classes)
|
|
* [Parameters](#parameters)
|
|
6. [Limitations](#limitations)
|
|
7. [Development](#development)
|
|
8. [License](#license)
|
|
|
|
## Overview
|
|
|
|
This module allows to generate a dynamic Motd `/var/run/motd` with simples
|
|
scripts.
|
|
|
|
## Module Description
|
|
|
|
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
|
|
|
|
* 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
|
|
|
|
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
|
|
|
|
### Classes
|
|
|
|
* `motd`: Main class calls all subclasses.
|
|
* `motd::install`: Provide all scripts that display system informations.
|
|
* `motd::config`: Manage the pam configuration.
|
|
|
|
### Parameters
|
|
|
|
#### 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/)
|
|
|