From fcea0aaaed3436c0f46385aac5fa70d4ff5de096 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Thu, 30 Nov 2023 09:34:41 +0100 Subject: [PATCH 1/2] scout: restructure toc Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- data/toc.yaml | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/data/toc.yaml b/data/toc.yaml index f4af59b420..86379b6061 100644 --- a/data/toc.yaml +++ b/data/toc.yaml @@ -1350,16 +1350,18 @@ Manuals: title: Dashboard - path: /scout/image-details-view/ title: Image details view + - path: /scout/advisory-db-sources/ + title: Advisory database + - path: /scout/data-handling/ + title: Data handling + - sectiontitle: Use Docker Scout + section: - path: /scout/image-analysis/ title: Image analysis - path: /scout/local-fs/ title: Analyze local files - path: /scout/sbom/ title: SBOM - - path: /scout/advisory-db-sources/ - title: Advisory database - - path: /scout/data-handling/ - title: Data handling - sectiontitle: Policy Evaluation section: - path: /scout/policy/ From cb9986420e3c7fc0d7472dabab22bd4e08f86816 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Thu, 30 Nov 2023 12:13:47 +0100 Subject: [PATCH 2/2] scout: add information about cli env vars Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- content/scout/env-vars.md | 40 +++++++++++++++++++++++++++++++++++++++ data/toc.yaml | 2 ++ 2 files changed, 42 insertions(+) create mode 100644 content/scout/env-vars.md diff --git a/content/scout/env-vars.md b/content/scout/env-vars.md new file mode 100644 index 0000000000..9d1ea98de4 --- /dev/null +++ b/content/scout/env-vars.md @@ -0,0 +1,40 @@ +--- +title: Environment variables used by Docker Scout +linkTitle: Docker Scout environment variables +description: Configure how the behavior of Docker Scout CLI commands using these environment variables +keywords: scout, supply chain, cli, env, variables, configure +--- + +The following environment variables are available to configure the Docker Scout +CLI commands, and the corresponding `docker/scout-cli` container image: + +| Name | Format | Description | +| :-------------------------------------- | ------- | :------------------------------------------------------------------------------------------ | +| DOCKER_SCOUT_CACHE_FORMAT | String | Format of the local image cache; can be `oci` or `tar` (default: `oci`) | +| DOCKER_SCOUT_CACHE_DIR | String | Directory where the local SBOM cache is stored (default: `$HOME/.docker/scout`) | +| DOCKER_SCOUT_NO_CACHE | Boolean | When set to `true`, disables the use of local SBOM cache | +| DOCKER_SCOUT_OFFLINE | Boolean | Use [offline mode](#offline-mode) when indexing SBOM | +| DOCKER_SCOUT_REGISTRY_TOKEN | String | Token for authenticating to a registry when pulling images | +| DOCKER_SCOUT_REGISTRY_USER | String | Username for authenticating to a registry when pulling images | +| DOCKER_SCOUT_REGISTRY_PASSWORD | String | Password or personal access token for authenticating to a registry when pulling images | +| DOCKER_SCOUT_HUB_USER | String | Docker Hub username for authenticating to the Docker Scout backend | +| DOCKER_SCOUT_HUB_PASSWORD | String | Docker Hub password or personal access token for authenticating to the Docker Scout backend | +| DOCKER_SCOUT_NEW_VERSION_WARN | Boolean | Warn about new versions of the Docker Scout CLI | +| DOCKER_SCOUT_EXPERIMENTAL_WARN | Boolean | Warn about experimental features | +| DOCKER_SCOUT_EXPERIMENTAL_POLICY_OUTPUT | Boolean | Disable experimental output for policy evaluation | + +## Offline mode + +Under normal operation, Docker Scout cross-references external systems, such as +npm, NuGet, or proxy.golang.org, to retrieve additional information about +packages found in your image. + +When `DOCKER_SCOUT_OFFLINE` is set to `true`, Docker Scout image analysis runs +in offline mode. Offline mode means Docker Scout doesn't make outbound requests +to external systems. + +To use offline mode: + +```console +$ export DOCKER_SCOUT_OFFLINE=true +``` diff --git a/data/toc.yaml b/data/toc.yaml index 86379b6061..e492497046 100644 --- a/data/toc.yaml +++ b/data/toc.yaml @@ -1362,6 +1362,8 @@ Manuals: title: Analyze local files - path: /scout/sbom/ title: SBOM + - path: /scout/env-vars/ + title: Environment variables - sectiontitle: Policy Evaluation section: - path: /scout/policy/