Skip to content

Commit ddb967b

Browse files
committed
update README.md
Signed-off-by: Patrick Münch <[email protected]>
1 parent 8093e62 commit ddb967b

File tree

1 file changed

+25
-15
lines changed

1 file changed

+25
-15
lines changed

README.md

+25-15
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# apache-hardening (Chef cookbook)
22

33
[![Supermarket](http://img.shields.io/cookbook/v/apache-hardening.svg)][1]
4-
[![Build Status](http://img.shields.io/travis/hardening-io/chef-apache-hardening.svg)][2]
5-
[![Code Coverage](http://img.shields.io/coveralls/hardening-io/chef-apache-hardening.svg)][3]
6-
[![Dependencies](http://img.shields.io/gemnasium/hardening-io/chef-apache-hardening.svg)][4]
4+
[![Build Status](http://img.shields.io/travis/dev-sec/chef-apache-hardening.svg)][2]
5+
[![Code Coverage](http://img.shields.io/coveralls/dev-sec/chef-apache-hardening.svg)][3]
6+
[![Dependencies](http://img.shields.io/gemnasium/dev-sec/chef-apache-hardening.svg)][4]
77
[![Gitter Chat](https://badges.gitter.im/Join%20Chat.svg)][5]
88

99
## Description
@@ -14,6 +14,13 @@ This cookbook provides a secure overlay for apache configuration.
1414

1515
* chef
1616

17+
### Platform
18+
19+
- Debian 7, 8
20+
- Ubuntu 14.04, 16.04
21+
- CentOS 6.8, 7.2
22+
- OracleLinux 6.8, 7.2
23+
1724
## Usage
1825

1926
A sample role may look like:
@@ -52,12 +59,12 @@ This hardening recipe installs the hardening but expects an existing installatio
5259
## Security Options
5360

5461
* `node['apache']['traceenable'] = 'Off'`
55-
This directive overrides the behavior of TRACE for both the core server and mod_proxy.
62+
This directive overrides the behavior of TRACE for both the core server and mod_proxy.
5663
See [http://httpd.apache.org/docs/2.2/mod/core.html#traceenable](http://httpd.apache.org/docs/2.2/mod/core.html#traceenable) for details
5764
Defaults to: `Off`
5865

5966
* `node['apache_hardening']['allowed_http_methods'] = %w( GET POST )`
60-
A list of HTTP methods that should be allowed in the server.
67+
A list of HTTP methods that should be allowed in the server.
6168
See [http://httpd.apache.org/docs/trunk/mod/mod_allowmethods.html](http://httpd.apache.org/docs/trunk/mod/mod_allowmethods.html) for details
6269
Defaults to: `GET POST`
6370

@@ -68,6 +75,8 @@ This hardening recipe installs the hardening but expects an existing installatio
6875

6976
## Tests
7077

78+
For local testing you can use vagrant or docker to run tests locally. You will have to install Virtualbox and Vagrant or docker on your system. See [Vagrant Downloads](http://downloads.vagrantup.com/) for a vagrant or [Docker Downloads](https://docs.docker.com/mac/) package suitable for your system. For all our tests we use `test-kitchen`. If you are not familiar with `test-kitchen` please have a look at [their guide](http://kitchen.ci/docs/getting-started).
79+
7180
```
7281
# Install dependencies
7382
gem install bundler
@@ -76,22 +85,23 @@ bundle install
7685
# Do lint checks
7786
bundle exec rake lint
7887
79-
# Fetch tests
80-
bundle exec thor kitchen:fetch-remote-tests
81-
8288
# fast test on one machine
83-
bundle exec kitchen test default-ubuntu-1204
89+
bundle exec kitchen test default-ubuntu-1404
8490
8591
# test on all machines
8692
bundle exec kitchen test
8793
8894
# for development
89-
bundle exec kitchen create default-ubuntu-1204
90-
bundle exec kitchen converge default-ubuntu-1204
95+
bundle exec kitchen create default-ubuntu-1404
96+
bundle exec kitchen converge default-ubuntu-1404
97+
bundle exec kitchen verify default-ubuntu-1204
9198
```
9299

93100
## Contributors + Kudos
94101

102+
* Dominik Richter [arlimus](https://github.com/arlimus)
103+
* Christoph Hartmann [chris-rock](https://github.com/chris-rock)
104+
* Patrick Muench [atomic111](https://github.com/atomic111)
95105
* Edmund Haselwanter [ehaselwanter](https://github.com/ehaselwanter)
96106

97107
## Contributing
@@ -115,7 +125,7 @@ See the License for the specific language governing permissions and
115125
limitations under the License.
116126

117127
[1]: https://supermarket.getchef.com/cookbooks/apache-hardening
118-
[2]: http://travis-ci.org/hardening-io/chef-apache-hardening
119-
[3]: https://coveralls.io/r/hardening-io/chef-apache-hardening
120-
[4]: https://gemnasium.com/hardening-io/chef-apache-hardening
121-
[5]: https://gitter.im/hardening-io/general
128+
[2]: http://travis-ci.org/dev-sec/chef-apache-hardening
129+
[3]: https://coveralls.io/r/dev-sec/chef-apache-hardening
130+
[4]: https://gemnasium.com/dev-sec/chef-apache-hardening
131+
[5]: https://gitter.im/dev-sec/general

0 commit comments

Comments
 (0)