oss/syft
2
0
Fork 0
mirror of https://github.com/anchore/syft.git synced 2025-11-17 16:33:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

add documentation for the file contents cataloger config options

Browse Source 
Signed-off-by: Alex Goodman <alex.goodman@anchore.com>
This commit is contained in:
Alex Goodman 2021-04-07 16:28:45 -04:00
parent d451a5ad30
commit 44915b435f
No known key found for this signature in database
GPG Key ID: 5CB45AE22BAB7EA7
1 changed files with 21 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -119,6 +119,25 @@ file-classification:
# SYFT_FILE_CLASSIFICATION_CATALOGER_SCOPE env var # SYFT_FILE_CLASSIFICATION_CATALOGER_SCOPE env var
scope: "squashed" scope: "squashed"
# cataloging file contents is exposed through the power-user subcommand
contents:
cataloger:
# enable/disable cataloging of secrets
# SYFT_CONTENTS_CATALOGER_ENABLED env var
enabled: true
# the search space to look for secrets (options: all-layers, squashed)
# SYFT_CONTENTS_CATALOGER_SCOPE env var
scope: "squashed"
# skip searching a file entirely if it is above the given size (default = 1MB; unit = bytes)
# SYFT_CONTENTS_SKIP_FILES_ABOVE_SIZE env var
skip-files-above-size: 1048576
# file globs for the cataloger to match on
# SYFT_CONTENTS_GLOBS env var
globs: []
# cataloging file metadata is exposed through the power-user subcommand # cataloging file metadata is exposed through the power-user subcommand
file-metadata: file-metadata:
cataloger: cataloger:
@ -149,9 +168,9 @@ secrets:
# SYFT_SECRETS_REVEAL_VALUES env var # SYFT_SECRETS_REVEAL_VALUES env var
reveal-values: false reveal-values: false
# skip searching a file entirely if it is above the given size (default = 10MB; unit = bytes) # skip searching a file entirely if it is above the given size (default = 1MB; unit = bytes)
# SYFT_SECRETS_SKIP_FILES_ABOVE_SIZE env var # SYFT_SECRETS_SKIP_FILES_ABOVE_SIZE env var
skip-files-above-size: 10485760 skip-files-above-size: 1048576
# name-regex pairs to consider when searching files for secrets. Note: the regex must match single line patterns # name-regex pairs to consider when searching files for secrets. Note: the regex must match single line patterns
# but may also have OPTIONAL multiline capture groups. Regexes with a named capture group of "value" will # but may also have OPTIONAL multiline capture groups. Regexes with a named capture group of "value" will