minor readme fixes

Signed-off-by: Sebastian Gumprich <github@gumpri.ch>
This commit is contained in:
Sebastian Gumprich 2020-11-09 20:45:14 +01:00
parent c94d973527
commit d857830979
6 changed files with 11 additions and 25 deletions

Binary file not shown.

View file

@ -7,7 +7,7 @@ namespace: devsec
name: hardening
# The version of the collection. Must be compatible with semantic versioning
version: 1.0.0
version: 0.9.0
# The path to the Markdown (.md) readme file. This path is relative to the root of the collection
readme: README.md
@ -18,21 +18,7 @@ authors:
- dev-sec <hello@dev-sec.io>
# A short summary description of the collection
description: >-
This collections provides battle tested hardening for:
* Linux operating systems:
* CentOS 7/8
* Ubuntu 16.04/18.04/20.04
* Debian 9/10
* Arch Linux (some roles supported)
* Suse Tumbleweed (some roles supported)
* Fedora (some roles supported)
* Amazon Linux (some roles supported)
* OpenSSH 5.3 and later
* Nginx 1.0.16 or later
* MySQL
* MySQL >= 5.7.31, >= 8.0.3
* MariaDB >= 5.5.65, >= 10.1.45, >= 10.3.17
description: This collections provides battle tested hardening for Linux, SSH, nginx, MySQL
# Either a single license or a list of licenses for content inside of a collection. Ansible Galaxy currently only
# accepts L(SPDX,https://spdx.org/licenses/) licenses. This key is mutually exclusive with 'license_file'
@ -46,7 +32,7 @@ license_file: ''
# A list of tags you want to associate with the collection for indexing/searching. A tag name has the same character
# requirements as 'namespace' and 'name'
tags:
- dev-sec
- devsec
- hardening
- centos
- ubuntu

View file

@ -24,7 +24,7 @@ It configures:
collections:
- devsec.hardening
roles:
- devsec.mysql_hardening
- devsec.hardening.mysql_hardening
```
This role expects an existing installation of MySQL or MariaDB. Please ensure that the following variables are set accordingly:

View file

@ -83,7 +83,7 @@ It works with the following nginx-roles, including, but not limited to:
collections:
- devsec.hardening
roles:
- devsec.nginx_hardening
- devsec.hardening.nginx_hardening
```
[nginx_client_body_buffer_size]: http://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_buffer_size

View file

@ -48,7 +48,7 @@ If you're using Docker / Kubernetes+Docker you'll need to override the ipv4 ip f
collections:
- devsec.hardening
roles:
- devsec.os_hardening
- devsec.hardening.os_hardening
vars:
sysctl_overwrite:
# Enable IPv4 traffic forwarding.
@ -64,7 +64,7 @@ We are setting this sysctl to a default of `32`, some systems only support small
collections:
- devsec.hardening
roles:
- devsec.os_hardening
- devsec.hardening.os_hardening
vars:
sysctl_overwrite:
vm.mmap_rnd_bits: 16
@ -204,7 +204,7 @@ To prevent some of the filesystems from being disabled, add them to the `os_file
collections:
- devsec.hardening
roles:
- devsec.os_hardening
- devsec.hardening.os_hardening
```
## Changing sysctl variables
@ -217,7 +217,7 @@ So for example if you want to change the IPv4 traffic forwarding variable to `1`
collections:
- devsec.hardening
roles:
- devsec.os_hardening
- devsec.hardening.os_hardening
vars:
sysctl_overwrite:
# Enable IPv4 traffic forwarding.

View file

@ -235,7 +235,7 @@ Warning: This role disables root-login on the target server! Please make sure yo
collections:
- devsec.hardening
roles:
- devsec.ssh_hardening
- devsec.hardening.ssh_hardening
```
## Configuring settings not listed in role-variables
@ -249,7 +249,7 @@ Example playbook:
collections:
- devsec.hardening
roles:
- devsec.ssh_hardening
- devsec.hardening.ssh_hardening
vars:
ssh_custom_options:
- "Include /etc/ssh/ssh_config.d/*"