Skip to content
This repository has been archived by the owner on Nov 27, 2021. It is now read-only.

Commit

Permalink
Fix several Markdown issues
Browse files Browse the repository at this point in the history
  • Loading branch information
dhoppe committed Nov 4, 2016
1 parent 1b57efa commit 41dd0a4
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 36 deletions.
40 changes: 30 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
## 2016-02-07 Release 1.1.1
### Summary:

### Summary

- [Travis CI] Fix matrix of tested Puppet and RVM versions (travis-ci/travis-ci #5580)

## 2016-02-05 Release 1.1.0
### Summary:

### Summary

- [Puppet] Add support for Puppet Enterprise
- [Puppet] Switch to scope syntax of Puppet 3
- [Puppet Forge] Add statistics for downloads, modules and releases
Expand All @@ -20,42 +24,58 @@
- [Beaker] Update box/box_url because of new point release

## 2015-08-13 Release 1.0.7
### Summary:

### Summary

- [Beaker] Update Beaker environment
- [RSpec] Update RSpec environment
- [Travis CI] Update Travis CI environment
- [Puppet Forge] Update license, version requirement

## 2015-02-25 Release 1.0.6
### Summary:

### Summary

- [Beaker] Update Beaker environment
- [Travis CI] Update Travis CI environment

## 2015-02-25 Release 1.0.5
### Summary:

### Summary

- [Beaker] Update Beaker environment
- [Puppet] Update list of not supported releases

## 2014-12-06 Release 1.0.4
### Summary:

### Summary

- [Puppet] Update documentation
- [Rspec] Made some changes to the build environment

## 2014-11-09 Release 1.0.3
### Summary:

### Summary

- [Puppet] Switch to top-scope variables

## 2014-11-09 Release 1.0.2
### Summary:

### Summary

- [Puppet] Amending attributes

## 2014-11-08 Release 1.0.1
### Summary:

### Summary

- [Beaker] Update nodesets
- [Beaker] Change exit codes
- [Hiera] Remove double quotes
- [Puppet] Amending attributes

## 2014-11-06 Release 1.0.0
### Summary:

### Summary

- Generated from [https://github.com/dhoppe/puppet-skeleton-standard](https://github.com/dhoppe/puppet-skeleton-standard)
71 changes: 45 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,24 @@
#### 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 denyhosts](#setup)
1. [Module Description - What the module does and why it is useful](#module-description)
1. [Setup - The basics of getting started with denyhosts](#setup)
* [What denyhosts affects](#what-denyhosts-affects)
* [Setup requirements](#setup-requirements)
* [Beginning with denyhosts](#beginning-with-denyhosts)
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)
1. [Usage - Configuration options and additional functionality](#usage)
1. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
1. [Limitations - OS compatibility, etc.](#limitations)
1. [Development - Guide for contributing to the module](#development)

## Overview

This module installs, configures and manages the Denyhosts service.

## Module Description

This module handles installing, configuring and running Denyhosts across a range of operating systems and distributions.
This module handles installing, configuring and running Denyhosts across a range
of operating systems and distributions.

## Setup

Expand All @@ -43,7 +44,8 @@ This module handles installing, configuring and running Denyhosts across a range

### Beginning with denyhosts

Install denyhosts with the default parameters ***(No configuration files will be changed)***.
Install denyhosts with the default parameters ***(No configuration files will be
changed)***.

```puppet
class { 'denyhosts': }
Expand Down Expand Up @@ -98,7 +100,8 @@ Deploy the configuration files from source directory.
}
```

Deploy the configuration files from source directory ***(Unmanaged configuration files will be removed)***.
Deploy the configuration files from source directory ***(Unmanaged configuration
files will be removed)***.

```puppet
class { 'denyhosts':
Expand Down Expand Up @@ -131,7 +134,8 @@ Deploy the configuration file from template.
}
```

Deploy the configuration file from custom template ***(Additional parameters can be defined)***.
Deploy the configuration file from custom template ***(Additional parameters can
be defined)***.

```puppet
class { 'denyhosts':
Expand Down Expand Up @@ -186,10 +190,11 @@ Disable the denyhosts service.
* denyhosts::service: Handles the service.

### Parameters
i

#### `package_ensure`

Determines if the package should be installed. Valid values are 'present', 'latest', 'absent' and 'purged'. Defaults to 'present'.
Determines if the package should be installed. Valid values are 'present',
'latest', 'absent' and 'purged'. Defaults to 'present'.

#### `package_name`

Expand All @@ -201,27 +206,31 @@ Determines if additional packages should be managed. Defaults to 'undef'.

#### `config_dir_ensure`

Determines if the configuration directory should be present. Valid values are 'absent' and 'directory'. Defaults to 'directory'.
Determines if the configuration directory should be present. Valid values are
'absent' and 'directory'. Defaults to 'directory'.

#### `config_dir_path`

Determines if the configuration directory should be managed. Defaults to '/etc'

#### `config_dir_purge`

Determines if unmanaged configuration files should be removed. Valid values are 'true' and 'false'. Defaults to 'false'.
Determines if unmanaged configuration files should be removed. Valid values are
'true' and 'false'. Defaults to 'false'.

#### `config_dir_recurse`

Determines if the configuration directory should be recursively managed. Valid values are 'true' and 'false'. Defaults to 'true'.
Determines if the configuration directory should be recursively managed. Valid
values are 'true' and 'false'. Defaults to 'true'.

#### `config_dir_source`

Determines the source of a configuration directory. Defaults to 'undef'.

#### `config_file_ensure`

Determines if the configuration file should be present. Valid values are 'absent' and 'present'. Defaults to 'present'.
Determines if the configuration file should be present. Valid values are 'absent'
and 'present'. Defaults to 'present'.

#### `config_file_path`

Expand Down Expand Up @@ -253,51 +262,59 @@ Determines the content of a configuration file. Defaults to 'undef'.

#### `config_file_notify`

Determines if the service should be restarted after configuration changes. Defaults to 'Service[denyhosts]'.
Determines if the service should be restarted after configuration changes.
Defaults to 'Service[denyhosts]'.

#### `config_file_require`

Determines which package a configuration file depends on. Defaults to 'Package[denyhosts]'.

#### `config_file_hash`

Determines which configuration files should be managed via `denyhosts::define`. Defaults to '{}'.
Determines which configuration files should be managed via `denyhosts::define`.
Defaults to '{}'.

#### `config_file_options_hash`

Determines which parameters should be passed to an ERB template. Defaults to '{}'.

#### `service_ensure`

Determines if the service should be running or not. Valid values are 'running' and 'stopped'. Defaults to 'running'.
Determines if the service should be running or not. Valid values are 'running'
and 'stopped'. Defaults to 'running'.

#### `service_name`

Determines the name of service to manage. Defaults to 'denyhosts'.

#### `service_enable`

Determines if the service should be enabled at boot. Valid values are 'true' and 'false'. Defaults to 'true'.
Determines if the service should be enabled at boot. Valid values are 'true' and
'false'. Defaults to 'true'.

#### `email`

Determines which email address (recipient) should be notified about restricted hosts and suspicious logins. Defaults to "denyhosts@${::domain}".
Determines which email address (recipient) should be notified about restricted
hosts and suspicious logins. Defaults to "denyhosts@${::domain}".

#### `email_from`

Determines which email address (sender) should be used. Defaults to "root@${::fqdn}".

#### `email_subject`

Determines which email subject should be used. Defaults to "[denyhosts] Report from ${::fqdn}".
Determines which email subject should be used. Defaults to "[denyhosts] Report
from ${::fqdn}".

#### `deny_threshold_invalid`

Determines the number of failed login attempts (invalid user) needed to block a host. Defaults to '3'.
Determines the number of failed login attempts (invalid user) needed to block a
host. Defaults to '3'.

#### `deny_threshold_valid`

Determines the number of failed login attempts (valid user) needed to block a host. Defaults to '3'.
Determines the number of failed login attempts (valid user) needed to block a
host. Defaults to '3'.

#### `purge_deny`

Expand All @@ -318,11 +335,13 @@ This module has been tested on:

### Bug Report

If you find a bug, have trouble following the documentation or have a question about this module - please create an issue.
If you find a bug, have trouble following the documentation or have a question
about this module - please create an issue.

### Pull Request

If you are able to patch the bug or add the feature yourself - please make a pull request.
If you are able to patch the bug or add the feature yourself - please make a
pull request.

### Contributors

Expand Down

0 comments on commit 41dd0a4

Please sign in to comment.