Properties

You can configure Docker Inspector by setting any of the following properties. Properties are typically set via the command line by adding a command line argument of the form:

--{property name}={property value}

See the Advanced for other ways to set properties.

Available properties:

Property name	Type	Description	Default value
blackduck.always.trust.cert	Boolean	Black Duck Always Trust Cert?	false
blackduck.api.token	String	Black Duck token
blackduck.codelocation.name	String	Black Duck CodeLocation name
blackduck.codelocation.prefix	String	Black Duck CodeLocation prefix
blackduck.password	String	Black Duck Password
blackduck.project.name	String	Black Duck Project Name
blackduck.project.version	String	Black Duck Project Version
blackduck.proxy.host	String	Black Duck Proxy Host
blackduck.proxy.password	String	Black Duck Proxy Password
blackduck.proxy.port	String	Black Duck Proxy Port
blackduck.proxy.username	String	Black Duck Proxy Username
blackduck.timeout	Integer	Black Duck Timeout in seconds	120
blackduck.url	String	Black Duck URL
blackduck.username	String	Black Duck Username
cleanup.inspector.container	Boolean	Stop inspector container after using it?	true
cleanup.inspector.image	Boolean	Remove inspector image after using it?	false
cleanup.target.image	Boolean	Remove target image after saving it?	false
cleanup.working.dir	Boolean	Cleanup Working Dir?	true
command.timeout	Long	Command Timeout (Milliseconds)	120000
docker.image	String	Docker Image name:tag
docker.image.id	String	The ID (shown in the 'IMAGE ID' column of 'docker images' output) of the target Docker image. The target image must already be local (must appear in the output of 'docker images').
docker.image.repo	String	Docker Image Repo; Use with docker.image.tag to select one image from a tarfile
docker.image.tag	String	Docker Image Tag; Use with docker.image.repo to select one image from a tarfile
docker.platform.top.layer.id	String	To ignore components from platform layers: specify the ID (from docker inspect : last of RootFS.Layers) of the top layer of the platform image
docker.tar	String	Docker tarfile path
help.output.path	String	The path to a file or directory to which help output will be written in markdown format. If not set, help will be written to stdout. If set, the directory must exist; the file will be created if it does not exist. If the path to a directory is provided, Docker Inspector will generate the filename automatically
imageinspector.service.distro.default	String	Default image inspector Linux distro (alpine, centos, or ubuntu)	ubuntu
imageinspector.service.port.alpine	String	alpine image inspector host port	9000
imageinspector.service.port.centos	String	centos image inspector host port	9001
imageinspector.service.port.ubuntu	String	ubuntu image inspector host port	9002
imageinspector.service.start	Boolean	Start ImageInspector services (containers) as needed?	true
imageinspector.service.url	String	The URL of the (already running) imageinspector service to use
jar.path	String	Black Duck Docker Inspector .jar file path
linux.distro	String	Target image Linux distribution name. Use this if you need to override the Linux distribution name discovered by Docker Inspector.
logging.level.com.synopsys	String	Logging Level (WARN, INFO, DEBUG, TRACE)	INFO
offline.mode	Boolean	Make no attempts to access network-based resources (the Black Duck server, docker repository)	false
output.containerfilesystem.excluded.paths	String	Comma-separated list of directories/files/links (specified as absolute paths) to exclude from the container filesystem
output.include.containerfilesystem	Boolean	Include container filesystem (a large file) in output?	false
output.include.squashedimage	Boolean	Include container filesystem (a large file) in output?	false
output.path	String	Path to directory for output files
service.timeout	Long	HTTP Service Request Timeout (Milliseconds)	600000
shared.dir.path.local	String	The host's path to the dir shared with the imageinspector containers. Only needed if using existing imageinspector containers	/tmp/blackduck-docker-inspector-files/shared
system.properties.path	String	Path to a properties file containing additional system properties (an alternative to java -D)
upload.bdio	Boolean	Upload BDIO?	true
working.dir.path	String	Working Directory Path	/tmp/blackduck-docker-inspector-files