Merge remote-tracking branch 'github/pull/447'

[chef.git] / cookbooks / fail2ban / README.md

diff --git a/cookbooks/fail2ban/README.md b/cookbooks/fail2ban/README.md
index 6b087690a394145903ef5b3113258c1e1f4ecb73..eebfb25e702cd0df453a6e8cb07aeea080d450f3 100644 (file)
--- a/cookbooks/fail2ban/README.md
+++ b/cookbooks/fail2ban/README.md
@@ -1,57 +1,8 @@
-DESCRIPTION
-===========
+# fail2ban Cookbook
 
-Configures networking.
+This cookbook installs and configures the fail2ban intrusion prevention software.
 
-USAGE
-=====
+It also provides two resources that can be used by other cookbooks:
 
-Set the networking attributes in a role, for example from my base.rb:
-
-    :networking => {
-      :nameservers => [ "10.13.37.120", "10.13.37.40" ],
-      :search => [ "int.example.org". "example.org" ]
-    }
-
-The resulting /etc/resolv.conf will look like:
-
-    search int.example.org example.org
-    nameserver 10.13.37.120
-    nameserver 10.13.37.40
-
-LICENSE AND AUTHOR
-==================
-
-Author:: OpenStreetMap Administrators (<admins@openstreetmap.org>)
-
-Copyright 2010, OpenStreetMap Foundation.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-
-Based on resolver cookbook:
-
-Author:: Joshua Timberman (<joshua@opscode.com>)
-
-Copyright 2009, Opscode, Inc.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+* fail2ban_filter
+* fail2ban_jail