From a9dc753c7fe438ecc55c151c725917d709b32fc5 Mon Sep 17 00:00:00 2001 From: Tony DevOps <868644+TonyLovesDevOps@users.noreply.github.com> Date: Mon, 22 Apr 2024 11:53:38 -0600 Subject: [PATCH] Add some more examples for the `config.yaml` file in the README. (#1811) --------- Signed-off-by: Tony DevOps <868644+TonyLovesDevOps@users.noreply.github.com> --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a527ab6a18f..4e91570ed03 100644 --- a/README.md +++ b/README.md @@ -688,10 +688,16 @@ name: "" # same as --fail-on ; GRYPE_FAIL_ON_SEVERITY env var fail-on-severity: "" -# the output format of the vulnerability report (options: table, json, cyclonedx) +# the output format of the vulnerability report (options: table, template, json, cyclonedx) +# when using template as the output type, you must also provide a value for 'output-template-file' # same as -o ; GRYPE_OUTPUT env var output: "table" +# if using template output, you must provide a path to a Go template file +# see https://github.com/anchore/grype#using-templates for more information on template output +# the default path to the template file is the current working directory +# output-template-file: .grype/html.tmpl + # write output report to a file (default is to write to stdout) # same as --file; GRYPE_FILE env var file: "" @@ -745,6 +751,14 @@ db: # Default max age is 120h (or five days) max-allowed-built-age: "120h" + # Timeout for downloading GRYPE_DB_UPDATE_URL to see if the database needs to be downloaded + # This file is ~156KiB as of 2024-04-17 so the download should be quick; adjust as needed + update-available-timeout: "30s" + + # Timeout for downloading actual vulnerability DB + # The DB is ~156MB as of 2024-04-17 so slower connections may exceed the default timeout; adjust as needed + update-download-timeout: "120s" + search: # the search space to look for packages (options: all-layers, squashed) # same as -s ; GRYPE_SEARCH_SCOPE env var