Skip to content

Commit 7ad10c0

Browse files
committed
Format the readme metadata
Signed-off-by: Tim Smith <tsmith@chef.io>
1 parent dc85939 commit 7ad10c0

File tree

1 file changed

+36
-34
lines changed

1 file changed

+36
-34
lines changed

README.md

Lines changed: 36 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,60 @@
11
# nginx-hardening (Chef cookbook)
22

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

95
## Description
106

117
This cookbook provides a secure overlay for nginx configuration.
128

139
## Requirements
1410

15-
* Opscode chef
11+
- Chef 12+
1612

1713
### Platform
1814

1915
- Debian 7, 8
2016
- Ubuntu 12.04, 14.04, 16.04
21-
- CentOS 6.6, 6.7, 7
17+
- CentOS 6, 7
2218
- OracleLinux 6.6, 6.7, 7.1
2319

2420
## Attributes
2521

26-
* `['nginx']['client_body_buffer_size']` - `1k` Sets buffer size for reading client request body. In case the request body is larger than the buffer, the whole body or only its part is written to a temporary file.
27-
* `['nginx']['default_site_enabled']` - `false` to disable the default site. Set to `on` to enable the default site in nginx.
28-
* `['nginx']['client_max_body_size']` - `1k` to set the maximum allowed size of the client request body, specified in the “Content-Length” request header field. If the size in a request exceeds the configured value, the 413 (Request Entity Too Large) error is returned to the client.
29-
* `['nginx']['keepalive_timeout']` - `5 5` The first parameter sets a timeout during which a keep-alive client connection will stay open on the server side. The zero value disables keep-alive client connections. The optional second parameter sets a value in the “Keep-Alive: timeout=time” response header field.
30-
* `['nginx']['server_tokens']` - `off` to disable disables emitting nginx version in error messages and in the "Server" response header field. Set to `on` to enable the nginx version in error messages and "Server" response header.
22+
- `['nginx']['client_body_buffer_size']` - `1k` Sets buffer size for reading client request body. In case the request body is larger than the buffer, the whole body or only its part is written to a temporary file.
23+
- `['nginx']['default_site_enabled']` - `false` to disable the default site. Set to `on` to enable the default site in nginx.
24+
- `['nginx']['client_max_body_size']` - `1k` to set the maximum allowed size of the client request body, specified in the "Content-Length" request header field. If the size in a request exceeds the configured value, the 413 (Request Entity Too Large) error is returned to the client.
25+
- `['nginx']['keepalive_timeout']` - `5 5` The first parameter sets a timeout during which a keep-alive client connection will stay open on the server side. The zero value disables keep-alive client connections. The optional second parameter sets a value in the "Keep-Alive: timeout=time" response header field.
26+
- `['nginx']['server_tokens']` - `off` to disable disables emitting nginx version in error messages and in the "Server" response header field. Set to `on` to enable the nginx version in error messages and "Server" response header.
27+
- `['nginx-hardening']['source']['http_autoindex_module']` - `false` to disable the HTTP Autoindex module. Set to `true` to enable http_autoindex_module.
28+
- `['nginx-hardening']['source']['http_ssi_module']` - `false` to disable the HTTP SSI module. Set to `true` to enable http_ssi_module.
29+
- `['nginx-hardening']['options']['ssl_protocols']` - `'TLSv1 TLSv1.1 TLSv1.2'` to specify the SSL protocol which should be used.
30+
- `['nginx-hardening']['options']['ssl_ciphers']` - `'ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:kEDH+AESGCM:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA256:DHE-RSA-AES256-SHA256:DHE-DSS-AES256-SHA:DHE-RSA-AES256-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:AES:CAMELLIA:DES-CBC3-SHA:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!PSK:!aECDH:!EDH-DSS-DES-CBC3-SHA:!EDH-RSA-DES-CBC3-SHA:!KRB5-DES-CBC3-SHA'` to specify the TLS ciphers which should be used.
31+
- `['nginx-hardening']['options']['ssl_prefer_server_ciphers']` - `'on'` Specifies that server ciphers should be preferred over client ciphers when using the TLS protocols. Set to `false` to disable it.
32+
- `['nginx-hardening']['dh-size']` - `2048` Specifies the length of DH parameters for EDH ciphers.
3133

32-
* `['nginx-hardening']['source']['http_autoindex_module']` - `false` to disable the HTTP Autoindex module. Set to `true` to enable http_autoindex_module.
33-
* `['nginx-hardening']['source']['http_ssi_module']` - `false` to disable the HTTP SSI module. Set to `true` to enable http_ssi_module.
34-
* `['nginx-hardening']['options']['ssl_protocols']` - `'TLSv1 TLSv1.1 TLSv1.2'` to specify the SSL protocol which should be used.
35-
* `['nginx-hardening']['options']['ssl_ciphers']` - `'ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:kEDH+AESGCM:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA256:DHE-RSA-AES256-SHA256:DHE-DSS-AES256-SHA:DHE-RSA-AES256-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:AES:CAMELLIA:DES-CBC3-SHA:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!PSK:!aECDH:!EDH-DSS-DES-CBC3-SHA:!EDH-RSA-DES-CBC3-SHA:!KRB5-DES-CBC3-SHA'` to specify the TLS ciphers which should be used.
36-
* `['nginx-hardening']['options']['ssl_prefer_server_ciphers']` - `'on'` Specifies that server ciphers should be preferred over client ciphers when using the TLS protocols. Set to `false` to disable it.
37-
* `['nginx-hardening']['dh-size']` - `2048` Specifies the length of DH parameters for EDH ciphers.
38-
39-
You can also use the complete attributes from the [nginx cookbook](https://supermarket.chef.io/cookbooks/nginx)
34+
You can also use the complete attributes from the [chef_nginx cookbook](https://supermarket.chef.io/cookbooks/chef_nginx)
4035

4136
## Usage
4237

4338
Add the recipes to the run_list:
4439

45-
"recipe[apt]"
46-
"recipe[nginx-hardening::upgrades]"
47-
"recipe[nginx]"
48-
"recipe[nginx-hardening]"
40+
```
41+
"recipe[apt]"
42+
"recipe[nginx-hardening::upgrades]"
43+
"recipe[chef_nginx]"
44+
"recipe[nginx-hardening]"
45+
```
4946

5047
Configure attributes:
5148

52-
"nginx-hardening" : {
53-
"dh-size" : "4096"
54-
}
49+
```
50+
"nginx-hardening" : {
51+
"dh-size" : "4096"
52+
}
53+
```
5554

5655
## Local Testing
5756

58-
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).
57+
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).
5958

6059
```bash
6160
# Install dependencies
@@ -79,20 +78,22 @@ bundle exec kitchen verify default-ubuntu-1204
7978

8079
## Contributors + Kudos
8180

82-
* Dominik Richter [arlimus](https://github.com/arlimus)
83-
* Christoph Hartmann [chris-rock](https://github.com/chris-rock)
84-
* Patrick Muench [atomic111](https://github.com/atomic111)
85-
* Edmund Haselwanter [ehaselwanter](https://github.com/ehaselwanter)
81+
- Dominik Richter [arlimus](https://github.com/arlimus)
82+
- Christoph Hartmann [chris-rock](https://github.com/chris-rock)
83+
- Patrick Muench [atomic111](https://github.com/atomic111)
84+
- Edmund Haselwanter [ehaselwanter](https://github.com/ehaselwanter)
8685

8786
## Contributing
8887

8988
See [contributor guideline](CONTRIBUTING.md).
9089

9190
## License and Author
9291

93-
* Author:: Dominik Richter <dominik.richter@googlemail.com>
94-
* Author:: Deutsche Telekom AG
92+
- Author:: Dominik Richter [dominik.richter@googlemail.com](mailto:dominik.richter@googlemail.com)
93+
- Author:: Deutsche Telekom AG
94+
9595

96+
```
9697
Licensed under the Apache License, Version 2.0 (the "License");
9798
you may not use this file except in compliance with the License.
9899
You may obtain a copy of the License at
@@ -104,6 +105,7 @@ distributed under the License is distributed on an "AS IS" BASIS,
104105
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
105106
See the License for the specific language governing permissions and
106107
limitations under the License.
108+
```
107109

108110
[1]: https://supermarket.getchef.com/cookbooks/nginx-hardening
109111
[2]: https://travis-ci.org/dev-sec/chef-nginx-hardening

0 commit comments

Comments
 (0)