From d92a8abe13adfdf206ce7cdf16eb824a6765ec07 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20Sj=C3=B6gren?= Date: Tue, 16 Jan 2018 13:45:06 +0100 Subject: [PATCH] update README with examples MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Thomas Sjögren --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c2ad3a8..a212808 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,24 @@ Distribution specific Dockerfiles that fixes this issue are available in the The [distribution specific Dockerfiles](https://github.com/docker/docker-bench-security/tree/master/distros) may also help if the distribution you're using haven't yet shipped Docker -version 1.10.0 or later. +version 1.13.0 or later. + +### Docker Bench for Security options + +```sh + -h optional Print this help message + -l FILE optional Log output in FILE + -c CHECK optional Run specific check +``` + +By default the Docker Bench for Security script will run all available tests and +produce logs in the current directory named `docker-bench-security.sh.log.json` +and `docker-bench-security.sh.log`. +The CIS based checks are named `check_
_`, e.g. `check_2_6` +and community contributed checks are named `check_c_`. +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` ## Building Docker Bench for Security