https://github.com/jonmosco/puppet-logwatch
Puppet module for logwatch
https://github.com/jonmosco/puppet-logwatch
Last synced: 10 months ago
JSON representation
Puppet module for logwatch
- Host: GitHub
- URL: https://github.com/jonmosco/puppet-logwatch
- Owner: jonmosco
- License: apache-2.0
- Created: 2014-11-24T21:21:52.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2021-12-24T15:08:39.000Z (over 4 years ago)
- Last Synced: 2025-09-10T14:59:36.992Z (11 months ago)
- Language: Ruby
- Size: 40 KB
- Stars: 0
- Watchers: 2
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# logwatch
[](https://travis-ci.org/jonmosco/puppet-logwatch)
#### 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 logwatch](#setup)
¦ * [What logwatch affects](#what-logwatch-affects)
¦ * [Setup requirements](#setup-requirements)
4. [Usage - Configuration options and additional functionality](#usage)
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
6. [Limitations - OS compatibility, etc.](#limitations)
7. [Development - Guide for contributing to the module](#development)
* [Contributing](#contributing)
## Overview
The logwatch module configures logwatch on Linux bases systems.
## Module Description
The logwatch module will manage the installation and configuration of logwatch
on Linux based systems.
## Setup
**NOTE: You must have a proper MTA installed and configured to send mail externally.**
### Stdlib
This module requires puppetlabs-stdlib >= 3.2.0
### What logwatch affects
* logwatch package.
* logwatch configuration files.
## Usage
#### Using default values
```puppet
class { '::logwatch': }
```
#### Using available parameters
```puppet
class { '::logwatch':
mail_to => [ 'test@test.com ', 'more@test.com' ],
mail_from => 'puppet@test.com',
service => [ 'sshd', 'httpd' ],
}
```
#### Managing `ignore.conf`
Add a regex to `ignore.conf` to suppress that output from the logwatch report
```puppet
logwatch::ignore { 'my_rule':
regex => 'ignore_lines_that_match_this_regex',
}
```
## Reference
### Classes
#### Public Classes
* logwatch: Main class, includes all other classes.
* logwatch::ignore: Manage the contents of `ignore.conf`
#### Private Classes
* logwatch::install: Handles the packages.
* logwatch::config: Handles the configuration file.
#### Parameters
##### `logwatch`
```
output
format
mail_to
mail_from
range
detail
service
package_ensure
package_name
```
##### `logwatch::ignore`
```
regex
```
## Limitations
This module has been built on and tested against Puppet 3.
The module has been tested on:
* RedHat Enterprise Linux 6/7
* CentOS 6/7
* Ubuntu 12.04/14.04
## Development
### Contributing