Docker

This section covers configuration specific to the Dockerfile analyzer. Please make sure to read the general configuration guide first.

​

Configuration - .deepsource.toml

​

name

• Type: String
• Presence: mandatory
• Description: Shortcode of the analyzer.
• Example:

name = "docker"

​

enabled

• Type: Boolean
• Presence: optional
• Description: Toggle whether this analyzer should be run.
• Example:

enabled = true

​

meta

• Type: Table
• Presence: optional
• Description: Any supported metadata to pass to the analyzer.
• Example:

[analyzers.meta]
  dockerfile_paths = [
    "api/dockerfile_dev",
    "Dockerfile_local"
  ]

​

dockerfile_paths

• Type: Array
• Presence: optional
• Description: Specify the dockerfile(s) to run analysis on.
• Available Value: None. Expects path(s) of dockerfile(s)
• Default Value: File named Dockerfile in the repository root, if it exists.
• Example:

[analyzers.meta]
  dockerfile_paths = [
    "Dockerfile",
    "api/dockerfile_dev",
    "Dockerfile_local"
  ]

​

trusted_registries

• Type: String
• Presence: optional
• Description: Specify trusted registries from where images are to be pulled.
• Available Value: None. The user must provide the registries.
• Default Value: None
• Example:

[analyzers.meta]
  trusted_registries = [
    "my-registry.com",
    "company-registry.com"
  ]

​

Sample config

version = 1

[[analyzers]]
name = "docker"
enabled = true

  [analyzers.meta]
  dockerfile_paths = [
    "dockerfile_dev",
    "dockerfile_prod"
  ]

  trusted_registries = [
    "my-registry.com",
    "docker.io"
  ]