GuillaumeHemmen/docker-bench-security
1
0
Fork 0
mirror of https://github.com/docker/docker-bench-security.git synced 2025-01-19 00:32:34 +01:00
Code Issues Projects Releases Packages Wiki Activity

update the README about community checks

Browse source 
Signed-off-by: Thomas Sjögren <konstruktoid@users.noreply.github.com>
This commit is contained in:
Thomas Sjögren 2018-01-18 11:28:36 +01:00
parent 2958a8b806
commit 83ed8122ef
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -50,11 +50,11 @@ version 1.13.0 or later.
```sh ```sh
-h optional Print this help message -h optional Print this help message
-l FILE optional Log output in FILE -l FILE optional Log output in FILE
-c CHECK optional Run specific check -c CHECK optional Run specific check or group of checks
``` ```
By default the Docker Bench for Security script will run all available tests and By default the Docker Bench for Security script will run all available CIS tests
produce logs in the current directory named `docker-bench-security.sh.log.json` and produce logs in the current directory named `docker-bench-security.sh.log.json`
and `docker-bench-security.sh.log`. and `docker-bench-security.sh.log`.
The CIS based checks are named `check_<section>_<number>`, e.g. `check_2_6` The CIS based checks are named `check_<section>_<number>`, e.g. `check_2_6`
and community contributed checks are named `check_c_<number>`. and community contributed checks are named `check_c_<number>`.
@ -62,6 +62,10 @@ A complete list of checks are present in [functions_lib.sh](functions_lib.sh).
`sh docker-bench-security.sh -l /tmp/docker-bench-security.sh.log -c check_2_2` `sh docker-bench-security.sh -l /tmp/docker-bench-security.sh.log -c check_2_2`
Note that when submitting checks, provide information why it is a
reasonable test to add and please include some kind of official documentation
verifying that information.
## Building Docker Bench for Security ## Building Docker Bench for Security
If you wish to build and run this container yourself, you can follow the If you wish to build and run this container yourself, you can follow the